Package com.iizix.comm.session
Class SessionID
- java.lang.Object
- com.iizix.comm.session.SessionID
- All Implemented Interfaces:
ISessionStatistics
public final class SessionID extends java.lang.Object implements ISessionStatistics
The session ID is used to identify a transaction session that can be used to pick up communication again after a broken link, and also to store additional information about a user and other settings to easy re-establishing a session. This could be e.g. User ID and Passwords entered by the User in various points throughout the UI. This can safely be stored in this instance as it is a volatile instance that do not persist.- Author:
- Christopher Mindus
Field Summary
Fields Modifier and Type Field Description static SessionID[]
EMPTY
Empty array.static java.lang.String
PROP_COMM_ERROR
static java.lang.String
PROP_REMOTE_ADDR
Session ID properties defined.
Constructor Summary
Constructors Constructor Description SessionID(ISessionTransMgr manager)
Constructs the instance.
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getFullLogInfo()
Gets the string representation of this SessionID for logging when a complete "dump" is needed for diagnostics, critical errors, etc.java.lang.String
getLogString()
Gets the string representation of this SessionID for logging.static SessionID[]
getOpenSessions()
Gets all the Session ID's open.static int
getOpenSessionsCount()
Gets the count of open sessions.java.lang.String
getSessionID()
Gets the session identifier.SessionInfo
getSessionInfo()
Gets the session info.SessionStatistics
getSessionStatistics()
Gets the statistics instance of the session.ISessionTransMgr
getTransactionManager()
Gets the Session Transaction Manager.java.lang.String
toString()
The string representation.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.iizix.comm.session.ISessionStatistics
getLastConnectionTime, getProperties, getProperty, setProperty
Field Detail
EMPTY
public static SessionID[] EMPTY
Empty array.
PROP_REMOTE_ADDR
public static final java.lang.String PROP_REMOTE_ADDR
Session ID properties defined.- See Also:
- Constant Field Values
PROP_COMM_ERROR
public static final java.lang.String PROP_COMM_ERROR
- See Also:
- Constant Field Values
Constructor Detail
SessionID
public SessionID(ISessionTransMgr manager)
Constructs the instance.- Parameters:
manager
- The session transaction manager.- Throws:
java.lang.NullPointerException
- Ifmanager
isnull
.
Method Detail
getOpenSessionsCount
public static int getOpenSessionsCount()
Gets the count of open sessions.
getOpenSessions
public static SessionID[] getOpenSessions()
Gets all the Session ID's open.
getTransactionManager
public ISessionTransMgr getTransactionManager()
Gets the Session Transaction Manager.- Returns:
- The instance, never null.
getSessionStatistics
public SessionStatistics getSessionStatistics()
Gets the statistics instance of the session.- Specified by:
getSessionStatistics
in interfaceISessionStatistics
- Returns:
- The SessionStatistics instance.
getSessionInfo
public SessionInfo getSessionInfo()
Gets the session info.
getSessionID
public java.lang.String getSessionID()
Gets the session identifier.- Returns:
- The session identifier, or null if disposed of.
getLogString
public java.lang.String getLogString()
Gets the string representation of this SessionID for logging.
getFullLogInfo
public java.lang.String getFullLogInfo()
Gets the string representation of this SessionID for logging when a complete "dump" is needed for diagnostics, critical errors, etc.
toString
public java.lang.String toString()
The string representation.- Overrides:
toString
in classjava.lang.Object