Package com.helger.web.scope.mgr

Class WebScopeSessionManager

java.lang.Object

com.helger.web.scope.mgr.WebScopeSessionManager

@Immutable
public final class WebScopeSessionManager
extends Object

This is a specialization of ScopeSessionManager for web scopes.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static void	destroyAllWebSessions()	Destroy all available web scopes.
static com.helger.commons.collection.impl.ICommonsCollection<ISessionWebScope>	getAllSessionWebScopes()
static ISessionWebScope	getSessionWebScopeOfID(String sScopeID)	Get the web session scope with the specified ID.
static ISessionWebScope	getSessionWebScopeOfSession(jakarta.servlet.http.HttpSession aHttpSession)	Get the session web scope of the passed HTTP session.

Methods inherited from class java.lang.Object

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

Method Detail

getSessionWebScopeOfID

@Nullable
public static ISessionWebScope getSessionWebScopeOfID(@Nullable
                                                      String sScopeID)

Get the web session scope with the specified ID. If no such scope exists, null is returned.

Parameters:

sScopeID - The ID to be resolved.

Returns:

null if no such scope exists or if the passed scope is not a session web scopes.

getSessionWebScopeOfSession

@Nullable
public static ISessionWebScope getSessionWebScopeOfSession(@Nullable
                                                           jakarta.servlet.http.HttpSession aHttpSession)

Get the session web scope of the passed HTTP session.

Parameters:

aHttpSession - The HTTP session to get the scope from. May be null.

Returns:

null if either the HTTP session is null or if no such scope exists.

getAllSessionWebScopes

@Nonnull
@ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsCollection<ISessionWebScope> getAllSessionWebScopes()

Returns:

A non-null, mutable copy of all managed session web scopes.

destroyAllWebSessions

public static void destroyAllWebSessions()

Destroy all available web scopes.