Package org.eclipse.jetty.server.session

Class AbstractSessionIdManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.AbstractSessionIdManager

All Implemented Interfaces:

SessionIdManager, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

HashSessionIdManager, JDBCSessionIdManager

public abstract class AbstractSessionIdManager
extends org.eclipse.jetty.util.component.AbstractLifeCycle
implements SessionIdManager

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.LifeCycle

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

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Random	_random
protected long	_reseed
protected boolean	_weakRandom
protected java.lang.String	_workerAttr
protected java.lang.String	_workerName

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractSessionIdManager()
AbstractSessionIdManager(java.util.Random random)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()
protected void	doStop()
java.lang.String	getClusterId(java.lang.String nodeId)	Get the session ID without any worker ID.
java.lang.String	getNodeId(java.lang.String clusterId, javax.servlet.http.HttpServletRequest request)	Get the session ID with any worker ID.
java.util.Random	getRandom()
long	getReseed()
java.lang.String	getWorkerName()	Get the workname.
void	initRandom()	Set up a random number generator for the sessionids.
java.lang.String	newSessionId(long seedTerm)
java.lang.String	newSessionId(javax.servlet.http.HttpServletRequest request, long created)	Create a new session id if necessary.
abstract void	renewSessionId(java.lang.String oldClusterId, java.lang.String oldNodeId, javax.servlet.http.HttpServletRequest request)	Change the existing session id.
void	setRandom(java.util.Random random)
void	setReseed(long reseed)	Set the reseed probability.
void	setWorkerName(java.lang.String workerName)	Set the workername.

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 interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, 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.server.SessionIdManager

addSession, idInUse, invalidateAll, removeSession

Field Detail

_random

protected java.util.Random _random

_weakRandom

protected boolean _weakRandom

_workerName

protected java.lang.String _workerName

_workerAttr

protected java.lang.String _workerAttr

_reseed

protected long _reseed

Constructor Detail

AbstractSessionIdManager

public AbstractSessionIdManager()

AbstractSessionIdManager

public AbstractSessionIdManager(java.util.Random random)

Method Detail

getWorkerName

public java.lang.String getWorkerName()

Get the workname. If set, the workername is dot appended to the session ID and can be used to assist session affinity in a load balancer.

Specified by:

getWorkerName in interface SessionIdManager

Returns:

String or null

setWorkerName

public void setWorkerName(java.lang.String workerName)

Set the workername. If set, the workername is dot appended to the session ID and can be used to assist session affinity in a load balancer. A worker name starting with $ is used as a request attribute name to lookup the worker name that can be dynamically set by a request Customizer.

Parameters:

workerName - the name of the worker

getRandom

public java.util.Random getRandom()

setRandom

public void setRandom(java.util.Random random)

getReseed

public long getReseed()

Returns:

the reseed probability

setReseed

public void setReseed(long reseed)

Set the reseed probability.

Parameters:

reseed - If non zero then when a random long modulo the reseed value == 1, the SecureRandom will be reseeded.

newSessionId

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

Create a new session id if necessary.

Specified by:

newSessionId in interface SessionIdManager

Parameters:

request - the request with the sesion

created - the timestamp for when the session was created

Returns:

the new session id

See Also:

SessionIdManager.newSessionId(javax.servlet.http.HttpServletRequest, long)

newSessionId

public java.lang.String newSessionId(long seedTerm)

renewSessionId

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

Description copied from interface: SessionIdManager

Change the existing session id.

Specified by:

renewSessionId in interface SessionIdManager

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

request - the request containing the session

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.AbstractLifeCycle

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.AbstractLifeCycle

Throws:

java.lang.Exception

initRandom

public void initRandom()

Set up a random number generator for the sessionids. By preference, use a SecureRandom but allow to be injected.

getNodeId

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

Get the session ID with any worker ID.

Specified by:

getNodeId in interface SessionIdManager

Parameters:

clusterId - the cluster id

request - the request

Returns:

sessionId plus any worker ID.

getClusterId

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

Get the session ID without any worker ID.

Specified by:

getClusterId in interface SessionIdManager

Parameters:

nodeId - the node id

Returns:

sessionId without any worker ID.