RepositoryBackedSession (session-replacement 0.4.7 API)

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

```
public class RepositoryBackedSession
extends Object
```
Session that can be stored in repository. The class provides services for retrieving, removing and adding attributes.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConcurrentHashMap<String,com.amadeus.session.RepositoryBackedSession.Attribute>`	`attrs` Each attribute that was get from repository, removed or set during request is stored in this map.
`protected SessionManager`	`manager`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RepositoryBackedSession(RepositoryBackedSession linked)`
	`RepositoryBackedSession(SessionData sessionData, SessionManager manager, SessionFactory factory)` Creates session based on given `SessionData` using `SessionManager` to manage lifecycle of session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`commit()` Stores session to session repository.
`protected void`	`committed()` Called when the session was committed.
`void`	`doInvalidate(boolean expired)` This method performs invalidation of the session.
`Object`	`getAttribute(String key)` Returns value of the attribute
`com.amadeus.session.RepositoryBackedSession.Attribute`	`getAttributeFromCache(String name)` Retrieves attribute descriptor from internal cache.
`Enumeration`	`getAttributeNames()` Retrieves list of all known attributes.
`List<String>`	`getAttributeNamesWithValues()` Used internally to get attribute names that have values
`Runnable`	`getCommitter()` Returns committer that can be called to commit session.
`int`	`getConcurrentUses()`
`long`	`getCreationTime()` Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
`String`	`getId()` Returns a string containing the unique identifier assigned to this session.
`long`	`getLastAccessedTime()` Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the request was received.
`int`	`getMaxInactiveInterval()` Returns maximum inactive interval for the session in seconds.
`SessionData`	`getSessionData()` Returns descriptor of this session (see `SessionData`).
`SessionManager`	`getSessionManager()` Returns `SessionManager` associated to this http session.
`void`	`invalidate()` Invalidates this session then unbinds any objects bound to it.
`boolean`	`isCommitted()` Returns `true` if session was committed during request
`boolean`	`isDirty()` Set to `true` if session has been changed during request since last commit.
`boolean`	`isExpired()` Returns `true` if session has expired.
`boolean`	`isNew()` Returns `true` if the client does not yet know about the session or if the client chooses not to join the session.
`boolean`	`isValid()` Returns `true` if session is valid.
`void`	`removeAttribute(String name)` Removes the object bound with the specified name from this session.
`void`	`setAttribute(String key, Object value)` Binds an object to this session, using the name specified.
`void`	`setCommitted(boolean committed)` Sets the flag indicating if session was committed.
`void`	`setMaxInactiveInterval(int maxInactiveInterval)` Sets inactivity interval before session is invalidated.

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

- Field Detail
  - manager
```
protected final SessionManager manager
```
  - attrs
```
protected final ConcurrentHashMap<String,com.amadeus.session.RepositoryBackedSession.Attribute> attrs
```
    Each attribute that was get from repository, removed or set during request is stored in this map. Keys of the map are names of attributes, and values are descriptors of the attributes.
- Constructor Detail
  - RepositoryBackedSession
```
public RepositoryBackedSession(SessionData sessionData,
                               SessionManager manager,
                               SessionFactory factory)
```
    Creates session based on given SessionData using SessionManager to manage lifecycle of session.
    
    Parameters:
    
    sessionData - the session descriptor
    
    manager - the associated session manager
    
    factory - the session factory
  - RepositoryBackedSession
```
protected RepositoryBackedSession(RepositoryBackedSession linked)
```
- Method Detail
  - setMaxInactiveInterval
```
public void setMaxInactiveInterval(int maxInactiveInterval)
```
    Sets inactivity interval before session is invalidated. Value is in seconds
    
    Parameters:
    
    maxInactiveInterval - inactivity interval in seconds before session is invalidated
  - getAttribute
```
public Object getAttribute(String key)
```
    Returns value of the attribute
    
    Parameters:
    
    key - name of the attribute
    
    Returns:
    
    value of the attribute
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Retrieves list of all known attributes. It includes both those known locally and the ones from repostiory.
    
    Returns:
    
    enumeration of all known attributes
  - getAttributeNamesWithValues
```
public List<String> getAttributeNamesWithValues()
```
    Used internally to get attribute names that have values
    
    Returns:
    
    list containing all loaded attributes with values
  - getCreationTime
```
public long getCreationTime()
```
    Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
    
    Returns:
    
    a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
    
    Throws:
    
    IllegalStateException - if this method is called on an invalidated session
  - getId
