com.iizix.comm.session

Class SessionID

java.lang.Object

com.iizix.comm.session.SessionID

public final class SessionID
extends Object

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 and Description
static SessionID[]	EMPTY Empty array.
static String	PROP_COMM_ERROR
static String	PROP_REMOTE_ADDR Session ID properties defined.

Constructor Summary

Constructors

Constructor and Description
SessionID(SessionTransMgr manager) Constructs the instance.

Method Summary

Modifier and Type	Method and Description
String	getFullLogInfo() Gets the string representation of this SessionID for logging when a complete "dump" is needed for diagnostics, critical errors, etc.
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.
String	getSessionID() Gets the session identifier.
SessionInfo	getSessionInfo() Gets the session info.
SessionTransMgr	getTransactionManager() Gets the Session Transaction Manager.
void	setProperty(String name, String value) Sets a property for the session.
String	toString() The string representation.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static SessionID[] EMPTY

Empty array.

PROP_REMOTE_ADDR

public static final String PROP_REMOTE_ADDR

Session ID properties defined.

See Also:

Constant Field Values

PROP_COMM_ERROR

public static final String PROP_COMM_ERROR

See Also:

Constant Field Values

Constructor Detail

SessionID

public SessionID(SessionTransMgr manager)

Constructs the instance.

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 SessionTransMgr getTransactionManager()

Gets the Session Transaction Manager.

getSessionInfo

public SessionInfo getSessionInfo()

Gets the session info.

getSessionID

public String getSessionID()

Gets the session identifier.

Returns:

The session identifier, or null if disposed of.

setProperty

public void setProperty(String name,
                        String value)

Sets a property for the session. When a reconnection is done, the previous statistics instance keeps track of the differences in properties between the last properties and the new ones.

getLogString

public String getLogString()

Gets the string representation of this SessionID for logging.

getFullLogInfo

public String getFullLogInfo()

Gets the string representation of this SessionID for logging when a complete "dump" is needed for diagnostics, critical errors, etc.

toString

public String toString()

The string representation.

Overrides:

toString in class Object