com.sap.tc.webdynpro.services.sal.sl.api
Interface IWDJCOClientConnection

All Superinterfaces:

IWDService

public interface IWDJCOClientConnection

extends IWDService

This interface describes a JCO connection used by a Web Dynpro application. It depends of the impementation if the used JCO connection is get from a JCO.Pool or if it is realized by using one single JCO.Client instance.

Method Summary

java.lang.String	getApplicationServer() Return the name of the used application server instance.
com.sap.mw.jco.JCO.Client	getClient() Return a JCO.Client instance.
java.lang.String	getClientName() Return the name of the used client.
int	getConnectionTimeOut() Return the maximal connection time out.
java.lang.String	getJ2EEClusterName() Return the name of the J2EE cluster, to which the JCO connection is assigned
java.lang.String	getLanguage() Return the used language.
java.lang.String	getLogonGroup() Return the name of the used logon group.
int	getMaxNumberOfConnections() Return the maximal number of connections.
int	getMaxPoolSize() Return the maximal pool size.
int	getMaxWaitTime() Return the maximal wait time.
java.lang.String	getMessageServer() Return the name of the used message server instance.
java.lang.String	getPassword() Return the used password.
java.lang.String	getSNCLibraryPath() Return the path to the library which provides SNC service
java.lang.String	getSNCMode() Return the used Secure network connection (SNC) mode, 0 (off) or 1 (on)
java.lang.String	getSNCName() Return the used SNC name.
java.lang.String	getSNCPartnerName() Return the SNC partner, e.g.
java.lang.String	getSNCSecurityLevel() Return the used SNC level of security, 1 to 9
java.lang.String	getSystemIdentifier() Return an unique key identifiying the used technical system.
java.lang.String	getSystemName() Return the name of the used system.
java.lang.String	getSystemNumber() Return the used system number.
java.lang.String	getUser() Return the name of the used user.
java.lang.String	getUserDefinition() Return the used user definition.
boolean	ping() Pings the IWDJCOClientConnection.
void	release() Release the actual JCOClientConnection instance.
void	setLanguage(java.util.Locale languageLocale) Defines the used language.
void	update(int maxPoolSize, int maxNumberOfConnections, int maxWaitTime, int connectionTimeOut, java.lang.String msgServerName, java.lang.String systemName, java.lang.String logonGroup, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String sncMode, java.lang.String sncSecurityLevel, java.lang.String sncPartnerName, java.lang.String sncName, java.lang.String sncLibraryPath, java.lang.String language) Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group.
void	update(int maxPoolSize, int maxNumberOfConnections, int maxWaitTime, int connectionTimeOut, java.lang.String appServerName, java.lang.String systemNumber, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String sncMode, java.lang.String sncSecurityLevel, java.lang.String sncPartnerName, java.lang.String sncName, java.lang.String sncLibraryPath, java.lang.String language) Updates a instance of IJCOClientConnection defined by application server name and system number.
void	update(int maxPoolSize, java.lang.String msgServerName, java.lang.String systemName, java.lang.String logonGroup, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String language) Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group.
void	update(int maxPoolSize, java.lang.String msgServerName, java.lang.String systemName, java.lang.String logonGroup, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String sncMode, java.lang.String sncSecurityLevel, java.lang.String sncPartnerName, java.lang.String sncName, java.lang.String sncLibraryPath, java.lang.String language) Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group.
void	update(int maxPoolSize, java.lang.String appServerName, java.lang.String systemNumber, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String language) Updates a instance of IJCOClientConnection defined by application server name and system number.
void	update(int maxPoolSize, java.lang.String appServerName, java.lang.String systemNumber, java.lang.String client, WDUserDefinitionType userDefinition, java.lang.String user, java.lang.String password, java.lang.String sncMode, java.lang.String sncSecurityLevel, java.lang.String sncPartnerName, java.lang.String sncName, java.lang.String sncLibraryPath, java.lang.String language) Updates a instance of IJCOClientConnection defined by application server name and system number.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getClient

public com.sap.mw.jco.JCO.Client getClient()

Return a JCO.Client instance.

release

public void release()

Release the actual JCOClientConnection instance.

getMaxPoolSize

public int getMaxPoolSize()

Return the maximal pool size.

Returns:

the maximal pool size

getMaxNumberOfConnections

public int getMaxNumberOfConnections()

Return the maximal number of connections.

Returns:

the maximal number of connections.

getMaxWaitTime

public int getMaxWaitTime()

Return the maximal wait time.

Returns:

the maximal wait time.

getConnectionTimeOut

public int getConnectionTimeOut()

Return the maximal connection time out.

Returns:

the maximal connection time out.

getMessageServer

public java.lang.String getMessageServer()

Return the name of the used message server instance. This value could be NULL if the connection is defined by application server and system id.

Returns:

the name of the used message server instance.

getSystemName

public java.lang.String getSystemName()

Return the name of the used system. This value could be NULL if the connection is defined by application server and system id.

Returns:

