org.wildfly.clustering.web.session

Interface SessionManager<L,B extends Batch>

All Superinterfaces:

IdentifierFactory<String>

public interface SessionManager<L,B extends Batch>
extends IdentifierFactory<String>

Method Summary

Modifier and Type	Method and Description
boolean	containsSession(String id) Indicates whether or not the session with the specified identifier is known to this session manager.
Session<L>	createSession(String id) Returns the session with the specified identifier, creating one if necessary Sessions returned by this method must be closed via Session.close().
Session<L>	findSession(String id) Returns the session with the specified identifier, or null if none exists.
Set<String>	getActiveSessions() Returns the identifiers of those sessions that are active on this node.
Batcher<B>	getBatcher() Exposes the batching mechanism used by this session manager.
long	getDefaultMaxInactiveInterval(TimeUnit unit) Returns the default maximum inactive interval, using the specified unit, for all sessions created by this session manager.
Set<String>	getLocalSessions() Returns the identifiers of all sessions on this node, including both active and passive sessions.
void	setDefaultMaxInactiveInterval(long value, TimeUnit unit) Set the default maximum inactive interval, using the specified unit, for all sessions created by this session manager.
ImmutableSession	viewSession(String id) Returns a read-only view of the session with the specified identifier.

Methods inherited from interface org.wildfly.clustering.web.IdentifierFactory

createIdentifier, start, stop

Method Detail

containsSession

boolean containsSession(String id)

Indicates whether or not the session with the specified identifier is known to this session manager.

Parameters:

id - a unique session identifier

Returns:

true, if the session is known to the manager, false otherwise

findSession

Session<L> findSession(String id)

Returns the session with the specified identifier, or null if none exists. Sessions returned by this method must be closed via Session.close(). This method is intended to be invoked within the context of a batch.

Parameters:

id - a session identifier

Returns:

an existing web session, or null if none exists

createSession

Session<L> createSession(String id)

Returns the session with the specified identifier, creating one if necessary Sessions returned by this method must be closed via Session.close(). This method is intended to be invoked within the context of a batch.

Parameters:

id - a session identifier

Returns:

a new or existing web session

getDefaultMaxInactiveInterval

long getDefaultMaxInactiveInterval(TimeUnit unit)

Returns the default maximum inactive interval, using the specified unit, for all sessions created by this session manager.

Parameters:

unit - a time unit

Returns:

a time interval

setDefaultMaxInactiveInterval

void setDefaultMaxInactiveInterval(long value,
                                   TimeUnit unit)

Set the default maximum inactive interval, using the specified unit, for all sessions created by this session manager.

Parameters:

unit - a time unit

getBatcher

Batcher<B> getBatcher()

Exposes the batching mechanism used by this session manager.

Returns:

a batcher.

getActiveSessions

Set<String> getActiveSessions()

Returns the identifiers of those sessions that are active on this node.

Returns:

a set of session identifiers.

getLocalSessions

Set<String> getLocalSessions()

Returns the identifiers of all sessions on this node, including both active and passive sessions.

Returns:

a set of session identifiers.

viewSession

ImmutableSession viewSession(String id)

Returns a read-only view of the session with the specified identifier. This method is intended to be invoked within the context of a batch

Parameters:

id - a unique session identifier

Returns:

a read-only session or null if none exists