Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Web Dynpro API Documentation
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sap.tc.webdynpro.services.sal.sl.api
Class WDSystemLandscape

java.lang.Object
  |
  +--com.sap.tc.webdynpro.services.sal.sl.api.WDSystemLandscape
public abstract class WDSystemLandscape
extends java.lang.Object

This class provides static access to IJCOClientConnection instances, and to get information about the SLD.

Constructor Summary
WDSystemLandscape()
           
 
Method Summary
static WDJCOClientConnectionStatus checkStatus(java.lang.String name)
          Returns the status of requested JCO client connection.
static WDJCOClientConnectionStatus checkStatus(java.lang.String name, boolean resetCache)
          Returns the status of requested JCO client connection.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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, java.lang.String j2eeClusterName)
          Creates a new instance of IWDJCOClientConnection defined by the message server name, the system name and the logon group.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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, java.lang.String j2eeClusterName)
          Creates a new instance of IWDJCOClientConnection defined by application server name and system number.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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)
          Creates a new instance of IJCOClientConnection defined by the message server name, the system name and the logon group assigned to the local J2EE engine.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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, java.lang.String j2eeClusterName)
          Creates a new instance of IJCOClientConnection defined by the message server name, the system name and the logon group.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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)
          Creates a new instance of IWDJCOClientConnection defined by application server name and system number assigned to the local J2EE cluster.
static IWDJCOClientConnection createJCOClientConnection(java.lang.String name, 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, java.lang.String j2eeClusterName)
          Creates a new instance of IJCOClientConnection defined by application server name and system number.
 IWDJCOClientConnection createJCOClientConnection(java.lang.String name, IWDJCOClientConnection source)
          Creates a new instance of IWDJCOClientConnection as a copy of the specified IWDJCOOClientConnection> instance.
static com.sap.lcr.api.sapmodel.SAP_J2EEEngineCluster getCurrentJ2EECluster()
          Deprecated. To keep the Web Dynpro Services API independant from the SLD API, support for this method has been discarded. When running in the SAP J2EE Engine, you can use the API of the engine's SLD service to retrieve the SAP_J2EEEngineCluster. This method may be withdrawn with the first new NetWeaver release in 2006.
static java.lang.String getCurrentJ2EEClusterName()
          Return the name of the current J2EE cluster instance.
static java.lang.String getJ2EEVersionInfo()
          Returns the version of the current J2EE Engine cluster.
static IWDJCOClientConnection getJCOClientConnection(java.lang.String name)
          Returns an instance of IJCOClientConnection which is assigned to the local J2EE cluster.
static IWDJCOClientConnection getJCOClientConnection(java.lang.String name, java.lang.String j2eeClusterName)
          Returns an istance of IJCOClientConnection.
static java.lang.String[] getJCOClientConnectionNames(java.lang.String clusterName)
          Returns the list of the defined JCO client connections associated to the specified J2EE engine cluster.
static java.lang.String getSLDHost()
          Return the host name of the used system landscape directory (SLD).
static int getSLDPort()
          Return the port name of the used system landscape directory (SLD).
static java.lang.String getSLDStartURL()
          Return the URL to start the assigned SLD.
static java.lang.String getSLDUser()
          Return the user name of the used system landscape directory (SLD).
static void invalidateCache()
          Invaldiate the internal cache.
static boolean pingSLDConnection()
          Return FALSE if the configured SLD connection could not be pinged.
static void removeJCOClientConnection(java.lang.String name, java.lang.String j2eeClusterName)
          Removes the specified JCOClientConnection.
static void setSLDConnection(java.lang.String host, java.lang.String port, java.lang.String user, java.lang.String password)
          Deprecated. Beginning with NetWeaver 04, connection information for the System Landscape Directory (SLD) is maintained by the J2EE service sld. Support for setting this information from within Web Dynpro therefore has been discarded, use the Visual Admin tool instead. This method may be withdrawn with the first new NetWeaver release in 2006.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WDSystemLandscape

public WDSystemLandscape()
Method Detail

