SessionMessageImpl (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- org.apache.catalina.ha.ClusterMessageBase
- - org.apache.catalina.ha.session.SessionMessageImpl

All Implemented Interfaces:

Serializable, ClusterMessage, SessionMessage
```
public class SessionMessageImpl
extends ClusterMessageBase
implements SessionMessage
```
Session cluster message

Author:

Filip Hanik, Peter Rossbach

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.apache.catalina.ha.ClusterMessageBase
  address
- Fields inherited from interface org.apache.catalina.ha.session.SessionMessage
  EVT_ALL_SESSION_DATA, EVT_ALL_SESSION_NOCONTEXTMANAGER, EVT_ALL_SESSION_TRANSFERCOMPLETE, EVT_CHANGE_SESSION_ID, EVT_GET_ALL_SESSIONS, EVT_SESSION_ACCESSED, EVT_SESSION_CREATED, EVT_SESSION_DELTA, EVT_SESSION_EXPIRED

Constructor Summary

Constructors
Constructor and Description
`SessionMessageImpl()`
`SessionMessageImpl(String contextName, int eventtype, byte[] session, String sessionID, String uniqueID)` Creates a session message.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getContextName()`
`int`	`getEventType()` returns the event type
`String`	`getEventTypeString()` clear text event type name (for logging purpose only)
`byte[]`	`getSession()`
`String`	`getSessionID()`
`long`	`getTimestamp()`
`String`	`getUniqueId()`
`void`	`setTimestamp(long time)` set message send time but only the first setting works (one shot)
`void`	`setUniqueId(String uniqueId)`
`String`	`toString()`

Methods inherited from class org.apache.catalina.ha.ClusterMessageBase
getAddress, setAddress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.catalina.ha.ClusterMessage
getAddress, setAddress

- Constructor Detail
  - SessionMessageImpl
```
public SessionMessageImpl()
```
  - SessionMessageImpl
```
public SessionMessageImpl(String contextName,
                  int eventtype,
                  byte[] session,
                  String sessionID,
                  String uniqueID)
```
    Creates a session message. Depending on what event type you want this message to represent, you populate the different parameters in the constructor
    The following rules apply dependent on what event type argument you use:
    EVT_SESSION_CREATED
    The parameters: session, sessionID must be set.
    EVT_SESSION_EXPIRED
    The parameters: sessionID must be set.
    EVT_SESSION_ACCESSED
    The parameters: sessionID must be set.
    EVT_GET_ALL_SESSIONS
    get all sessions from from one of the nodes.
    EVT_SESSION_DELTA
    Send attribute delta (add,update,remove attribute or principal, ...).
    EVT_ALL_SESSION_DATA
    Send complete serializes session list
    EVT_ALL_SESSION_TRANSFERCOMPLETE
    send that all session state information are transferred after GET_ALL_SESSION received from this sender.
    EVT_CHANGE_SESSION_ID
    send original sessionID and new sessionID.
    EVT_ALL_SESSION_NOCONTEXTMANAGER
    send that context manager does not exist after GET_ALL_SESSION received from this sender.
    
    Parameters:
    contextName - - the name of the context (application
    eventtype - - one of the 8 event type defined in this class
    session - - the serialized byte array of the session itself
    sessionID - - the id that identifies this session
    uniqueID - - the id that identifies this message
- Method Detail
  - getEventType
```
public int getEventType()
```
    returns the event type
    
    Specified by:
    
    getEventType in interface SessionMessage
    
    Returns:
    one of the event types EVT_XXXX
  - getSession
```
public byte[] getSession()
```
    Specified by:
    
    getSession in interface SessionMessage
    
    Returns:
    the serialized data for the session
  - getSessionID
```
public String getSessionID()
```
    Specified by:
    
    getSessionID in interface SessionMessage
    
    Returns:
    the session ID for the session
  - setTimestamp
```
public void setTimestamp(long time)
```
    set message send time but only the first setting works (one shot)
    
    Specified by:
    
    setTimestamp in interface ClusterMessage
    
    Overrides:
    
    setTimestamp in class ClusterMessageBase
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface ClusterMessage
    
    Overrides:
    
    getTimestamp in class ClusterMessageBase
  - getEventTypeString
```
public String getEventTypeString()
```
    clear text event type name (for logging purpose only)
    
    Specified by:
    
    getEventTypeString in interface SessionMessage
    
    Returns:
    the event type in a string representation, useful for debugging
  - getContextName
```
public String getContextName()
```
    Specified by:
    
    getContextName in interface SessionMessage
  - getUniqueId
```
public String getUniqueId()
```
    Specified by:
    
    getUniqueId in interface ClusterMessage
    
    Overrides:
    
    getUniqueId in class ClusterMessageBase
  - setUniqueId
```
public void setUniqueId(String uniqueId)
```
    Specified by:
    
    setUniqueId in interface ClusterMessage
    
    Overrides:
    
    setUniqueId in class ClusterMessageBase
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionMessageImpl

Field Summary

Fields inherited from class org.apache.catalina.ha.ClusterMessageBase

Fields inherited from interface org.apache.catalina.ha.session.SessionMessage

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.ha.ClusterMessageBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.catalina.ha.ClusterMessage

Constructor Detail

SessionMessageImpl

SessionMessageImpl

Method Detail

getEventType

getSession

getSessionID

setTimestamp

getTimestamp

getEventTypeString

getContextName

getUniqueId

setUniqueId

toString