org.teiid.adminapi
Interface Session

All Superinterfaces:
AdminObject
All Known Implementing Classes:
MMSession

public interface Session
extends AdminObject

A Session is a lasting connection between a client and a MetaMatrix System. A user may be allowed to have multiple sessions active simultaneously.

a Session identifier gets automatically assigned to a connection when user logs into the system

Since:
4.3

Field Summary
static java.lang.String ACTIVE_STATE_DESC
          The description when the session is open (active).
static java.lang.String CLOSED_STATE_DESC
          The description when the session is closed - this state cannot change once it is reached.
static java.lang.String EXPIRED_STATE_DESC
          The description when the session has expired - this state cannot change once it is reached.
static java.lang.String PASSIVATED_STATE_DESC
          The description when the ejb server has passivated the session - it may become open again in the future
static int STATE_ACTIVE
          The session is open (active).
static int STATE_CLOSED
          The session is closed - this state cannot change once it is reached.
static int STATE_EXPIRED
          The session has expired - this state cannot change once it is reached.
static int STATE_PASSIVATED
          The ejb server has passivated the session - it may become open again in the future
static int STATE_TERMINATED
          The session is terminated - this state cannot change once it is reached.
static java.lang.String TERMINATED_STATE_DESC
          The description when the session is terminated - this state cannot change once it is reached.
static java.lang.String UNKNOWN_STATE_DESC
          The description when the state of the session is not known.
 
Fields inherited from interface org.teiid.adminapi.AdminObject
DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD
 
Method Summary
 java.lang.String getApplicationName()
          Get the Application Name
 java.util.Date getCreatedDate()
          Get the time the Session was created.
 java.lang.String getHostName()
          Get the host name of the machine the client is accessing from
 java.lang.String getIPAddress()
          Get the IPAddress for this Session
 java.util.Date getLastPingTime()
          Get the Last time Client has check to see if the server is still available
 java.lang.String getSessionID()
          Get the unique MetaMatrix session within a given MetaMatrix System
 int getState()
          Get the State of the Session
 java.lang.String getStateAsString()
          Get the Session State as a String.
 java.lang.String getUserName()
          Get User Name for this Session
 java.lang.String getVDBName()
          Get the VDB Name for this Session
 java.lang.String getVDBVersion()
          Get the VDB Version for this Session
 
Methods inherited from interface org.teiid.adminapi.AdminObject
getIdentifier, getName, getProperties, getPropertyValue
 

Field Detail

STATE_ACTIVE

static final int STATE_ACTIVE
The session is open (active).

See Also:
Constant Field Values

STATE_PASSIVATED

static final int STATE_PASSIVATED
The ejb server has passivated the session - it may become open again in the future

See Also:
Constant Field Values

STATE_CLOSED

static final int STATE_CLOSED
The session is closed - this state cannot change once it is reached.

See Also:
Constant Field Values

STATE_EXPIRED

static final int STATE_EXPIRED
The session has expired - this state cannot change once it is reached.

See Also:
Constant Field Values

STATE_TERMINATED

static final int STATE_TERMINATED
The session is terminated - this state cannot change once it is reached.

See Also:
Constant Field Values

EXPIRED_STATE_DESC

static final java.lang.String EXPIRED_STATE_DESC
The description when the session has expired - this state cannot change once it is reached.

See Also:
Constant Field Values

ACTIVE_STATE_DESC

static final java.lang.String ACTIVE_STATE_DESC
The description when the session is open (active).

See Also:
Constant Field Values

CLOSED_STATE_DESC

static final java.lang.String CLOSED_STATE_DESC
The description when the session is closed - this state cannot change once it is reached.

See Also:
Constant Field Values

TERMINATED_STATE_DESC

static final java.lang.String TERMINATED_STATE_DESC
The description when the session is terminated - this state cannot change once it is reached.

See Also:
Constant Field Values

PASSIVATED_STATE_DESC

static final java.lang.String PASSIVATED_STATE_DESC
The description when the ejb server has passivated the session - it may become open again in the future

See Also:
Constant Field Values

UNKNOWN_STATE_DESC

static final java.lang.String UNKNOWN_STATE_DESC
The description when the state of the session is not known.

See Also:
Constant Field Values
Method Detail

getLastPingTime

java.util.Date getLastPingTime()
Get the Last time Client has check to see if the server is still available

Returns:
Date of the last ping to the server.

getStateAsString

java.lang.String getStateAsString()
Get the Session State as a String.

Returns:
SessionState

getApplicationName

java.lang.String getApplicationName()
Get the Application Name

Returns:
String of the Application Name

getSessionID

java.lang.String getSessionID()
Get the unique MetaMatrix session within a given MetaMatrix System

Returns:
String of the Session ID

getState

int getState()
Get the State of the Session

Returns:
int of the Session's state

getUserName

java.lang.String getUserName()
Get User Name for this Session

Returns:
String of UserName

getVDBName

java.lang.String getVDBName()
Get the VDB Name for this Session

Returns:
String name of the VDB

getVDBVersion

java.lang.String getVDBVersion()
Get the VDB Version for this Session

Returns:
String name/number of the VDB Version

getIPAddress

java.lang.String getIPAddress()
Get the IPAddress for this Session

Returns:

getHostName

java.lang.String getHostName()
Get the host name of the machine the client is accessing from

Returns:

getCreatedDate

java.util.Date getCreatedDate()
Get the time the Session was created.

Returns:


Copyright © 2009. All Rights Reserved.