the the name of the used system.

getLogonGroup

public java.lang.String getLogonGroup()

Return the name of the used logon group. This value could be NULL if the connection is defined by application server and system id.

Returns:

the the name of the used logon group.

getApplicationServer

public java.lang.String getApplicationServer()

Return the name of the used application server instance. The value could be NULL if the connection is defined by message server, system name and logon group.

Returns:

the name of the used application server instance

getSystemNumber

public java.lang.String getSystemNumber()

Return the used system number. The value could be NULL if the connection is defined by message server, system name and logon group.

Returns:

the used system number

getClientName

public java.lang.String getClientName()

Return the name of the used client.

Returns:

the the name of the used client.

getUser

public java.lang.String getUser()

Return the name of the used user.

Returns:

ther name of the used user.

getPassword

public java.lang.String getPassword()

Return the used password. This value could be NULL depending on the defined user defintion.

Returns:

the used password

getUserDefinition

public java.lang.String getUserDefinition()

Return the used user definition.

Returns:

the used user definition.

getLanguage

public java.lang.String getLanguage()

Return the used language.

Returns:

the used language.

setLanguage

public void setLanguage(java.util.Locale languageLocale)

Defines the used language. Should not be used (only for xApps workaround)

Parameters:

language - the needed language in a locale string

getSNCMode

public java.lang.String getSNCMode()

Return the used Secure network connection (SNC) mode, 0 (off) or 1 (on)

Returns:

the used Secure network connection (SNC) mode, 0 (off) or 1 (on)

getSNCSecurityLevel

public java.lang.String getSNCSecurityLevel()

Return the used SNC level of security, 1 to 9

Returns:

the used SNC level of security, 1 to 9

getSNCPartnerName

public java.lang.String getSNCPartnerName()

Return the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN"

Returns:

the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN"

getSNCName

public java.lang.String getSNCName()

Return the used SNC name. Overrides default SNC partner

Returns:

the used SNC name. Overrides default SNC partner

getSNCLibraryPath

public java.lang.String getSNCLibraryPath()

Return the path to the library which provides SNC service

Returns:

the path to the library which provides SNC service

getJ2EEClusterName

public java.lang.String getJ2EEClusterName()

Return the name of the J2EE cluster, to which the JCO connection is assigned

Returns:

the name of the J2EE cluster, to which the JCO connection is assigned

getSystemIdentifier

public java.lang.String getSystemIdentifier()

Return an unique key identifiying the used technical system. If two IWDJCOClientConnection instances have the same key they would use the same technical connection (i.e. the same technical JCO.Pool)

Returns:

ping

public boolean ping()

Pings the IWDJCOClientConnection. The ping does not authenticate the user. Only the connection properties defining the technical system are used for the ping.

Returns:

TRUE if the ping works, FALSE otherwise.

update

public void update(int maxPoolSize,
                   int maxNumberOfConnections,
                   int maxWaitTime,
                   int connectionTimeOut,
                   java.lang.String msgServerName,
                   java.lang.String systemName,
                   java.lang.String logonGroup,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String sncMode,
                   java.lang.String sncSecurityLevel,
                   java.lang.String sncPartnerName,
                   java.lang.String sncName,
                   java.lang.String sncLibraryPath,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

maxNumberOfConnections - the maximal number of connections provided by the pool.

maxWaitTime - the maximal wait time (i.e. the maximal time, waiting for a new JCO.Client)

connectionTimeOut - defines the time after that a open and unused connection managed by the pool is closed.

msgServerName - the name of the message server

systemName - the name of the R/3 system

logonGroup - the used logon group

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to WDUserDefinition.DEFINED_USER)

sncMode - the used Secure network connection (SNC) mode, 0 (off) or 1 (on) (is needed when is set to WDUserDefinition.SNC_USER)

sncSecurityLevel - the used SNC level of security, 1 to 9 (is needed when is set to WDUserDefinition.SNC_USER)

sncPartnerName - the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN" (is needed when is set to WDUserDefinition.SNC_USER)

sncName - the used SNC name. Overrides default SNC partner (is needed when is set to WDUserDefinition.SNC_USER)

sncLibraryPath - the path to the library which provides SNC service (is needed when is set to WDUserDefinition.SNC_USER)

language - the language of the user

Throws:

JCOClientException - if the update of the new JCO client connection failed.

update

public void update(int maxPoolSize,
                   java.lang.String msgServerName,
                   java.lang.String systemName,
                   java.lang.String logonGroup,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String sncMode,
                   java.lang.String sncSecurityLevel,
                   java.lang.String sncPartnerName,
                   java.lang.String sncName,
                   java.lang.String sncLibraryPath,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

msgServerName - the name of the message server

systemName - the name of the R/3 system

logonGroup - the used logon group

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to WDUserDefinition.DEFINED_USER)

sncMode - the used Secure network connection (SNC) mode, 0 (off) or 1 (on) (is needed when is set to WDUserDefinition.SNC_USER)

