com.sap.conn.jco.monitor
Interface JCoConnectionData


public interface JCoConnectionData

This class provides some details for an RFC connection.


Field Summary
static int STATE_ACTIVE
          Connection state flag: Connection is active.
static int STATE_STATEFUL
          Connection state flag: Connection is stateful.
 
Method Summary
 java.lang.String getAbapClient()
          Returns the client used in the ABAP system.
 java.lang.String getAbapHost()
          Returns the host where the current or last call was executed or from where the current or last request was received.
 java.lang.String getAbapLanguage()
          Returns the language used in the ABAP system.
 java.lang.String getAbapSystemNumber()
          Returns the system number of the ABAP server where the current or last call was executed or from where the current or last request was received.
 java.lang.String getAbapUser()
          Returns the user name used in the ABAP system.
 java.lang.String getApplicationName()
          Returns the application name.
 long getConnectionHandle()
          Returns the connection handle.
The connection handle is unique within the JVM process.
 java.lang.String getConnectionHandleAsString()
          Returns the connection handle as a String.
The connection handle is unique within the JVM process.
 java.lang.String getConnectionType()
          Returns the connection type, which is 'client' or 'server'.
 java.lang.String getConvId()
          Returns the current conversation id.
 byte[] getDSRPassport()
          Returns the byte representation of the DSR passport.
 java.lang.String getDSRPassportAsString()
          Returns the DSR passport as a hexadecimal string.
 java.lang.String getFunctionModuleName()
          Returns the name of the function module that is currently being executed or has been executed last.
 java.lang.String getGroupName()
          Returns the name of the connection group.
The connection groups is either a client pool id or a server group id.
 long getLastActivityTimestamp()
          Returns the timestamp of the last activity of the connection.
 java.lang.String getLastActivityTimestampAsString(java.util.Calendar calendar)
          Returns the timestamp of the last activity of the connection as a String.
For example: '2007-02-28|16:41:59.123'
 java.lang.String getProtocol()
          Returns the communication protocol.
Currently this is always 'RFC'.
 java.lang.String getSessionId()
          Returns the client or server internal session id.
 int getState()
          Returns a flag that indicates the activity state of the connection.
The connection activity state is either STATE_ACTIVE or STATE_STATEFUL.
 java.lang.String getStateAsString()
          Returns the activity state of the connection as String.
For example: 'ACTIVE|STATEFUL'
 java.lang.String getSystemID()
          Returns the system id of the ABAP server, to which the connection is established.
 long getThreadId()
          Returns the thread ID of the thread, in which the connection was last used.
 java.lang.String getThreadIdAsString()
          Returns the thread ID as a String of the thread, in which the connection was last used.
 java.lang.String getThreadName()
          Returns the thread name of the thread, in which the connection was last used.
 

Field Detail

STATE_ACTIVE

static final int STATE_ACTIVE
Connection state flag: Connection is active. This means that the connection is busy with handling a request or executing a function module.

See Also:
Constant Field Values

STATE_STATEFUL

static final int STATE_STATEFUL
Connection state flag: Connection is stateful. This means the back-end context is kept and not destroyed after each request.

See Also:
Constant Field Values
Method Detail

getProtocol

java.lang.String getProtocol()
Returns the communication protocol.
Currently this is always 'RFC'.

Returns:
communication protocol - at the moment always 'RFC'

getSessionId

java.lang.String getSessionId()
Returns the client or server internal session id.

Returns:
client or server internal session id, if available; null otherwise

getFunctionModuleName

java.lang.String getFunctionModuleName()
Returns the name of the function module that is currently being executed or has been executed last.

Returns:
the name of the function module that is currently being executed or has been executed last

getDSRPassport

byte[] getDSRPassport()
Returns the byte representation of the DSR passport.

Returns:
the byte representation of the DSR passport, if available; null otherwise

getConnectionType

java.lang.String getConnectionType()
Returns the connection type, which is 'client' or 'server'.

Returns:
the connection type 'client' or 'server'

getSystemID

java.lang.String getSystemID()
Returns the system id of the ABAP server, to which the connection is established.

Returns:
the system id of the ABAP server

getAbapHost

java.lang.String getAbapHost()
Returns the host where the current or last call was executed or from where the current or last request was received.

Returns:
the host where the current or last call was executed or from where the current or last request was received

getAbapSystemNumber

java.lang.String getAbapSystemNumber()
Returns the system number of the ABAP server where the current or last call was executed or from where the current or last request was received.

Returns:
the system number of the ABAP server where the current or last call was executed or from where the current or last request was received

getAbapClient

java.lang.String getAbapClient()
Returns the client used in the ABAP system.

Returns:
the client used in the ABAP system, if available; null otherwise

getAbapUser

java.lang.String getAbapUser()
Returns the user name used in the ABAP system.

Returns:
the user name used in the ABAP system, if available; null otherwise

getAbapLanguage

java.lang.String getAbapLanguage()
Returns the language used in the ABAP system.

Returns:
the language used in the ABAP system, if available; null otherwise

getConvId

java.lang.String getConvId()
Returns the current conversation id.

Returns:
the current conversation id or null in case of an inactive server connection

getApplicationName

java.lang.String getApplicationName()
Returns the application name.

Returns:
the application name, if provided by the application or runtime; null otherwise

getGroupName

java.lang.String getGroupName()
Returns the name of the connection group.
The connection groups is either a client pool id or a server group id.

Returns:
the name of the connection group; either a client pool id or a server group id

getState

int getState()
Returns a flag that indicates the activity state of the connection.
The connection activity state is either STATE_ACTIVE or STATE_STATEFUL.

Returns:
a flag that indicates the activity state of the connection

getLastActivityTimestamp

long getLastActivityTimestamp()
Returns the timestamp of the last activity of the connection.

Returns:
the last activity timestamp

getStateAsString

java.lang.String getStateAsString()
Returns the activity state of the connection as String.
For example: 'ACTIVE|STATEFUL'

Returns:
the activity state of the connection as a String

getDSRPassportAsString

java.lang.String getDSRPassportAsString()
Returns the DSR passport as a hexadecimal string.

Returns:
the DSR passport as a hexadecimal string

getLastActivityTimestampAsString

java.lang.String getLastActivityTimestampAsString(java.util.Calendar calendar)
Returns the timestamp of the last activity of the connection as a String.
For example: '2007-02-28|16:41:59.123'

Parameters:
calendar - the calender instance to be used for converting the timestamp value into a human readable format
Returns:
the last activity timestamp as a String

getThreadId

long getThreadId()
Returns the thread ID of the thread, in which the connection was last used.

Returns:
the thread ID of the thread, in which the connection was last used

getThreadIdAsString

java.lang.String getThreadIdAsString()
Returns the thread ID as a String of the thread, in which the connection was last used.

Returns:
the thread ID as a String of the thread, in which the connection was last used

getThreadName

java.lang.String getThreadName()
Returns the thread name of the thread, in which the connection was last used.

Returns:
the thread name of the thread, in which the connection was last used

getConnectionHandle

long getConnectionHandle()
Returns the connection handle.
The connection handle is unique within the JVM process.

Returns:
the connection handle

getConnectionHandleAsString

java.lang.String getConnectionHandleAsString()
Returns the connection handle as a String.
The connection handle is unique within the JVM process.

Returns:
the connection handle as a String


Copyright © 2008-2016 SAP SE. All Rights Reserved.