com.sap.tc.webdynpro.services.sal.admin.api
Class WDServerState

java.lang.Object
  |
  +--com.sap.tc.webdynpro.services.sal.admin.api.WDServerState

public abstract class WDServerState

extends java.lang.Object

WDServerState provides static methods to access a snapshot of the server state.

Constructor Summary

WDServerState()

Method Summary

static java.lang.String[]	getActualApplications() Return is the array of actually running applications.
static java.lang.String[]	getActualApplications(java.lang.String clientUserId) Return is the array of actually running application names and id's for the specified client user.
static java.lang.String[]	getActualClientSessions() Return is the array of actually registered client sessions.
static java.lang.String[]	getActualClientSessions(java.lang.String serverSessionID) Return is the array of actually registered client sessions for the specified server sessions.
static java.lang.String[]	getActualClientUsers() Return is the array of client user identifiers actually registered client users.
static java.lang.String[]	getActualClientWindows() Return is the array of all actually registered client windows.
static java.lang.String[]	getActualClientWindows(java.lang.String clientSessionID) Return is the array of all actually registered client windows for the specified client session.
static java.lang.String	getActualServerSession(java.lang.String clientUserId) Return is the server session associated to the specified client user.
static java.lang.String[]	getActualServerSessions() Return is the array of actual server sessions.
static java.lang.String[]	getApplicationParts(java.lang.String deployableObjectName) Return is the array of names of application deployable object parts contained in the deployable object specified as input parameter.
static java.lang.String[]	getComponentParts(java.lang.String deployableObjectName) Return is the array of names of component deployable object parts contained in the deployable object specified as input parameter.
static java.lang.String[]	getConfigurationParts(java.lang.String deployableObjectName) Return is the array of names of configuration deployable object parts contained in the deployable object specified as input parameter.
static java.lang.String[]	getDeployableObjectParts(java.lang.String deployableObject) Return is the array of names of deployable object parts belonging to the specified deployable object.
static java.lang.String[]	getDeployableObjects() Return is the array of deployable object names of currently deployed Web Dynpro applications.
java.lang.String[]	getInterfaceParts(java.lang.String deployableObjectName) Return is the array of names of interface deployable object parts contained in the deployable object specified as input parameter.
static com.sap.tc.webdynpro.services.sal.admin.api.ServerStateMBean	getMBean() Return is the associated MBean.
static int	getNumberOfActualApplications() Return is the number of actually running applications.
static int	getNumberOfActualApplications(java.lang.String clientUserId) Return is the number of actually running applications for the specified client user.
static int	getNumberOfActualClientSessions() Return is the number of all actually registered client sessions.
static int	getNumberOfActualClientSessions(java.lang.String serverSessionID) Return is the number of actually registered client sessions for the specified server sessions.
static int	getNumberOfActualClientWindows() Return is the number of all actually registered client windows.
static int	getNumberOfActualClientWindows(java.lang.String clientSessionID) Return is the number of all actually registered client windows for the specified client session.
static int	getNumberOfActualServerSessions() Return is the number of actual server sessions.
static int	getNumberOfClientUsers() Return is the number of actually registered client users.
static int	getNumberOfDeployableObjectParts(java.lang.String deployableObject) Return is the number of deployable object parts belonging to the specified deployable object.
static java.lang.String[]	getStateAsStringArray() Return is the string representation of the actual server state, organized in an array of strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WDServerState

public WDServerState()

Method Detail

getActualClientUsers

public static java.lang.String[] getActualClientUsers()

Return is the array of client user identifiers actually registered client users.

Returns:

the array of actually registered client users

getNumberOfClientUsers

public static int getNumberOfClientUsers()

Return is the number of actually registered client users.

Returns:

the number of actually registered client users

getActualApplications

public static java.lang.String[] getActualApplications()

Return is the array of actually running applications. An entry of the array is /.

Returns:

the array of actually running applications

getNumberOfActualApplications

public static int getNumberOfActualApplications()

Return is the number of actually running applications.

Returns:

the number of actually running applications

getActualApplications

public static java.lang.String[] getActualApplications(java.lang.String clientUserId)

Return is the array of actually running application names and id's for the specified client user. An entry of the array is /.

Parameters:

clientUserId - a client user identifier

Returns:

the array of actually running applications for the specified client user

getNumberOfActualApplications

public static int getNumberOfActualApplications(java.lang.String clientUserId)

Return is the number of actually running applications for the specified client user.

Parameters:

clientUserId - a client user

Returns:

the number of actually running applications for the specified client user

getApplicationParts

public static java.lang.String[] getApplicationParts(java.lang.String deployableObjectName)

