SessionData (session-replacement 0.4.7 API)

java.lang.Object
- com.amadeus.session.SessionData

```
public class SessionData
extends Object
```
Container for basic session information. It includes the following standard data uses for HttpSession in JEE:
- creation time as timestamp
- last accesses time as timestamp
- max inactive interval in seconds
- whether the session is a new one
It also includes additional information:
- last accessed time at moment of the retrieval from repository. This can be used to manage expiration strategy - e.g. as we now have new access time, we can clean timers that are based on this old session accessed time.
- keys that are known to be stored in repository. For attributes that are in repository, we can retrieve them when we need to trigger notification during a request.
- keys of attributes that must be kept synchronized with repository. Any change to such attribute is immediately propagated to repository.
- the id of node that previously owned the session (may be the same as current
- old session id if session id was changed

Constructor Summary

Constructors
Constructor and Description
`SessionData(String sessionId, long creationTime, int maxInactiveInterval)` Constructor used when session is created.
`SessionData(String id, long lastAccessedTime, int maxInactiveInterval, long creationTime, String previousOwner)` Constructor with session id, last epoch time of access, maximum inactivity interval, creation time (from epoch) and node id of previous owner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`long`	`expiresAt()` Returns instant when the session expires.
`long`	`getCreationTime()` Creation time expressed in seconds since epoch.
`String`	`getId()`
`long`	`getLastAccessedTime()` Last accessed time expressed in seconds since epoch.
`Set<String>`	`getMandatoryRemoteKeys()` Set of keys whose attributes must be directly stored and retrieved from repository.
`int`	`getMaxInactiveInterval()` Returns maximum inactivity interval before session expires in seconds.
`String`	`getOldSessionId()` Retrieves old session id or null if session id was not changed.
`String`	`getOriginalId()` Returns session id that was used to retrieve session from store.
`long`	`getOriginalLastAccessed()` Last accessed instant retrieved from repository.
`String`	`getPreviousOwner()` Returns id of the node that owned session in previous request
`Set<String>`	`getRepositoryKeys()` Retrieves set of keys for this session that have been stored in repository.
`int`	`hashCode()`
`boolean`	`isIdChanged()` Return `true` if session id has changed.
`boolean`	`isMaybeInRepository(String name)` Checks if key is a key of an attribute that present in repository.
`boolean`	`isNew()`
`boolean`	`isNonCacheable(String key)` Returns `true` if attribute must be retrieved and stored directly into repository.
`void`	`setCreationTime(long creationTime)` Sets creation time of the session.
`void`	`setId(String id)` Sets session id.
`void`	`setLastAccessedTime(long lastAccessedTime)` Sets last accessed time of the session.
`void`	`setMandatoryRemoteKeys(Set<String> mandatoryRemoteKeys)` Set keys whose attributes must be directly stored and retrieved from repository.
`void`	`setMaxInactiveInterval(int maxInactiveInterval)` Sets maximum inactivity interval before session expires
`void`	`setNew(boolean isNew)` Sets flag if the session is new or not
`void`	`setNewSessionId(String newSessionId)` Sets new session id.
`String`	`toString()`

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

- Constructor Detail
  - SessionData
```
public SessionData(String id,
                   long lastAccessedTime,
                   int maxInactiveInterval,
                   long creationTime,
                   String previousOwner)
```
    Constructor with session id, last epoch time of access, maximum inactivity interval, creation time (from epoch) and node id of previous owner.
    
    Parameters:
    
    id - the session id
    
    lastAccessedTime - timestamp when the session was previously accessed
    
    maxInactiveInterval - maximum inactivity interval in seconds
    
    creationTime - timestamp of the session creation
    
    previousOwner - the node that was previous owner of the session
  - SessionData
```
public SessionData(String sessionId,
                   long creationTime,
                   int maxInactiveInterval)
```
    Constructor used when session is created. Takes session id, creation instant (which is used as last accessed instant), and maximum inactivity interval as arguments.
    
    Parameters:
    
    sessionId - the session id
    
    creationTime - timestamp of the session creation
    
    maxInactiveInterval - maximum inactivity interval in seconds
- Method Detail
  - getId
```
public String getId()
```
    Returns:
    
    session id
  - setId
```
public void setId(String id)
```
    Sets session id.
    
    Parameters:
    
    id - the session id
  - getCreationTime
```
public long getCreationTime()
```
    Creation time expressed in seconds since epoch.
    
    Returns:
    
    the session creation time
  - setCreationTime
```
public void setCreationTime(long creationTime)
```
    Sets creation time of the session.
    
    Parameters:
    
    creationTime - the session creation time in seconds since epoch
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Last accessed time expressed in seconds since epoch.
    
    Returns:
    
    last accessed time expressed in seconds since epoch
  - setLastAccessedTime
```
public void setLastAccessedTime(long lastAccessedTime)
```
    Sets last accessed time of the session.
    
    Parameters:
    
    lastAccessedTime - the last accessed time expressed in seconds since epoch
  - getMaxInactiveInterval
```
public int getMaxInactiveInterval()
```
    Returns maximum inactivity interval before session expires in seconds.
    
    Returns:
    
    maximum inactivity interval
  - setMaxInactiveInterval
```
public void setMaxInactiveInterval(int maxInactiveInterval)
```
    Sets maximum inactivity interval before session expires
    
    Parameters:
    
    maxInactiveInterval - maximum inactivity interval in seconds
  - isNew
```
public boolean isNew()
```
    Returns:
    
    true if session is new
  - setNew
```
public void setNew(boolean isNew)
```
    Sets flag if the session is new or not
    
    Parameters:
    
    isNew - true if session is new
  - isMaybeInRepository
```
public boolean isMaybeInRepository(String name)
```
    Checks if key is a key of an attribute that present in repository.
    
    Parameters:
    
    name - key of attribute
    
    Returns:
    
    true if attribute may be in repository
  - getRepositoryKeys
```
public Set<String> getRepositoryKeys()
```
    Retrieves set of keys for this session that have been stored in repository. If the value is null, then the set has yet not been retrieved from repository
    
    Returns:
    
    set of keys present in session in repository or null if the set has not been retrieved from repository.
  - getMandatoryRemoteKeys
```
public Set<String> getMandatoryRemoteKeys()
```
    Set of keys whose attributes must be directly stored and retrieved from repository. This means that those attributes can't be cached using
    
    Returns:
    
    keys whose attributes must be stored and retrieved from repository
  - setMandatoryRemoteKeys
```
public void setMandatoryRemoteKeys(Set<String> mandatoryRemoteKeys)
```
    Set keys whose attributes must be directly stored and retrieved from repository.
    
    Parameters:
    
    mandatoryRemoteKeys - set of keys that must be directly backed by repository
  - getOriginalLastAccessed
```
public long getOriginalLastAccessed()
```
    Last accessed instant retrieved from repository. Usually corresponds to instant of the processing of the previous request.
    
    Returns:
    
    last accessed instant as retrieved from repository
  - getPreviousOwner
```
public String getPreviousOwner()
```
    Returns id of the node that owned session in previous request
    
    Returns:
    
    id of node that owned session in previous request
  - expiresAt
```
public long expiresAt()
```
    Returns instant when the session expires.
    
    Returns:
    
    instant when the session expires
  - isNonCacheable
```
public boolean isNonCacheable(String key)
```
    Returns true if attribute must be retrieved and stored directly into repository.
    
    Parameters:
    
    key - the attribute key to checked
    
    Returns:
    
    true if attribute must be backed by repository
  - getOldSessionId
```
public String getOldSessionId()
```
    Retrieves old session id or null if session id was not changed. Used if session id has been changed.
    
    Returns:
    
    the newSessionId
  - setNewSessionId
```
public void setNewSessionId(String newSessionId)
```
    Sets new session id. Used to change session id.
    
    Parameters:
    
    newSessionId - the newSessionId to set
  - getOriginalId
```
public String getOriginalId()
```
    Returns session id that was used to retrieve session from store. As the id may change during request, we need original id to access the repository.
    
    Returns:
    
    original session id if session id was changed, otherwise current session id
  - isIdChanged
```
public boolean isIdChanged()
```
    Return true if session id has changed.
    
    Returns:
    
    true if session id has changed
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionData

SessionData

Method Detail

getId

setId

getCreationTime

setCreationTime

getLastAccessedTime

setLastAccessedTime

getMaxInactiveInterval

setMaxInactiveInterval

isNew

setNew

isMaybeInRepository

getRepositoryKeys

getMandatoryRemoteKeys

setMandatoryRemoteKeys

getOriginalLastAccessed

getPreviousOwner

expiresAt

isNonCacheable

getOldSessionId

setNewSessionId

getOriginalId

isIdChanged

hashCode

equals

toString