Package org.eclipse.jetty.server

Interface SessionIdManager

All Superinterfaces:

org.eclipse.jetty.util.component.LifeCycle

All Known Implementing Classes:

AbstractSessionIdManager, HashSessionIdManager, JDBCSessionIdManager

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

Session ID Manager. Manages session IDs across multiple contexts.

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
void	addSession(javax.servlet.http.HttpSession session)	Add a session to the list of known sessions for a given ID.
java.lang.String	getClusterId(java.lang.String nodeId)	Get a cluster ID from a node ID.
java.lang.String	getNodeId(java.lang.String clusterId, javax.servlet.http.HttpServletRequest request)	Get a node ID from a cluster ID and a request
java.lang.String	getWorkerName()
boolean	idInUse(java.lang.String id)
void	invalidateAll(java.lang.String id)	Call HttpSession.invalidate() on all known sessions for the given id.
java.lang.String	newSessionId(javax.servlet.http.HttpServletRequest request, long created)	Create a new Session ID.
void	removeSession(javax.servlet.http.HttpSession session)	Remove session from the list of known sessions for a given ID.
void	renewSessionId(java.lang.String oldClusterId, java.lang.String oldNodeId, javax.servlet.http.HttpServletRequest request)	Change the existing session id.

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

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Method Detail

idInUse

boolean idInUse(java.lang.String id)

Parameters:

id - The session ID without any cluster node extension

Returns:

True if the session ID is in use by at least one context.

addSession

void addSession(javax.servlet.http.HttpSession session)

Add a session to the list of known sessions for a given ID.

Parameters:

session - The session

removeSession

void removeSession(javax.servlet.http.HttpSession session)

Remove session from the list of known sessions for a given ID.

Parameters:

session - the session to remove

invalidateAll

void invalidateAll(java.lang.String id)

Call HttpSession.invalidate() on all known sessions for the given id.

Parameters:

id - The session ID without any cluster node extension

newSessionId

java.lang.String newSessionId(javax.servlet.http.HttpServletRequest request,
                              long created)

Create a new Session ID.

Parameters:

request - the request with the sesion

created - the timestamp for when the session was created

Returns:

the new session id

getWorkerName

java.lang.String getWorkerName()

getClusterId

java.lang.String getClusterId(java.lang.String nodeId)

Get a cluster ID from a node ID. Strip node identifier from a located session ID.

Parameters:

nodeId - the node id

Returns:

the cluster id

getNodeId

java.lang.String getNodeId(java.lang.String clusterId,
                           javax.servlet.http.HttpServletRequest request)

Get a node ID from a cluster ID and a request

Parameters:

clusterId - The ID of the session

request - The request that for the session (or null)

Returns:

The session ID qualified with the node ID.

renewSessionId

void renewSessionId(java.lang.String oldClusterId,
                    java.lang.String oldNodeId,
                    javax.servlet.http.HttpServletRequest request)

Change the existing session id.

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

request - the request containing the session