Package org.jgrapes.http

Class InMemorySessionManager

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.http.SessionManager

org.jgrapes.http.InMemorySessionManager

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class InMemorySessionManager
extends SessionManager

A in memory session manager.

Nested Class Summary

Nested classes/interfaces inherited from class org.jgrapes.http.SessionManager

SessionManager.SessionManagerInfo, SessionManager.SessionManagerMXBean, SessionManager.SessionManagerSummaryMXBean

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
InMemorySessionManager()	Creates a new session manager with its channel set to itself and the path set to “/”.
InMemorySessionManager(String path)	Creates a new session manager with its channel set to itself and the path set to the given path.
InMemorySessionManager(Channel componentChannel)	Creates a new session manager with its channel set to the given channel and the path to “/”.
InMemorySessionManager(Channel componentChannel, String path)	Creates a new session manager with the given channel and path.
InMemorySessionManager(Channel componentChannel, String pattern, int priority, String path)	Creates a new session manager using the given channel and path.

Method Summary

Modifier and Type	Method	Description
protected Session	createSession(String sessionId)	Creates a new session with the given id.
protected Optional<Session>	lookupSession(String sessionId)	Lookup the session with the given id.
protected void	removeSession(String sessionId)	Removes the given session from the cache.
protected int	sessionCount()	Return the number of established sessions.
protected Optional<Instant>	startDiscarding(long absoluteTimeout, long idleTimeout)	Start discarding all sessions (generate DiscardSession events) that have reached their absolute or idle timeout.

Methods inherited from class org.jgrapes.http.SessionManager

absoluteTimeout, addSessionCookie, derivePattern, hasTimedOut, idleTimeout, idName, maxSessions, onDiscard, onProtocolSwitchAccepted, onRequest, path, setAbsoluteTimeout, setIdleTimeout, setIdName, setMaxSessions, setSessionSupplier

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

InMemorySessionManager

public InMemorySessionManager()

Creates a new session manager with its channel set to itself and the path set to “/”.

The manager handles all Request events.

InMemorySessionManager

public InMemorySessionManager(String path)

Creates a new session manager with its channel set to itself and the path set to the given path.

The manager handles all requests that match the given path, using the same rules as browsers do for selecting the cookies that are to be sent.

Parameters:

path - the path

InMemorySessionManager

public InMemorySessionManager(Channel componentChannel)

Creates a new session manager with its channel set to the given channel and the path to “/”.

The manager handles all Request events.

Parameters:

componentChannel - the component channel

InMemorySessionManager

public InMemorySessionManager(Channel componentChannel,
 String path)

Creates a new session manager with the given channel and path.

The manager handles all requests that match the given path, using the same rules as browsers do for selecting the cookies that are to be sent.

Parameters:

componentChannel - the component channel

path - the path

InMemorySessionManager

public InMemorySessionManager(Channel componentChannel,
 String pattern,
 int priority,
 String path)

Creates a new session manager using the given channel and path.

The manager handles only requests that match the given pattern. The Request handler is registered with the given priority.

This constructor can be used if special handling of top level requests is needed.

Parameters:

componentChannel - the component channel

pattern - the path part of a ResourcePattern

priority - the priority

path - the path

Method Details

startDiscarding

protected Optional<Instant> startDiscarding(long absoluteTimeout,
 long idleTimeout)

Description copied from class: SessionManager

Start discarding all sessions (generate DiscardSession events) that have reached their absolute or idle timeout.

Do not make the sessions unavailable yet.

Returns the time when the next timeout occurs. This method is called only if at least one of the timeouts has been specified.

Implementations have to take care that sessions are only discarded once. As they must remain available while the DiscardSession event is handled this may require marking them as being discarded.

Specified by:

startDiscarding in class SessionManager

Parameters:

absoluteTimeout - the absolute timeout

idleTimeout - the idle timeout

Returns:

the next timeout (empty if no sessions left)

createSession

protected Session createSession(String sessionId)

Description copied from class: SessionManager

Creates a new session with the given id.

Specified by:

createSession in class SessionManager

Returns:

the session

lookupSession

protected Optional<Session> lookupSession(String sessionId)

Description copied from class: SessionManager

Lookup the session with the given id.

Lookup will fail if the session has timed out.

Specified by:

lookupSession in class SessionManager

Returns:

the session

removeSession

protected void removeSession(String sessionId)

Description copied from class: SessionManager

Removes the given session from the cache.

Specified by:

removeSession in class SessionManager

Parameters:

sessionId - the session id

sessionCount

protected int sessionCount()

Description copied from class: SessionManager

Return the number of established sessions.

Specified by:

sessionCount in class SessionManager

Returns:

the result