io.undertow.server.session

Class InMemorySessionManager

java.lang.Object

io.undertow.server.session.InMemorySessionManager

All Implemented Interfaces:

SessionManager

public class InMemorySessionManager
extends Object
implements SessionManager

The default in memory session manager. This basically just stores sessions in an in memory hash map.

Author:

Stuart Douglas

Field Summary

Fields inherited from interface io.undertow.server.session.SessionManager

ATTACHMENT_KEY

Constructor Summary

Constructors

Constructor and Description
InMemorySessionManager()

Method Summary

Methods

Modifier and Type	Method and Description
Session	createSession(HttpServerExchange serverExchange, SessionConfig config) Creates a new session.
Set<String>	getActiveSessions() Returns the identifiers of those sessions that are active on this node, excluding passivated sessions
Set<String>	getAllSessions() Returns the identifiers of all sessions, including both active and passive
Session	getSession(HttpServerExchange serverExchange, SessionConfig config)
Session	getSession(String sessionId) Retrieves a session with the given session id
Set<String>	getTransientSessions() Returns the identifiers of those sessions that would be lost upon shutdown of this node
void	registerSessionListener(SessionListener listener) Registers a session listener for the session manager
void	removeSessionListener(SessionListener listener) Removes a session listener from the session manager
void	setDefaultSessionTimeout(int timeout) Sets the default session timeout
void	start() Starts the session manager
void	stop() stops the session manager

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemorySessionManager

public InMemorySessionManager()

Method Detail

start

public void start()

Description copied from interface: SessionManager

Starts the session manager

Specified by:

start in interface SessionManager

stop

public void stop()

Description copied from interface: SessionManager

stops the session manager

Specified by:

stop in interface SessionManager

createSession

public Session createSession(HttpServerExchange serverExchange,
                    SessionConfig config)

Description copied from interface: SessionManager

Creates a new session. Any SessionListeners registered with this manager will be notified of the session creation.

This method *MUST* call SessionConfig.findSessionId(io.undertow.server.HttpServerExchange) (io.undertow.server.HttpServerExchange)} first to determine if an existing session ID is present in the exchange. If this id is present then it must be used as the new session ID. If a session with this ID already exists then an IllegalStateException must be thrown.

This requirement exists to allow forwards across servlet contexts to work correctly.

Specified by:

createSession in interface SessionManager

Returns:

The created session

getSession

public Session getSession(HttpServerExchange serverExchange,
                 SessionConfig config)

Specified by:

getSession in interface SessionManager

Returns:

An IoFuture that can be used to retrieve the session, or an IoFuture that will return null if not found

getSession

public Session getSession(String sessionId)

Description copied from interface: SessionManager

Retrieves a session with the given session id

Specified by:

getSession in interface SessionManager

Parameters:

sessionId - The session ID

Returns:

The session, or null if it does not exist

registerSessionListener

public void registerSessionListener(SessionListener listener)

Description copied from interface: SessionManager

Registers a session listener for the session manager

Specified by:

registerSessionListener in interface SessionManager

Parameters:

listener - The listener

removeSessionListener

public void removeSessionListener(SessionListener listener)

Description copied from interface: SessionManager

Removes a session listener from the session manager

Specified by:

removeSessionListener in interface SessionManager

Parameters:

listener - the listener

setDefaultSessionTimeout

public void setDefaultSessionTimeout(int timeout)

Description copied from interface: SessionManager

Sets the default session timeout

Specified by:

setDefaultSessionTimeout in interface SessionManager

Parameters:

timeout - the timeout

getTransientSessions

public Set<String> getTransientSessions()

Description copied from interface: SessionManager

Returns the identifiers of those sessions that would be lost upon shutdown of this node

Specified by:

getTransientSessions in interface SessionManager

getActiveSessions

public Set<String> getActiveSessions()

Description copied from interface: SessionManager

Returns the identifiers of those sessions that are active on this node, excluding passivated sessions

Specified by:

getActiveSessions in interface SessionManager

getAllSessions

public Set<String> getAllSessions()

Description copied from interface: SessionManager

Returns the identifiers of all sessions, including both active and passive

Specified by:

getAllSessions in interface SessionManager