sncSecurityLevel - the used SNC level of security, 1 to 9 (is needed when is set to WDUserDefinition.SNC_USER)

sncPartnerName - the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN" (is needed when is set to WDUserDefinition.SNC_USER)

sncName - the used SNC name. Overrides default SNC partner (is needed when is set to WDUserDefinition.SNC_USER)

sncLibraryPath - the path to the library which provides SNC service (is needed when is set to WDUserDefinition.SNC_USER)

language - the language of the user

Throws:

JCOClientException - if the update of the new JCO client connection failed.

update

public void update(int maxPoolSize,
                   java.lang.String msgServerName,
                   java.lang.String systemName,
                   java.lang.String logonGroup,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by the message server name, the system name and the logon group. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

msgServerName - the name of the message server

systemName - the name of the R/3 system

logonGroup - the used logon group

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to WDUserDefinition.DEFINED_USER)

language - the language of the user

Throws:

JCOClientException - if the update of the new JCO client connection failed.

update

public void update(int maxPoolSize,
                   int maxNumberOfConnections,
                   int maxWaitTime,
                   int connectionTimeOut,
                   java.lang.String appServerName,
                   java.lang.String systemNumber,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String sncMode,
                   java.lang.String sncSecurityLevel,
                   java.lang.String sncPartnerName,
                   java.lang.String sncName,
                   java.lang.String sncLibraryPath,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by application server name and system number. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

maxNumberOfConnections - the maximal number of connections provided by the pool.

maxWaitTime - the maximal wait time (i.e. the maximal time, waiting for a new JCO.Client)

connectionTimeOut - defines the time after that a open and unused connection managed by the pool is closed.

appServerName - the name of the application server

systemNumber - the system number name of the R/3 system

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to 'WDUserDefinition.DEFINED_USER)

sncMode - the used Secure network connection (SNC) mode, 0 (off) or 1 (on) (is needed when is set to WDUserDefinition.SNC_USER)

sncSecurityLevel - the used SNC level of security, 1 to 9 (is needed when is set to WDUserDefinition.SNC_USER)

sncPartnerName - the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN" (is needed when is set to WDUserDefinition.SNC_USER)

sncName - the used SNC name. Overrides default SNC partner (is needed when is set to WDUserDefinition.SNC_USER)

sncLibraryPath - the path to the library which provides SNC service (is needed when is set to WDUserDefinition.SNC_USER)

language - the language of the user

j2eeClusterName - the name of the J2EE cluster, to which the JCO connection is assigned

Throws:

JCOClientException - if the creation of the new JCO client connection failed.

update

public void update(int maxPoolSize,
                   java.lang.String appServerName,
                   java.lang.String systemNumber,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String sncMode,
                   java.lang.String sncSecurityLevel,
                   java.lang.String sncPartnerName,
                   java.lang.String sncName,
                   java.lang.String sncLibraryPath,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by application server name and system number. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

appServerName - the name of the application server

systemNumber - the system number name of the R/3 system

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to 'WDUserDefinition.DEFINED_USER)

sncMode - the used Secure network connection (SNC) mode, 0 (off) or 1 (on) (is needed when is set to WDUserDefinition.SNC_USER)

sncSecurityLevel - the used SNC level of security, 1 to 9 (is needed when is set to WDUserDefinition.SNC_USER)

sncPartnerName - the SNC partner, e.g. "p:CN=R3, O=XYZ-INC, C=EN" (is needed when is set to WDUserDefinition.SNC_USER)

sncName - the used SNC name. Overrides default SNC partner (is needed when is set to WDUserDefinition.SNC_USER)

sncLibraryPath - the path to the library which provides SNC service (is needed when is set to WDUserDefinition.SNC_USER)

language - the language of the user

j2eeClusterName - the name of the J2EE cluster, to which the JCO connection is assigned

Throws:

JCOClientException - if the creation of the new JCO client connection failed.

update

public void update(int maxPoolSize,
                   java.lang.String appServerName,
                   java.lang.String systemNumber,
                   java.lang.String client,
                   WDUserDefinitionType userDefinition,
                   java.lang.String user,
                   java.lang.String password,
                   java.lang.String language)
            throws WDSystemLandscapeException

Updates a instance of IJCOClientConnection defined by application server name and system number. The used repository depends on the implementation.

Parameters:

maxPoolSize - the maximal pool size (i.e. the maximal open connections managed by the pool)

appServerName - the name of the application server

systemNumber - the system number name of the R/3 system

client - the used client

userDefinition - defines which kind of user definition is used. Possible values are: 'useSSO': the user is defined using SSO 'useX509': the user is defined using X509 client certificate 'useDefinedUser': the defined user is used

user - the name of the user

password - the password of the user (is needed when is set to 'WDUserDefinition.DEFINED_USER)

language - the language of the user

j2eeClusterName - the name of the J2EE cluster, to which the JCO connection is assigned

Throws:

JCOClientException - if the creation of the new JCO client connection failed.