com.helger.commons.scopes.mgr

Class ScopeSessionManager

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.GlobalSingleton

com.helger.commons.scopes.mgr.ScopeSessionManager

All Implemented Interfaces:

IScopeDestructionAware

@ThreadSafe
public class ScopeSessionManager
extends GlobalSingleton

Internal manager class for session scopes.
This class is only non-final so that the WebScopeSessionManager can be used for web scopes!

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DESTROY_ALL_SESSIONS_ON_SCOPE_END
static boolean	DEFAULT_END_ALL_SESSIONS_ON_SCOPE_END

Constructor Summary

Constructors

Constructor and Description
ScopeSessionManager() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAnySession()
void	destroyAllSessions() Destroy all known session scopes.
Collection<? extends ISessionScope>	getAllSessionScopes()
static ScopeSessionManager	getInstance()
int	getSessionCount()
ISessionScope	getSessionScopeOfID(String sScopeID) Get the session scope with the specified ID.
boolean	isDestroyAllSessionsOnScopeEnd()
boolean	isEndAllSessionsOnScopeEnd()
protected void	onDestroy(IScope aScopeInDestruction) Called when this singleton is destroyed.
void	onScopeBegin(ISessionScope aSessionScope) Register the passed session scope in the internal map, call the #initScope() method and finally invoke the SPIs for the new scope.
void	onScopeEnd(ISessionScope aSessionScope) Close the passed session scope gracefully.
EChange	setDestroyAllSessionsOnScopeEnd(boolean bDestroyAllSessionsOnScopeEnd)
EChange	setEndAllSessionsOnScopeEnd(boolean bEndAllSessionsOnScopeEnd)

Methods inherited from class com.helger.commons.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DESTROY_ALL_SESSIONS_ON_SCOPE_END

public static final boolean DEFAULT_DESTROY_ALL_SESSIONS_ON_SCOPE_END

See Also:

Constant Field Values

DEFAULT_END_ALL_SESSIONS_ON_SCOPE_END

public static final boolean DEFAULT_END_ALL_SESSIONS_ON_SCOPE_END

See Also:

Constant Field Values

Constructor Detail

ScopeSessionManager

@Deprecated
@UsedViaReflection
public ScopeSessionManager()

Deprecated.

Method Detail

getInstance

@Nonnull
public static ScopeSessionManager getInstance()

getSessionScopeOfID

@Nullable
public ISessionScope getSessionScopeOfID(@Nullable
                                         String sScopeID)

Get the session scope with the specified ID. If no such scope exists, no further actions are taken.

Parameters:

sScopeID - The ID to be resolved. May be null.

Returns:

null if no such scope exists.

onScopeBegin

public void onScopeBegin(@Nonnull
                ISessionScope aSessionScope)

Register the passed session scope in the internal map, call the #initScope() method and finally invoke the SPIs for the new scope.

Parameters:

aSessionScope - The session scope that was just created. May not be null.

onScopeEnd

public void onScopeEnd(@Nonnull
              ISessionScope aSessionScope)

Close the passed session scope gracefully. Each managed scope is guaranteed to be destroyed only once. First the SPI manager is invoked, and afterwards the scope is destroyed.

Parameters:

aSessionScope - The session scope to be ended. May not be null.

containsAnySession

public boolean containsAnySession()

Returns:

true if at least one session is present, false otherwise

getSessionCount

@Nonnegative
public int getSessionCount()

Returns:

The number of managed session scopes. Always ≥ 0.

getAllSessionScopes

@Nonnull
@ReturnsMutableCopy
public Collection<? extends ISessionScope> getAllSessionScopes()

Returns:

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

destroyAllSessions

public void destroyAllSessions()

Destroy all known session scopes. After this method it is ensured that the internal session map is empty.

isDestroyAllSessionsOnScopeEnd

public boolean isDestroyAllSessionsOnScopeEnd()

setDestroyAllSessionsOnScopeEnd

@Nonnull
public EChange setDestroyAllSessionsOnScopeEnd(boolean bDestroyAllSessionsOnScopeEnd)

isEndAllSessionsOnScopeEnd

public boolean isEndAllSessionsOnScopeEnd()

setEndAllSessionsOnScopeEnd

@Nonnull
public EChange setEndAllSessionsOnScopeEnd(boolean bEndAllSessionsOnScopeEnd)

onDestroy

protected void onDestroy(@Nonnull
             IScope aScopeInDestruction)

Description copied from class: AbstractSingleton

Called when this singleton is destroyed. Perform all cleanup in this method. This method is called when "inDestruction" is true and "isDestroyed" is false.

Overrides:

onDestroy in class AbstractSingleton

Parameters:

aScopeInDestruction - The scope in destruction. Never null.