```
public String getId()
```
    Returns a string containing the unique identifier assigned to this session. The identifier can be customized but usually it is a UUID.
    
    Returns:
    
    a string specifying the identifier assigned to this session
    
    Throws:
    
    IllegalStateException - if this method is called on an invalidated session
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the request was received.
    Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
    
    Returns:
    
    a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
    
    Throws:
    
    IllegalStateException - if this method is called on an invalidated session
  - getMaxInactiveInterval
```
public int getMaxInactiveInterval()
```
    Returns maximum inactive interval for the session in seconds.
    
    Returns:
    
    maximum inactive interval for the session in seconds.
  - invalidate
```
public void invalidate()
```
    Invalidates this session then unbinds any objects bound to it.
    
    Throws:
    
    IllegalStateException - if this method is called on an already invalidated session
  - doInvalidate
```
public void doInvalidate(boolean expired)
```
    This method performs invalidation of the session. If it was called on session expire event, invalidation will happen at the session commit time. If it was called from invalidate() method, invalidation is effective immediately.
    
    Parameters:
    
    expired - set to true if invalidate is due to expiring
  - isNew
```
public boolean isNew()
```
    Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if an HTTP server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.
    
    Returns:
    
    true if the server has created a session, but the client has not yet joined
    
    Throws:
    
    IllegalStateException - if this method is called on an already invalidated session
  - removeAttribute
```
public void removeAttribute(String name)
```
    Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.
    After this method executes, it calls SessionNotifier.attributeRemoved(RepositoryBackedSession, String, Object) .
    
    Parameters:
    
    name - the name of the object to remove from this session
    
    Throws:
    
    IllegalStateException - if this method is called on an invalidated session
  - getAttributeFromCache
```
public com.amadeus.session.RepositoryBackedSession.Attribute getAttributeFromCache(String name)
```
    Retrieves attribute descriptor from internal cache.
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    attribute or null if not present
  - setAttribute
```
public void setAttribute(String key,
                         Object value)
```
    Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.
    After this method executes, and if the attribute was replaced the method calls SessionNotifier.attributeReplaced(RepositoryBackedSession, String, Object) , and if it was new, the method calls SessionNotifier.attributeAdded(RepositoryBackedSession, String, Object) .
    
    If the value passed in is null, this has the same effect as calling removeAttribute().
    
    Parameters:
    
    key - the name to which the object is bound; cannot be null
    
    value - the object to be bound
    
    Throws:
    
    IllegalStateException - if this method is called on an invalidated session
  - commit
```
public void commit()
```
    Stores session to session repository. Called when request is completed. If session is invalid call has no effect.
  - committed
```
protected void committed()
```
    Called when the session was committed.
  - isValid
```
public boolean isValid()
```
    Returns true if session is valid. Session becomes invalid following call to invalidate() method.
    
    Returns:
    
    true if session is valid
  - isExpired
```
public boolean isExpired()
```
    Returns true if session has expired. Session is expired if current time is less then sum of getLastAccessedTime() and max
    
    Returns:
    
    true if session has expired
  - isDirty
```
public boolean isDirty()
```
    Set to true if session has been changed during request since last commit.
    
    Returns:
    
    true if session has been changed
  - getCommitter
```
public Runnable getCommitter()
```
    Returns committer that can be called to commit session. Committer is a Runnable instance. See Committer
    
    Returns:
    
    a Committer for this session
  - getSessionData
```
public SessionData getSessionData()
```
    Returns descriptor of this session (see SessionData).
    
    Returns:
    
    the session descriptor
  - isCommitted
```
public boolean isCommitted()
```
    Returns true if session was committed during request
    
    Returns:
    
    true if session was committed during request
  - setCommitted
```
public void setCommitted(boolean committed)
```
    Sets the flag indicating if session was committed.
    
    Parameters:
    
    committed - flag indicating if session was committed
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Returns SessionManager associated to this http session.
    
    Returns:
    
    SessionManager associated to this http session.
  - getConcurrentUses
```
public int getConcurrentUses()
```
    Returns:
    
    the concurrentUses

Class RepositoryBackedSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

manager

attrs

Constructor Detail

RepositoryBackedSession

RepositoryBackedSession

Method Detail

setMaxInactiveInterval

getAttribute

getAttributeNames

getAttributeNamesWithValues

getCreationTime

getId

getLastAccessedTime

getMaxInactiveInterval

invalidate

doInvalidate

isNew

removeAttribute

getAttributeFromCache

setAttribute

commit

committed

isValid

isExpired

isDirty

getCommitter

getSessionData

isCommitted

setCommitted

getSessionManager

getConcurrentUses