org.eclipse.jetty.gcloud.session

Class GCloudSessionIdManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.AbstractSessionIdManager

org.eclipse.jetty.gcloud.session.GCloudSessionIdManager

All Implemented Interfaces:

SessionIdManager, LifeCycle

public class GCloudSessionIdManager
extends AbstractSessionIdManager

GCloudSessionIdManager

Nested Class Summary

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

AbstractLifeCycle.AbstractLifeCycleListener

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_IDLE_EXPIRY_MULTIPLE
static String	KIND

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

_random, _reseed, _weakRandom, _workerAttr, _workerName

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
GCloudSessionIdManager(Server server)
GCloudSessionIdManager(Server server, Random random)

Method Summary

Modifier and Type	Method and Description
void	addSession(javax.servlet.http.HttpSession session) Remember a new in-use session id.
protected void	delete(String id) Remove a session id from the cluster.
protected void	doStart() Start the id manager.
protected void	doStop() Stop the id manager
protected boolean	exists(String id) Ask the datastore if a particular id exists.
boolean	idInUse(String id) Check to see if the given session id is being used by a session in any context.
protected void	insert(String id) Put a session id into the cluster.
void	invalidateAll(String id) Remove a session id.
protected com.google.cloud.datastore.Key	makeKey(String id) Generate a unique key from the session id.
void	removeSession(javax.servlet.http.HttpSession session) Remove a session id from the list of in-use ids.
void	renewSessionId(String oldClusterId, String oldNodeId, javax.servlet.http.HttpServletRequest request) Change a session id.

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

getClusterId, getNodeId, getRandom, getReseed, getWorkerName, initRandom, newSessionId, newSessionId, setRandom, setReseed, setWorkerName

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

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

DEFAULT_IDLE_EXPIRY_MULTIPLE

public static final int DEFAULT_IDLE_EXPIRY_MULTIPLE

See Also:

Constant Field Values

KIND

public static final String KIND

See Also:

Constant Field Values

Constructor Detail

GCloudSessionIdManager

public GCloudSessionIdManager(Server server)

Parameters:

server -

GCloudSessionIdManager

public GCloudSessionIdManager(Server server,
                              Random random)

Parameters:

server -

random -

Method Detail

doStart

protected void doStart()
                throws Exception

Start the id manager.

Overrides:

doStart in class AbstractSessionIdManager

Throws:

Exception

See Also:

AbstractSessionIdManager.doStart()

doStop

protected void doStop()
               throws Exception

Stop the id manager

Overrides:

doStop in class AbstractSessionIdManager

Throws:

Exception

See Also:

AbstractSessionIdManager.doStop()

idInUse

public boolean idInUse(String id)

Check to see if the given session id is being used by a session in any context. This method will consult the cluster.

Parameters:

id - The session ID without any cluster node extension

Returns:

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

See Also:

SessionIdManager.idInUse(java.lang.String)

addSession

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

Remember a new in-use session id. This will save the in-use session id to the cluster.

Parameters:

session - The session

See Also:

SessionIdManager.addSession(javax.servlet.http.HttpSession)

removeSession

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

Remove a session id from the list of in-use ids. This will remvove the corresponding session id from the cluster.

Parameters:

session - the session to remove

See Also:

SessionIdManager.removeSession(javax.servlet.http.HttpSession)

invalidateAll

public void invalidateAll(String id)

Remove a session id. This compels all other contexts who have a session with the same id to also remove it.

Parameters:

id - The session ID without any cluster node extension

See Also:

SessionIdManager.invalidateAll(java.lang.String)

renewSessionId

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

Change a session id. Typically this occurs when a previously existing session has passed through authentication.

Specified by:

renewSessionId in interface SessionIdManager

Specified by:

renewSessionId in class AbstractSessionIdManager

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

request - the request containing the session

See Also:

AbstractSessionIdManager.renewSessionId(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

exists

protected boolean exists(String id)

Ask the datastore if a particular id exists.

Parameters:

id - the session id to check for existence

Returns:

true if a session with that id exists, false otherwise

insert

protected void insert(String id)

Put a session id into the cluster.

Parameters:

id - the id to mark as in use

delete

protected void delete(String id)

Remove a session id from the cluster.

Parameters:

id - the id to remove

makeKey

protected com.google.cloud.datastore.Key makeKey(String id)

Generate a unique key from the session id.

Parameters:

id - the id of the session

Returns:

a unique key for the session id