Package org.apache.catalina.ha.session
Interface SessionMessage
- 
- All Superinterfaces:
- ClusterMessage,- java.io.Serializable
 - All Known Implementing Classes:
- SessionMessageImpl
 
 public interface SessionMessage extends ClusterMessage The SessionMessage interface 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_EXPIRED
- public static final int EVT_SESSION_ACCESSED
- public static final int EVT_GET_ALL_SESSIONS
- public static final int EVT_SESSION_DELTA
- public static final int EVT_ALL_SESSION_DATA
- public static final int EVT_ALL_SESSION_TRANSFERCOMPLETE
- public static final int EVT_CHANGE_SESSION_ID
- public static final int EVT_ALL_SESSION_NOCONTEXTMANAGER
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intEVT_ALL_SESSION_DATAWhen a session state is transferred, this is the event.static intEVT_ALL_SESSION_NOCONTEXTMANAGEREvent type used when context manager doesn't exist.static intEVT_ALL_SESSION_TRANSFERCOMPLETEWhen a session state is complete transferred, this is the event.static intEVT_CHANGE_SESSION_IDEvent type used when a sessionID has been changed.static intEVT_GET_ALL_SESSIONSEvent type used when a server comes online for the first time.static intEVT_SESSION_ACCESSEDEvent type used when a session has been accessed (ie, last access time has been updated.static intEVT_SESSION_CREATEDEvent type used when a session has been created on a nodestatic intEVT_SESSION_DELTAEvent type used when an attribute has been added to a session, the attribute will be sent to all the other nodes in the clusterstatic intEVT_SESSION_EXPIREDEvent type used when a session has expired
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetContextName()intgetEventType()returns the event typejava.lang.StringgetEventTypeString()byte[]getSession()java.lang.StringgetSessionID()- 
Methods inherited from interface org.apache.catalina.ha.ClusterMessagegetAddress, getTimestamp, getUniqueId, setAddress, setTimestamp
 
- 
 
- 
- 
- 
Field Detail- 
EVT_SESSION_CREATEDstatic final int EVT_SESSION_CREATED Event type used when a session has been created on a node- See Also:
- Constant Field Values
 
 - 
EVT_SESSION_EXPIREDstatic final int EVT_SESSION_EXPIRED Event type used when a session has expired- See Also:
- Constant Field Values
 
 - 
EVT_SESSION_ACCESSEDstatic 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- See Also:
- Constant Field Values
 
 - 
EVT_GET_ALL_SESSIONSstatic 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- See Also:
- Constant Field Values
 
 - 
EVT_SESSION_DELTAstatic 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- See Also:
- Constant Field Values
 
 - 
EVT_ALL_SESSION_DATAstatic final int EVT_ALL_SESSION_DATA When a session state is transferred, this is the event.- See Also:
- Constant Field Values
 
 - 
EVT_ALL_SESSION_TRANSFERCOMPLETEstatic final int EVT_ALL_SESSION_TRANSFERCOMPLETE When a session state is complete transferred, this is the event.- See Also:
- Constant Field Values
 
 - 
EVT_CHANGE_SESSION_IDstatic final int EVT_CHANGE_SESSION_ID Event type used when a sessionID has been changed.- See Also:
- Constant Field Values
 
 - 
EVT_ALL_SESSION_NOCONTEXTMANAGERstatic final int EVT_ALL_SESSION_NOCONTEXTMANAGER Event type used when context manager doesn't exist. This is used when the manager which send a session state does not exist.- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getContextNamejava.lang.String getContextName() 
 - 
getEventTypeStringjava.lang.String getEventTypeString() 
 - 
getEventTypeint getEventType() returns the event type- Returns:
- one of the event types EVT_XXXX
 
 - 
getSessionbyte[] getSession() - Returns:
- the serialized data for the session
 
 - 
getSessionIDjava.lang.String getSessionID() - Returns:
- the session ID for the session
 
 
- 
 
-