com.helger.commons.scope

Class SessionScope

java.lang.Object

com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedAttributeContainer<KEYTYPE,Object>

com.helger.commons.collection.attr.MapBasedAttributeContainerAny<String>

com.helger.commons.scope.AbstractMapBasedScope

com.helger.commons.scope.SessionScope

All Implemented Interfaces:

IAttributeContainer<String,Object>, IMutableAttributeContainer<String,Object>, IMutableAttributeContainerAny<String>, IHasID<String>, ICloneable<MapBasedAttributeContainer<String,Object>>, IScope, ISessionScope, IClearable, Serializable

@ThreadSafe
public class SessionScope
extends AbstractMapBasedScope
implements ISessionScope

Default implementation of the ISessionScope interface

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.commons.scope.AbstractMapBasedScope

m_aRWLock

Fields inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

m_aAttrs

Constructor Summary

Constructors

Constructor and Description
SessionScope(String sScopeID)

Method Summary

Modifier and Type	Method and Description
String	createApplicationScopeID(String sApplicationID) Create the unique ID, under which a session application scope will be created within this scope.
protected ISessionApplicationScope	createSessionApplicationScope(String sApplicationID)
protected void	destroyOwnedScopes() Override this method to destroy all scopes owned by this scope.
Map<String,ISessionApplicationScope>	getAllSessionApplicationScopes()
String	getApplicationIDFromApplicationScopeID(String sApplicationScopeID) Extract the application ID from an application scope ID.
ISessionApplicationScope	getSessionApplicationScope(String sApplicationID, boolean bCreateIfNotExisting) Create an application specific scope within the session.
int	getSessionApplicationScopeCount()
void	initScope() Init the scope.
protected void	postDestroy() Override this method to perform further actions AFTER the scope was destroyed.
protected void	preDestroy() Override this method to perform further actions BEFORE the scope is destroyed.
void	restoreSessionApplicationScope(String sScopeID, ISessionApplicationScope aScope) Restore a persisted session application scope
EContinue	selfDestruct() A special internal method that destroys the session.
String	toString()

Methods inherited from class com.helger.commons.scope.AbstractMapBasedScope

destroyScope, equals, getAllScopeRenewalAwareAttributes, getID, hashCode, isDestroyed, isInDestruction, isInPreDestruction, isValid, runAtomic, runAtomic

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainerAny

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainer

clear, onBeforeRemoveAllAttributes, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject, getIterator

Methods inherited from class com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.scope.IScope

destroyScope, getAllScopeRenewalAwareAttributes, getID, isDestroyed, isInDestruction, isValid, runAtomic, runAtomic

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainerAny

getAndSetAttributeFlag, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getIterator, getTypedAttribute, getTypedAttribute

Methods inherited from interface com.helger.commons.state.IClearable

clear

Constructor Detail

SessionScope

public SessionScope(@Nonnull @Nonempty
                    String sScopeID)

Method Detail

initScope

public void initScope()

Description copied from interface: IScope

Init the scope. In contrast to the constructor of a scope, this happens after the scope has been registered in the scope manager.

Specified by:

initScope in interface IScope

destroyOwnedScopes

protected final void destroyOwnedScopes()

Description copied from class: AbstractMapBasedScope

Override this method to destroy all scopes owned by this scope.

Overrides:

destroyOwnedScopes in class AbstractMapBasedScope

preDestroy

protected void preDestroy()

Description copied from class: AbstractMapBasedScope

Override this method to perform further actions BEFORE the scope is destroyed. The state is "in pre destruction".

Overrides:

preDestroy in class AbstractMapBasedScope

postDestroy

protected void postDestroy()

Description copied from class: AbstractMapBasedScope

Override this method to perform further actions AFTER the scope was destroyed. The state is "destroyed".

Overrides:

postDestroy in class AbstractMapBasedScope

selfDestruct

@Nonnull
public EContinue selfDestruct()

Description copied from interface: ISessionScope

A special internal method that destroys the session. This is especially relevant for session web scope, because it is all done via the invalidation of the underlying HTTP session.

Specified by:

selfDestruct in interface ISessionScope

Returns:

EContinue.BREAK to indicate that the regular destruction should not be performed!

createApplicationScopeID

@Nonnull
 @Nonempty
public String createApplicationScopeID(@Nonnull @Nonempty
                                                             String sApplicationID)

Description copied from interface: ISessionScope

Create the unique ID, under which a session application scope will be created within this scope. The default implementation is getID () + "." + sApplicationID.

Specified by:

createApplicationScopeID in interface ISessionScope

Parameters:

sApplicationID - The application ID to be used. May neither be null nor empty.

Returns:

The application scope ID to be used.

See Also:

to get the application ID from an application scope ID (reverse operation)

getApplicationIDFromApplicationScopeID

@Nullable
public String getApplicationIDFromApplicationScopeID(@Nullable
                                                                String sApplicationScopeID)

Description copied from interface: ISessionScope

Extract the application ID from an application scope ID.

Specified by:

getApplicationIDFromApplicationScopeID in interface ISessionScope

Parameters:

sApplicationScopeID - The application scope ID to use. May be null.

Returns:

null if no application ID could be extracted

See Also:

To creation an application scope ID from an application ID

createSessionApplicationScope

@Nonnull
protected ISessionApplicationScope createSessionApplicationScope(@Nonnull @Nonempty
                                                                           String sApplicationID)

getSessionApplicationScope

@Nullable
public ISessionApplicationScope getSessionApplicationScope(@Nonnull @Nonempty
                                                                      String sApplicationID,
                                                                      boolean bCreateIfNotExisting)

Description copied from interface: ISessionScope

Create an application specific scope within the session.

Specified by:

getSessionApplicationScope in interface ISessionScope

Parameters:

sApplicationID - The application ID to use. May not be null.

bCreateIfNotExisting - Create the session application scope if does not yet exist. If false and the scope does not exist than null is returned.

Returns:

null if bCreateIfNotExisting is false and the scope is not present

restoreSessionApplicationScope

public void restoreSessionApplicationScope(@Nonnull @Nonempty
                                           String sScopeID,
                                           @Nonnull
                                           ISessionApplicationScope aScope)

Description copied from interface: ISessionScope

Restore a persisted session application scope

Specified by:

restoreSessionApplicationScope in interface ISessionScope

Parameters:

sScopeID - The ID of the restored application scope. May neither be null nor empty.

aScope - The scope to be restored. May not be null.

getAllSessionApplicationScopes

@Nonnull
 @ReturnsMutableCopy
public Map<String,ISessionApplicationScope> getAllSessionApplicationScopes()

Specified by:

getAllSessionApplicationScopes in interface ISessionScope

Returns:

A non-null map with all available session application scopes. The key is the application ID and the value is the scope.

getSessionApplicationScopeCount

@Nonnegative
public int getSessionApplicationScopeCount()

Specified by:

getSessionApplicationScopeCount in interface ISessionScope

Returns:

The number of contained session application scopes. Always ≥ 0.

toString

public String toString()

Overrides:

toString in class AbstractMapBasedScope