Return is the array of names of application deployable object parts contained in the deployable object specified as input parameter.

Returns:

the array of names of application deployable object parts contained in the deployable object specified as input parameter

getComponentParts

public static java.lang.String[] getComponentParts(java.lang.String deployableObjectName)

Return is the array of names of component deployable object parts contained in the deployable object specified as input parameter.

Returns:

the array of names of component deployable object parts contained in the deployable object specified as input parameter

getConfigurationParts

public static java.lang.String[] getConfigurationParts(java.lang.String deployableObjectName)

Return is the array of names of configuration deployable object parts contained in the deployable object specified as input parameter.

Returns:

the array of names of configuration deployable object parts contained in the deployable object specified as input parameter

getDeployableObjects

public static java.lang.String[] getDeployableObjects()

Return is the array of deployable object names of currently deployed Web Dynpro applications.

Returns:

he array of deployable object names of currently deployed Web Dynpro applications

getInterfaceParts

public java.lang.String[] getInterfaceParts(java.lang.String deployableObjectName)

Return is the array of names of interface deployable object parts contained in the deployable object specified as input parameter.

Returns:

the array of names of interface deployable object parts contained in the deployable object specified as input parameter

getDeployableObjectParts

public static java.lang.String[] getDeployableObjectParts(java.lang.String deployableObject)

Return is the array of names of deployable object parts belonging to the specified deployable object.

Parameters:

deployableObjectName - the name of the deployable object for which the deployable object parts should be returned

Returns:

the array of names of deployable object parts belonging to the specified deployable object

getNumberOfDeployableObjectParts

public static int getNumberOfDeployableObjectParts(java.lang.String deployableObject)

Return is the number of deployable object parts belonging to the specified deployable object.

Parameters:

deployableObjectName - the name of the deployable object for which the number of deployable object parts should be returned

Returns:

the number of deployable object parts belonging to the specified deployable object

getActualServerSessions

public static java.lang.String[] getActualServerSessions()

Return is the array of actual server sessions. An entry in the array is the .

Returns:

the array of actual server session identifiers

getNumberOfActualServerSessions

public static int getNumberOfActualServerSessions()

Return is the number of actual server sessions.

Returns:

the number of actual server sessions

getActualServerSession

public static java.lang.String getActualServerSession(java.lang.String clientUserId)

Return is the server session associated to the specified client user.

Parameters:

clientUserId - the client user identifier for which the server session should be returned

Returns:

the server session id associated to the specified client user

getActualClientSessions

public static java.lang.String[] getActualClientSessions()

Return is the array of actually registered client sessions.

Returns:

the array of actually registered client sessions

getNumberOfActualClientSessions

public static int getNumberOfActualClientSessions()

Return is the number of all actually registered client sessions.

Returns:

the number of actually registered client sessions

getActualClientSessions

public static java.lang.String[] getActualClientSessions(java.lang.String serverSessionID)

Return is the array of actually registered client sessions for the specified server sessions.

Parameters:

serverSessionID - a server session ID

Returns:

the array of actually registered client sessions for the specified server sessions

getNumberOfActualClientSessions

public static int getNumberOfActualClientSessions(java.lang.String serverSessionID)

Return is the number of actually registered client sessions for the specified server sessions.

Parameters:

serverSessionID - a server session ID

Returns:

the number of actually registered client sessions for the specified server sessions

getActualClientWindows

public static java.lang.String[] getActualClientWindows()

Return is the array of all actually registered client windows.

Returns:

the array of all actually registered client window identifiers

getNumberOfActualClientWindows

public static int getNumberOfActualClientWindows()

Return is the number of all actually registered client windows.

Returns:

the number of all actually registered client windows

getActualClientWindows

public static java.lang.String[] getActualClientWindows(java.lang.String clientSessionID)

Return is the array of all actually registered client windows for the specified client session.

Parameters:

clientSessionID - a client session ID

Returns:

the array of all actually registered client window identifiers for the specified client session

getNumberOfActualClientWindows

public static int getNumberOfActualClientWindows(java.lang.String clientSessionID)

Return is the number of all actually registered client windows for the specified client session.

Returns:

the number of all actually registered client windows for the specified client session

getStateAsStringArray

public static java.lang.String[] getStateAsStringArray()

Return is the string representation of the actual server state, organized in an array of strings. This method can be used, for instance, to log the actual server state in a log file or to print the actual server state on the console. Each entry in the array represents a separate line.

Returns:

the string representation of the actual server state, organized in an array of strings

getMBean

public static com.sap.tc.webdynpro.services.sal.admin.api.ServerStateMBean getMBean()

Return is the associated MBean.

Returns:

the associated MBean