com.metamatrix.platform.security.api
Class MetaMatrixSessionInfo

java.lang.Object
  com.metamatrix.platform.security.api.MetaMatrixSessionInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MetaMatrixSessionInfo
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class represents an immutable informational object describing the attributes of a unique MetaMatrix session within a given MetaMatrix System.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

MetaMatrixSessionInfo(MetaMatrixSessionID sessionID, java.lang.String userName, long timeCreated, java.lang.String applicationName, java.util.Properties productInfo, java.lang.String clientIp, java.lang.String clientHostname)
Master constructor, allows a MetaMatrixSessionInfo to be created with any state and any timestamps.

Method Summary

java.lang.Object	clone() Return a cloned instance of this object.
java.lang.String	getApplicationName()
java.lang.String	getClientHostname()
java.lang.String	getClientIp()
long	getLastPingTime() Get the time the server was last pinged by this session.
java.util.Properties	getProductInfo()
java.lang.String	getProductInfo(java.lang.String key)
MetaMatrixSessionID	getSessionID()
SessionToken	getSessionToken()
long	getTimeCreated()
java.io.Serializable	getTrustedToken()
java.lang.String	getUserName()
void	setLastPingTime(long lastPingTime) Used ONLY by the session service to set the time this session last initiated a server ping.
void	setTrustedToken(java.io.Serializable trustedToken)
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MetaMatrixSessionInfo

public MetaMatrixSessionInfo(MetaMatrixSessionID sessionID,
                             java.lang.String userName,
                             long timeCreated,
                             java.lang.String applicationName,
                             java.util.Properties productInfo,
                             java.lang.String clientIp,
                             java.lang.String clientHostname)

Master constructor, allows a MetaMatrixSessionInfo to be created with any state and any timestamps.

Method Detail

getSessionID

public MetaMatrixSessionID getSessionID()

getUserName

public java.lang.String getUserName()

getApplicationName

public java.lang.String getApplicationName()

getTimeCreated

public long getTimeCreated()

getLastPingTime

public long getLastPingTime()

Get the time the server was last pinged by this session. Note that the session's "last ping time" will only be acurate if the session is in the ACTIVE state.

Returns:

The time the server was last pinged by this session.

setLastPingTime

public void setLastPingTime(long lastPingTime)

Used ONLY by the session service to set the time this session last initiated a server ping.

Parameters:

lastPingTime - The last time this session pinged the server.

getSessionToken

public SessionToken getSessionToken()

clone

public java.lang.Object clone()

Return a cloned instance of this object.

Overrides:

clone in class java.lang.Object

Returns:

the object that is the clone of this instance.

toString

public java.lang.String toString()

Returns a string representing the current state of the object.

Overrides:

toString in class java.lang.Object

getProductInfo

public java.lang.String getProductInfo(java.lang.String key)

Returns:

Returns the productInfo.

Since:

4.3

getProductInfo

public java.util.Properties getProductInfo()

getClientIp

public java.lang.String getClientIp()

getClientHostname

public java.lang.String getClientHostname()

setTrustedToken

public void setTrustedToken(java.io.Serializable trustedToken)

getTrustedToken

public java.io.Serializable getTrustedToken()