com.hazelcast.session

Class HazelcastSessionIdManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.AbstractSessionIdManager

com.hazelcast.session.HazelcastSessionIdManager

All Implemented Interfaces:

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

public class HazelcastSessionIdManager
extends org.eclipse.jetty.server.session.AbstractSessionIdManager

A jetty instance can only have one session id manager. HazelcastSessionIdManager is responsible of creating Hazelcast instances (client/server/provided) to keep session data distributed and ensuring the cluster-wide unique session id generation. This manager can use Hazelcast in three different ways

• clientOnly If this attribute is set to true, then an hazelcast client instance is started
  See JettySessionUtils.createHazelcastClientInstance(String) for details
• clientOnly If this attribute is set to false (default behaviour), then a hazelcast instance is started
  See JettySessionUtils.createHazelcastFullInstance(String) for details
• A preconfigured HazelcastInstance can be provided in construction time
  See HazelcastSessionIdManager(org.eclipse.jetty.server.Server, com.hazelcast.core.HazelcastInstance)

Also, this class has a clean-up timer cleanUpTimer which is responsible of removing expired session data from session map.

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 and Description
protected org.eclipse.jetty.server.Server	server
protected Set<String>	sessionsIds the (local) collection of session ids known to this manager

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

_random, _reseed, _weakRandom, _workerName

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

_listeners, FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
HazelcastSessionIdManager(org.eclipse.jetty.server.Server server) Creates a session manager with defaults
HazelcastSessionIdManager(org.eclipse.jetty.server.Server server, boolean clientOnly)
HazelcastSessionIdManager(org.eclipse.jetty.server.Server server, boolean clientOnly, String configLocation)
HazelcastSessionIdManager(org.eclipse.jetty.server.Server server, com.hazelcast.core.HazelcastInstance instance)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSession(javax.servlet.http.HttpSession session) Add session id to known local ids
protected void	cleanUp() Clean is a process that cleans the Hazelcast cluster of old sessions that are no longer valid.
protected void	doStart()
protected void	doStop()
String	getClusterId(String nodeId) Get the session ID without any worker ID.
String	getConfigLocation()
String	getNodeId(String clusterId, javax.servlet.http.HttpServletRequest request) Get the session ID with any worker ID.
com.hazelcast.core.IMap<String,HazelcastSessionData>	getSessions()
boolean	idInUse(String sessionId) is the session id known to hazelcast, and is it valid
void	invalidateAll(String sessionId)
void	removeSession(javax.servlet.http.HttpSession session) Remove session from known local ids
void	setCleanUp(boolean cleanUp)
void	setCleanUpInvalidAge(long cleanUpInvalidAge)
void	setCleanUpPeriod(long cleanUpPeriod)
void	setClientOnly(boolean clientOnly)
void	setConfigLocation(String configLocation)
void	setInstance(com.hazelcast.core.HazelcastInstance instance)

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

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

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

addLifeCycleListener, getState, getState, 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.util.component.LifeCycle

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

Field Detail

server

protected final org.eclipse.jetty.server.Server server

sessionsIds

protected final Set<String> sessionsIds

the (local) collection of session ids known to this manager

Constructor Detail

HazelcastSessionIdManager

public HazelcastSessionIdManager(org.eclipse.jetty.server.Server server)

Creates a session manager with defaults

HazelcastSessionIdManager

public HazelcastSessionIdManager(org.eclipse.jetty.server.Server server,
                         boolean clientOnly)

HazelcastSessionIdManager

public HazelcastSessionIdManager(org.eclipse.jetty.server.Server server,
                         boolean clientOnly,
                         String configLocation)

HazelcastSessionIdManager

public HazelcastSessionIdManager(org.eclipse.jetty.server.Server server,
                         com.hazelcast.core.HazelcastInstance instance)

Method Detail

idInUse

public boolean idInUse(String sessionId)

is the session id known to hazelcast, and is it valid

addSession

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

Add session id to known local ids

removeSession

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

Remove session from known local ids

Parameters:

session -

invalidateAll

public void invalidateAll(String sessionId)

getNodeId

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

Get the session ID with any worker ID.

Parameters:

clusterId -

request -

Returns:

sessionId plus any worker ID.

getClusterId

public String getClusterId(String nodeId)

Get the session ID without any worker ID.

Parameters:

nodeId - the node id

Returns:

sessionId without any worker ID.

cleanUp

protected void cleanUp()

Clean is a process that cleans the Hazelcast cluster of old sessions that are no longer valid. There are two checks being done here: - if the accessed time is older then the current time minus the cleanup invalid age and it is no longer valid then remove that session NOTE: if your system supports long lived sessions then the cleanup invalid age should be set to zero so the check is skipped.

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.eclipse.jetty.server.session.AbstractSessionIdManager

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.eclipse.jetty.server.session.AbstractSessionIdManager

Throws:

Exception

getConfigLocation

public String getConfigLocation()

setConfigLocation

public void setConfigLocation(String configLocation)

setInstance

public void setInstance(com.hazelcast.core.HazelcastInstance instance)

setClientOnly

public void setClientOnly(boolean clientOnly)

getSessions

public com.hazelcast.core.IMap<String,HazelcastSessionData> getSessions()

setCleanUp

public void setCleanUp(boolean cleanUp)

setCleanUpInvalidAge

public void setCleanUpInvalidAge(long cleanUpInvalidAge)

setCleanUpPeriod

public void setCleanUpPeriod(long cleanUpPeriod)