getJCOClientConnection

public static IWDJCOClientConnection getJCOClientConnection(java.lang.String name,
                                                            java.lang.String j2eeClusterName)
                                                     throws WDSystemLandscapeException
Returns an istance of IJCOClientConnection.
Parameters:
name - the name of the JCO client connection.
j2eeClusterName - the name of the J2EE cluster, to which the JCO connection is assigend
Returns:
an instance of IJCOClientConnection
Throws:
JCOClientException - if there is no such JCO client connection defined.

getJCOClientConnection

public static IWDJCOClientConnection getJCOClientConnection(java.lang.String name)
                                                     throws WDSystemLandscapeException
Returns an instance of IJCOClientConnection which is assigned to the local J2EE cluster.
Parameters:
name - the name of the JCO client connection.
Returns:
an instance of IJCOClientConnection
Throws:
JCOClientException - if there is no such JCO client connection defined.

removeJCOClientConnection

public static void removeJCOClientConnection(java.lang.String name,
                                             java.lang.String j2eeClusterName)
                                      throws WDSystemLandscapeException
Removes the specified JCOClientConnection.
Parameters:
name - the name of the JCO client connection.
j2eeClusterName - the name of the J2EE cluster, to which the JCO connection is assigend
Throws:
WDSystemLandscapeException - if the specified JCO client connection could not be removed

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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,
                                                               java.lang.String j2eeClusterName)
                                                        throws WDSystemLandscapeException
Creates a new instance of IWDJCOClientConnection defined by the message server name, the system name and the logon group. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
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 use
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 assigend
Returns:
the new JCOClient connection
Throws:
WDSystemLandscapeException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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,
                                                               java.lang.String j2eeClusterName)
                                                        throws WDSystemLandscapeException
Creates a new instance of IJCOClientConnection defined by the message server name, the system name and the logon group. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
maxPoolSize - the maximal pool size
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 'useSNC': the user is defined using SNC
user - the name of the user (is needed when is set to WDUserDefinition.DEFINED_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 assigend
Returns:
the new JCOClient connection
Throws:
JCOClientException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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
Creates a new instance of IJCOClientConnection defined by the message server name, the system name and the logon group assigned to the local J2EE engine. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
maxPoolSize - the maximal pool size
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 use
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
Returns:
the new JCOClient connection
Throws:
JCOClientException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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,
                                                               java.lang.String j2eeClusterName)
                                                        throws WDSystemLandscapeException
Creates a new instance of IWDJCOClientConnection defined by application server name and system number. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
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 assigend
Returns:
the new JCOClient connection
Throws:
WDSystemLandscapeException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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,
                                                               java.lang.String j2eeClusterName)
                                                        throws WDSystemLandscapeException
