File Doc Category Size Date Package
SessionMessage.java API Doc Apache Tomcat 6.0.14 3790 Fri Jul 20 04:20:36 BST 2007 org.apache.catalina.ha.session

SessionMessage

public interface SessionMessage implements org.apache.catalina.ha.ClusterMessage, Serializable

Class Description:
The SessionMessage class is a class that is used when a session has been created, modified, expired in a Tomcat cluster node.
The following events are currently available:

public static final int EVT_SESSION_CREATED

public static final int EVT_SESSION_ACCESSED

public static final int EVT_ATTRIBUTE_ADDED

public static final int EVT_ATTRIBUTE_REMOVED

public static final int EVT_SESSION_EXPIRED_WONOTIFY

public static final int EVT_SESSION_EXPIRED_WNOTIFY

public static final int EVT_GET_ALL_SESSIONS

public static final int EVT_SET_USER_PRINCIPAL

public static final int EVT_SET_SESSION_NOTE

public static final int EVT_REMOVE_SESSION_NOTE

Fields Summary
public static final int
EVT_SESSION_CREATED
Event type used when a session has been created on a node
public static final int
EVT_SESSION_EXPIRED
Event type used when a session has expired
public static final int
EVT_SESSION_ACCESSED
Event type used when a session has been accessed (ie, last access time has been updated. This is used so that the replicated sessions will not expire on the network
public static final int
EVT_GET_ALL_SESSIONS
Event type used when a server comes online for the first time. The first thing the newly started server wants to do is to grab the all the sessions from one of the nodes and keep the same state in there
public static final int
EVT_SESSION_DELTA
Event type used when an attribute has been added to a session, the attribute will be sent to all the other nodes in the cluster
public static final int
EVT_ALL_SESSION_DATA
When a session state is transferred, this is the event.
public static final int
EVT_ALL_SESSION_TRANSFERCOMPLETE
When a session state is complete transferred, this is the event.
Constructors Summary
Methods Summary
public java.lang.String getContextName()
public int getEventType()
returns the event type
return
one of the event types EVT_XXXX
public java.lang.String getEventTypeString()
public byte[] getSession()
return
the serialized data for the session
public java.lang.String getSessionID()
return
the session ID for the session