MongoSessionDataStore (Jetty :: NoSQL Session Managers 9.4.11.v20180605 API)

java.lang.Object
- org.eclipse.jetty.util.component.AbstractLifeCycle
- - org.eclipse.jetty.util.component.ContainerLifeCycle
  - - org.eclipse.jetty.server.session.AbstractSessionDataStore
    - - org.eclipse.jetty.nosql.NoSqlSessionDataStore
      - org.eclipse.jetty.nosql.mongodb.MongoSessionDataStore

All Implemented Interfaces:

SessionDataMap, SessionDataStore, org.eclipse.jetty.util.component.LifeCycle
```
@ManagedObject
public class MongoSessionDataStore
extends NoSqlSessionDataStore
```
MongoSessionDataStore The document model is an outer object that contains the elements:
- "id" : session_id
- "created" : create_time
- "accessed": last_access_time
- "maxIdle" : max_idle_time setting as session was created
- "expiry" : time at which session should expire
- "valid" : session_valid
- "context" : a nested object containing 1 nested object per context for which the session id is in use
Each of the nested objects inside the "context" element contains:
- unique_context_name : nested object containing name:value pairs of the session attributes for that context
- unique_context_name: vhost:contextpath, where no vhosts="0_0_0_0", root context = "", contextpath "/" replaced by "_"
One of the name:value attribute pairs will always be the special attribute "__metadata__". The value is an object representing a version counter which is incremented every time the attributes change.

For example:
```
 { "_id"       : ObjectId("52845534a40b66410f228f23"), 
    "accessed" :  NumberLong("1384818548903"), 
    "maxIdle"  : 1,
    "context"  : { "0_0_0_0:_testA" : { "A"            : "A", 
                                     "__metadata__" : { "version" : NumberLong(2) } 
                                   },
                   "0_0_0_0:_testB" : { "B"            : "B", 
                                     "__metadata__" : { "version" : NumberLong(1) } 
                                   } 
                 }, 
    "created"  : NumberLong("1384818548903"),
    "expiry"   : NumberLong("1384818549903"),
    "id"       : "w01ijx2vnalgv1sqrpjwuirprp7", 
    "valid"    : true 
 }
 
```
In MongoDB, the nesting level is indicated by "." separators for the key name. Thus to interact with a session attribute, the key is composed of: "context".unique_context_name.attribute_name Eg "context"."0_0_0_0:_testA"."A"

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
  org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener
- Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
  org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener
- Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
  org.eclipse.jetty.util.component.LifeCycle.Listener
- Nested classes/interfaces inherited from class org.eclipse.jetty.nosql.NoSqlSessionDataStore
  NoSqlSessionDataStore.NoSqlSessionData

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`__ACCESSED`	Last access time of session
`static java.lang.String`	`__CONTEXT`	Name of nested document field containing 1 sub document per context for which the session id is in use
`static java.lang.String`	`__CREATED`	Time of session creation
`static java.lang.String`	`__EXPIRY`	Time this session will expire, based on last access time and maxIdle
`static java.lang.String`	`__ID`	Session id
`static java.lang.String`	`__LAST_ACCESSED`
`static java.lang.String`	`__LASTNODE`
`static java.lang.String`	`__LASTSAVED`
`static java.lang.String`	`__MAX_IDLE`	The max idle time of a session (smallest value across all contexts which has a session with the same id)
`static java.lang.String`	`__METADATA`	Special attribute for a session that is context-specific
`static java.lang.String`	`__VALID`	Whether or not session is valid
`static java.lang.String`	`__VERSION`	Special attribute per session per context, incremented each time attributes are modified

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Fields inherited from class org.eclipse.jetty.server.session.AbstractSessionDataStore
_context, _gracePeriodSec, _lastExpiryCheckTime, _savePeriodSec

Constructor Summary

Constructors
Constructor Description

MongoSessionDataStore()

