com.apama.session
Event SessionInfo


The SessionInfo object contains all information relating to a specific registered Session, including its current state and configuration.
Since:
CMF 2.0.1

Member summary
 integersessionId
 stringsessionName
 stringtransportName
 stringchannelName
 stringdescription
 booleaninternal
 contextsourceCtx
 booleanstarted
 booleanconnected
 booleanconnectivitySession
 com.apama.session.SessionConfigParamsconfig
 com.apama.session.SessionConfigSchemaconfigSchema
 com.apama.session.SessionCapabilitiessessionCapabilities
 
Action summary
 com.apama.session.SessionCapabilitiesgetCapabilities()
 stringgetChannelName()

Returns the Channel name that the session will use to communicate to an external source by.
 com.apama.session.SessionConfigParamsgetConfig()

Returns the configuration that the session has been started with, or an empty object if the session has not been started.
 com.apama.session.SessionConfigSchemagetConfigSchema()

Returns the configuration schema for this session.
 stringgetDescription()

Returns a short user-level description of the session.
 integergetSessionId()

Returns the SessionId for the session.
 com.apama.session.SessionKeygetSessionKey()

Returns a SessionKey object for this session.
 stringgetSessionName()

Returns the name of the session.
 contextgetSourceContext()

Returns the context that the datasource session is running in. NOTE: This is only required for datasource sessions that are internal to the correlator.
 stringgetTransportName()

Returns the Transport name for the session.
 booleanisConnected()

Returns a boolean indicating whether the session is connected or in error.
 booleanisConnectivitySession()

Returns a boolean indicating whether the session is using an IAF transport or connectivity plugin transport
 booleanisInternal()

Returns a boolean indicating whether the session is internal or external to the correlator.
 booleanisStarted()

Returns a boolean indicating whether the session is started.
 
Member detail

channelName

            string channelName
        

config

            com.apama.session.SessionConfigParams config
        

configSchema

            com.apama.session.SessionConfigSchema configSchema
        

connected

            boolean connected
        

connectivitySession

            boolean connectivitySession
        

description

            string description
        

internal

            boolean internal
        

sessionCapabilities

            com.apama.session.SessionCapabilities sessionCapabilities
        

sessionId

            integer sessionId
        

sessionName

            string sessionName
        

sourceCtx

            context sourceCtx
        

started

            boolean started
        

transportName

            string transportName
        

Action detail

getCapabilities

            com.apama.session.SessionCapabilities getCapabilities()
        

getChannelName

            string getChannelName()
        
Returns the Channel name that the session will use to communicate to an external source by.
Returns:
The Channel name that the session will use to communicate to an external source by.

getConfig

            com.apama.session.SessionConfigParams getConfig()
        
Returns the configuration that the session has been started with, or an empty object if the session has not been started.
Returns:
The current session configuration if the session has been started.

getConfigSchema

            com.apama.session.SessionConfigSchema getConfigSchema()
        
Returns the configuration schema for this session.
Returns:
The configuration schema for this session.

getDescription

            string getDescription()
        
Returns a short user-level description of the session.
Returns:
A short user-level description of the session.

getSessionId

            integer getSessionId()
        
Returns the SessionId for the session.
Returns:
The SessionId for the session.

getSessionKey

            com.apama.session.SessionKey getSessionKey()
        
Returns a SessionKey object for this session.
Returns:
The a SessionKey object for this session.
See Also:
#SessionKey - The Session Key object.

getSessionName

            string getSessionName()
        
Returns the name of the session.
Returns:
The name of the session.

getSourceContext

            context getSourceContext()
        
Returns the context that the datasource session is running in. NOTE: This is only required for datasource sessions that are internal to the correlator.
Returns:
The context that the datasource session is running in.

getTransportName

            string getTransportName()
        
Returns the Transport name for the session.
Returns:
The Transport name for the session.

isConnected

            boolean isConnected()
        
Returns a boolean indicating whether the session is connected or in error.
Returns:
true if the session is connected, false otherwise.

isConnectivitySession

            boolean isConnectivitySession()
        
Returns a boolean indicating whether the session is using an IAF transport or connectivity plugin transport
Returns:
true if the session is connectivity plugin transport, false otherwise.

isInternal

            boolean isInternal()
        
Returns a boolean indicating whether the session is internal or external to the correlator.
Returns:
true if the session is internal to the correlator, false otherwise.

isStarted

            boolean isStarted()
        
Returns a boolean indicating whether the session is started.
Returns:
true if the session is started, false otherwise.