com.metamatrix.admin.objects
Class MMSession

java.lang.Object
  com.metamatrix.admin.objects.MMAdminObject
      com.metamatrix.admin.objects.MMSession

All Implemented Interfaces:

AdminObject, Session, java.io.Serializable

public class MMSession
extends MMAdminObject
implements Session

MetaMatrix Session

See Also:

Serialized Form

Field Summary

Fields inherited from class com.metamatrix.admin.objects.MMAdminObject

deployed, enabled, identifier, identifierParts, name, OBJECT_TYPE_CACHE, OBJECT_TYPE_CONNECTOR_BINDING, OBJECT_TYPE_CONNECTOR_TYPE, OBJECT_TYPE_DQP, OBJECT_TYPE_ENTITLEMENT, OBJECT_TYPE_EXTENSION_MODULE, OBJECT_TYPE_GROUP, OBJECT_TYPE_HOST, OBJECT_TYPE_LOG_CONFIGURATION, OBJECT_TYPE_MODEL, OBJECT_TYPE_PROCESS_OBJECT, OBJECT_TYPE_PROPERTY_DEFINITION, OBJECT_TYPE_QUEUE_WORKER_POOL, OBJECT_TYPE_REQUEST, OBJECT_TYPE_RESOURCE, OBJECT_TYPE_ROLE, OBJECT_TYPE_SERVICE, OBJECT_TYPE_SESSION, OBJECT_TYPE_SYSTEM_OBJECT, OBJECT_TYPE_TRANSACTION, OBJECT_TYPE_USER, OBJECT_TYPE_VDB, OBJECTS_PACKAGE, registered, serialVersionUID

Fields inherited from interface com.metamatrix.admin.api.objects.Session

ACTIVE_STATE_DESC, CLOSED_STATE_DESC, EXPIRED_STATE_DESC, PASSIVATED_STATE_DESC, STATE_ACTIVE, STATE_CLOSED, STATE_EXPIRED, STATE_PASSIVATED, STATE_TERMINATED, TERMINATED_STATE_DESC, UNKNOWN_STATE_DESC

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Constructor Summary

MMSession(java.lang.String[] identifierParts)
constructor

Method Summary

java.lang.String	getApplicationName() Get the Application Name
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 checked to see if the server is still available
java.lang.String	getLastPingTimeString() Get the Time the User logged into the System as a String
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 SessionState
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
void	setApplicationName(java.lang.String name) Set the ApplicationName
void	setHostName(java.lang.String clientMachineName) Set information defined by the client at runtime
void	setIPAddress(java.lang.String ipAddress) Set IPAddress for this Session
void	setLastPingTime(long lastPingTime) Set the Last time Client has checked to see if the server is still available
void	setSessionState(int state) Set the SessionState
void	setUserName(java.lang.String userName) Set User Name for this Session
void	setVDBName(java.lang.String vdbName) Set VDBName for this Session
void	setVDBVersion(java.lang.String vdbVersion) Set VDBVersion for this Session
java.lang.String	toString() Convert a Session to a String

Methods inherited from class com.metamatrix.admin.objects.MMAdminObject

buildIdentifier, buildIdentifierArray, buildIdentifierList, getCreated, getCreatedBy, getCreatedDate, getIdentifier, getIdentifierArray, getLastChangedBy, getLastChangedDate, getLastUpdated, getLastUpdatedBy, getName, getNameFromIdentifier, getObjectType, getParentName, getProperties, getPropertiesAsString, getPropertyValue, getProps, isDeployed, isEnabled, isRegistered, setCreated, setCreatedBy, setDeployed, setEnabled, setIdentifier, setLastUpdated, setLastUpdatedBy, setProperties, setRegistered

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.admin.api.objects.Session

getCreatedDate

Methods inherited from interface com.metamatrix.admin.api.objects.AdminObject

getIdentifier, getName, getProperties, getPropertyValue

Constructor Detail

MMSession

public MMSession(java.lang.String[] identifierParts)

constructor

Parameters:

identifierParts -

Method Detail

toString

public java.lang.String toString()

Convert a Session to a String

Specified by:

toString in class MMAdminObject

Since:

4.3

See Also:

Object.toString()

getLastPingTime

public java.util.Date getLastPingTime()

Get the Last time Client has checked to see if the server is still available

Specified by:

getLastPingTime in interface Session

Returns:

Date of the last ping to the server.

getLastPingTimeString

public java.lang.String getLastPingTimeString()

Get the Time the User logged into the System as a String

Returns:

String

setLastPingTime

public void setLastPingTime(long lastPingTime)

Set the Last time Client has checked to see if the server is still available

Parameters:

lastPingTime -

getStateAsString

public java.lang.String getStateAsString()

Get the SessionState

Specified by:

getStateAsString in interface Session

Returns:

String with the SessionState

setSessionState

public void setSessionState(int state)

Set the SessionState

Parameters:

state -

getApplicationName

public java.lang.String getApplicationName()

Get the Application Name

Specified by:

getApplicationName in interface Session

Returns:

String of the Application Name

setApplicationName

public void setApplicationName(java.lang.String name)

Set the ApplicationName

Parameters:

name -

getSessionID

public java.lang.String getSessionID()

Get the unique MetaMatrix session within a given MetaMatrix System

Specified by:

getSessionID in interface Session

Returns:

Strings of the Session ID

getState

public int getState()

Get the State of the Session

Specified by:

getState in interface Session

Returns:

int of the Session's state

getUserName

public java.lang.String getUserName()

Get User Name for this Session

Specified by:

getUserName in interface Session

Returns:

String of UserName

setUserName

public void setUserName(java.lang.String userName)

Set User Name for this Session

Parameters:

userName -

getVDBName

public java.lang.String getVDBName()

Get the VDB Name for this Session

Specified by:

getVDBName in interface Session

Returns:

String name of the VDB

setVDBName

public void setVDBName(java.lang.String vdbName)

Set VDBName for this Session

Parameters:

vdbName -

getVDBVersion

public java.lang.String getVDBVersion()

Get the VDB Version for this Session

Specified by:

getVDBVersion in interface Session

Returns:

String name/number of the VDB Version

setVDBVersion

public void setVDBVersion(java.lang.String vdbVersion)

Set VDBVersion for this Session

Parameters:

vdbVersion -

setIPAddress

public void setIPAddress(java.lang.String ipAddress)

Set IPAddress for this Session

Parameters:

ipAddress -

getIPAddress

public java.lang.String getIPAddress()

Get the IPAddress for this Session

Specified by:

getIPAddress in interface Session

Returns:

IPAddress

setHostName

public void setHostName(java.lang.String clientMachineName)

Set information defined by the client at runtime

Parameters:

clientMachineName -

getHostName

public java.lang.String getHostName()

Get the host name of the machine the client is accessing from

Specified by:

getHostName in interface Session

Returns:

IPAddress