Constructors
Constructor	Description
`MongoSessionDataStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`delete(java.lang.String id)`
`java.util.Set<java.lang.String>`	`doGetExpired(java.util.Set<java.lang.String> candidates)`
`void`	`doStore(java.lang.String id, SessionData data, long lastSaveTime)`
`protected void`	`ensureIndexes()`
`boolean`	`exists(java.lang.String id)`
`com.mongodb.DBCollection`	`getDBCollection()`
`void`	`initialize(SessionContext context)`
`boolean`	`isPassivating()`
`SessionData`	`load(java.lang.String id)`
`void`	`setDBCollection(com.mongodb.DBCollection collection)`
`java.lang.String`	`toString()`

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class org.eclipse.jetty.server.session.AbstractSessionDataStore
checkStarted, doStart, getExpired, getGracePeriodSec, getSavePeriodSec, setGracePeriodSec, setSavePeriodSec, store

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from class org.eclipse.jetty.nosql.NoSqlSessionDataStore
newSessionData

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

- Field Detail
  - __METADATA
```
public static final java.lang.String __METADATA
```
    Special attribute for a session that is context-specific
    
    See Also:
    
    Constant Field Values
  - __CONTEXT
```
public static final java.lang.String __CONTEXT
```
    Name of nested document field containing 1 sub document per context for which the session id is in use
    
    See Also:
    
    Constant Field Values
  - __VERSION
```
public static final java.lang.String __VERSION
```
    Special attribute per session per context, incremented each time attributes are modified
    
    See Also:
    
    Constant Field Values
  - __LASTSAVED
```
public static final java.lang.String __LASTSAVED
```
    See Also:
    
    Constant Field Values
  - __LASTNODE
```
public static final java.lang.String __LASTNODE
```
    See Also:
    
    Constant Field Values
  - __ACCESSED
```
public static final java.lang.String __ACCESSED
```
    Last access time of session
    
    See Also:
    
    Constant Field Values
  - __LAST_ACCESSED
```
public static final java.lang.String __LAST_ACCESSED
```
    See Also:
    
    Constant Field Values
  - __EXPIRY
```
public static final java.lang.String __EXPIRY
```
    Time this session will expire, based on last access time and maxIdle
    
    See Also:
    
    Constant Field Values
  - __MAX_IDLE
```
public static final java.lang.String __MAX_IDLE
```
    The max idle time of a session (smallest value across all contexts which has a session with the same id)
    
    See Also:
    
    Constant Field Values
  - __CREATED
```
public static final java.lang.String __CREATED
```
    Time of session creation
    
    See Also:
    
    Constant Field Values
  - __VALID
```
public static final java.lang.String __VALID
```
    Whether or not session is valid
    
    See Also:
    
    Constant Field Values
  - __ID
```
public static final java.lang.String __ID
```
    Session id
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MongoSessionDataStore
```
public MongoSessionDataStore()
```
- Method Detail
  - setDBCollection
```
public void setDBCollection(com.mongodb.DBCollection collection)
```
  - getDBCollection
```
@ManagedAttribute(value="DBCollection",
                  readonly=true)
public com.mongodb.DBCollection getDBCollection()
```
  - load
```
public SessionData load(java.lang.String id)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    SessionDataMap.load(String)
  - delete
```
public boolean delete(java.lang.String id)
               throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    SessionDataMap.delete(String)
  - exists
```
public boolean exists(java.lang.String id)
               throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    SessionDataStore.exists(java.lang.String)
  - doGetExpired
```
public java.util.Set<java.lang.String> doGetExpired(java.util.Set<java.lang.String> candidates)
```
    Specified by:
    
    doGetExpired in class AbstractSessionDataStore
    
    See Also:
    
    SessionDataStore.getExpired(Set)
  - initialize
```
public void initialize(SessionContext context)
                throws java.lang.Exception
```
    Specified by:
    
    initialize in interface SessionDataMap
    
    Overrides:
    
    initialize in class AbstractSessionDataStore
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    SessionDataMap.initialize(org.eclipse.jetty.server.session.SessionContext)
  - doStore
```
public void doStore(java.lang.String id,
                    SessionData data,
                    long lastSaveTime)
             throws java.lang.Exception
```
    Specified by:
    
    doStore in class AbstractSessionDataStore
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    AbstractSessionDataStore.doStore(String, SessionData, long)
  - ensureIndexes
```
protected void ensureIndexes()
                      throws com.mongodb.MongoException
```
    Throws:
    
    com.mongodb.MongoException
  - isPassivating
```
@ManagedAttribute(value="does store serialize sessions",
                  readonly=true)
public boolean isPassivating()
```
    See Also:
    
    SessionDataStore.isPassivating()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractSessionDataStore
    
    See Also:
    
    AbstractSessionDataStore.toString()

Class MongoSessionDataStore

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

Nested classes/interfaces inherited from class org.eclipse.jetty.nosql.NoSqlSessionDataStore

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Fields inherited from class org.eclipse.jetty.server.session.AbstractSessionDataStore

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Methods inherited from class org.eclipse.jetty.server.session.AbstractSessionDataStore

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

Methods inherited from class org.eclipse.jetty.nosql.NoSqlSessionDataStore

Methods inherited from class java.lang.Object

Field Detail

__METADATA

__CONTEXT

__VERSION

__LASTSAVED

__LASTNODE

__ACCESSED

__LAST_ACCESSED

__EXPIRY

__MAX_IDLE

__CREATED

__VALID

__ID

Constructor Detail

MongoSessionDataStore

Method Detail

setDBCollection

getDBCollection

load

delete

exists

doGetExpired

initialize

doStore

ensureIndexes

isPassivating

toString