Creates a new instance of IJCOClientConnection defined by application server name and system number. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
maxPoolSize - the maximal pool size
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 'useSNC': the user is defined using SNC
user - the name of the user (is needed when is set to WDUserDefinition.DEFINED_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 assigend
Returns:
the new JCOClient connection
Throws:
JCOClientException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public static IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                               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
Creates a new instance of IWDJCOClientConnection defined by application server name and system number assigned to the local J2EE cluster. The used repository depends on the implementation.
Parameters:
name - the name of the JCO client connection
maxPoolSize - the maximal pool size
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
Returns:
the new JCOClient connection
Throws:
JCOClientException - if the creation of the new JCO client connection failed.

createJCOClientConnection

public IWDJCOClientConnection createJCOClientConnection(java.lang.String name,
                                                        IWDJCOClientConnection source)
                                                 throws WDSystemLandscapeException
Creates a new instance of IWDJCOClientConnection as a copy of the specified IWDJCOOClientConnection> instance.
Parameters:
name - the name of the new JCO client connection
source - the IWDJCOClientConnection which should be copied
Returns:
the new (copied) JCOClient connection
Throws:
WDSystemLandscapeException - if the creation of the new JCO client connection failed.

getJCOClientConnectionNames

public static java.lang.String[] getJCOClientConnectionNames(java.lang.String clusterName)
                                                      throws WDSystemLandscapeException
Returns the list of the defined JCO client connections associated to the specified J2EE engine cluster.
Parameters:
clusterName - the name of the J2EE engine cluster to which the JCO client connections should be associated.
Returns:
an array containing all defined JCO client connections or NULL if there are no.
Throws:
WDSystemLandscapeException - if the creation of the new JCO client connection failed.

checkStatus

public static WDJCOClientConnectionStatus checkStatus(java.lang.String name)
Returns the status of requested JCO client connection.
Parameters:
name - the name of the JCO client connection
Returns:
the status of the requested JCO client connection Possible values are: STATUS_OK : Everything is fine STATUS_NOT_DEFINED: The JCO client connection is not defined. STATUS_INVALID_DEFINITION: The JCO client connection is defined but there are some parameters missed. STATUS_UNKNOWN: THe status of the JCO client connection could not be checked.

checkStatus

public static WDJCOClientConnectionStatus checkStatus(java.lang.String name,
                                                      boolean resetCache)
Returns the status of requested JCO client connection.
Parameters:
name - the name of the JCO client connection
resetCache - TRUE if the check should reset the cached connection information. FALSE otherwise.
Returns:
the status of the requested JCO client connection Possible values are: STATUS_OK : Everything is fine STATUS_NOT_DEFINED: The JCO client connection is not defined. STATUS_INVALID_DEFINITION: The JCO client connection is defined but there are some parameters missed. STATUS_UNKNOWN: The status of the JCO client connection could not be checked.

getCurrentJ2EECluster

public static com.sap.lcr.api.sapmodel.SAP_J2EEEngineCluster getCurrentJ2EECluster()
Deprecated. To keep the Web Dynpro Services API independant from the SLD API, support for this method has been discarded. When running in the SAP J2EE Engine, you can use the API of the engine's SLD service to retrieve the SAP_J2EEEngineCluster. This method may be withdrawn with the first new NetWeaver release in 2006.

Return the instance of SAP_J2EEEngineCluster, which represents the current J2EE cluster.
Returns:
the SLD node for the current SAP J2EE cluster

getCurrentJ2EEClusterName

public static java.lang.String getCurrentJ2EEClusterName()
Return the name of the current J2EE cluster instance.
Returns:
the name of the current J2EE cluster.

setSLDConnection

public static void setSLDConnection(java.lang.String host,
                                    java.lang.String port,
                                    java.lang.String user,
                                    java.lang.String password)
Deprecated. Beginning with NetWeaver 04, connection information for the System Landscape Directory (SLD) is maintained by the J2EE service sld. Support for setting this information from within Web Dynpro therefore has been discarded, use the Visual Admin tool instead. This method may be withdrawn with the first new NetWeaver release in 2006.

Sets the SLD conncetion information.

getSLDHost

public static java.lang.String getSLDHost()
Return the host name of the used system landscape directory (SLD).
Returns:
the host name of the used system landscape directory (SLD).

getSLDPort

public static int getSLDPort()
Return the port name of the used system landscape directory (SLD).
Returns:
the port name of the used system landscape directory (SLD).

getSLDUser

public static java.lang.String getSLDUser()
Return the user name of the used system landscape directory (SLD).
Returns:
the user name of the used system landscape directory (SLD).

getSLDStartURL

public static java.lang.String getSLDStartURL()
Return the URL to start the assigned SLD.
Returns:
the URL to start the assigned SLD.

pingSLDConnection

public static boolean pingSLDConnection()
Return FALSE if the configured SLD connection could not be pinged. TRUE otherwise.
Returns:
FALSE if the configured SLD connection could not be pinged. TRUE otherwise.

invalidateCache

public static void invalidateCache()
Invaldiate the internal cache.

getJ2EEVersionInfo

public static java.lang.String getJ2EEVersionInfo()
Returns the version of the current J2EE Engine cluster.
Returns:
version of the current J2EE Engine cluster
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Web Dynpro API Documentation
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15