Module org.eclipse.jetty.session

Package org.eclipse.jetty.session

Interface SessionDataMap

All Superinterfaces:

org.eclipse.jetty.util.component.LifeCycle

All Known Subinterfaces:

SessionDataStore

All Known Implementing Classes:

AbstractSessionDataStore, CachingSessionDataStore, FileSessionDataStore, JDBCSessionDataStore, NullSessionDataStore, ObjectStreamSessionDataStore

public interface SessionDataMap
extends org.eclipse.jetty.util.component.LifeCycle

A map style access to SessionData keyed by the session id.

Nested Class Summary

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

org.eclipse.jetty.util.component.LifeCycle.Listener

Method Summary

Modifier and Type	Method	Description
boolean	delete(String id)	Delete session data
void	initialize(SessionContext context)	Initialize this data map for the given context.
SessionData	load(String id)	Read in session data.
void	store(String id, SessionData data)	Store the session data.

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

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Method Details

initialize

void initialize(SessionContext context)
         throws Exception

Initialize this data map for the given context. A SessionDataMap can only be used by one context(/session manager).

Parameters:

context - context associated

Throws:

Exception - if unable to initialize the

load

SessionData load(String id)
          throws Exception

Read in session data.

Parameters:

id - identity of session to load

Returns:

the SessionData matching the id

Throws:

Exception - if unable to load session data

store

void store(String id,
 SessionData data)
    throws Exception

Store the session data.

Parameters:

id - identity of session to store

data - info of session to store

Throws:

Exception - if unable to write session data

delete

boolean delete(String id)
        throws Exception

Delete session data

Parameters:

id - identity of session to delete

Returns:

true if the session was deleted

Throws:

Exception - if unable to delete session data