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

Direct Known Subclasses:

HashSessionIdManager, JDBCSessionIdManager, MongoSessionIdManager

public abstract class AbstractSessionIdManager
extends AbstractLifeCycle
implements SessionIdManager

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
protected Random	_random
protected long	_reseed
protected boolean	_weakRandom
protected String	_workerAttr
protected String	_workerName

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
AbstractSessionIdManager()
AbstractSessionIdManager(Random random)

Method Summary

Methods

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

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.server.SessionIdManager

addSession, idInUse, invalidateAll, removeSession

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

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

Field Detail

_random

protected Random _random

_weakRandom

protected boolean _weakRandom

_workerName

protected String _workerName

_workerAttr

protected String _workerAttr

_reseed

protected long _reseed

Constructor Detail

AbstractSessionIdManager

public AbstractSessionIdManager()

AbstractSessionIdManager

public AbstractSessionIdManager(Random random)

Method Detail

getWorkerName

public 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(String workerName)

Set 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. 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 customiser.

Parameters:

workerName -

getRandom

public Random getRandom()

setRandom

public void setRandom(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 String newSessionId(HttpServletRequest request,
                  long created)

Create a new session id if necessary.

Specified by:

newSessionId in interface SessionIdManager

Returns:

the new session id

See Also:

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

newSessionId

public String newSessionId(long seedTerm)

renewSessionId

public abstract void renewSessionId(String oldClusterId,
                  String oldNodeId,
                  HttpServletRequest request)

Description copied from interface: SessionIdManager

Change the existing session id.

Specified by:

renewSessionId in interface SessionIdManager

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

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 String getNodeId(String clusterId,
               HttpServletRequest request)

Get the session ID with any worker ID.

Specified by:

getNodeId in interface SessionIdManager

Parameters:

clusterId -

request -

Returns:

sessionId plus any worker ID.

getClusterId

public String getClusterId(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.