com.helger.commons.scope

Interface ISessionScope

All Superinterfaces:

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

All Known Implementing Classes:

SessionScope

public interface ISessionScope
extends IScope

Interface for a single session scope object.

Author:

Philip Helger

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.
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	restoreSessionApplicationScope(String sScopeID, ISessionApplicationScope aScope) Restore a persisted session application scope
EContinue	selfDestruct() A special internal method that destroys the session.

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

destroyScope, getAllScopeRenewalAwareAttributes, getID, initScope, 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

Method Detail

selfDestruct

@Nonnull
EContinue selfDestruct()

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.

Returns:

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

createApplicationScopeID

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

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

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
String getApplicationIDFromApplicationScopeID(@Nullable
                                                         String sApplicationScopeID)

Extract the application ID from an application scope ID.

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

getSessionApplicationScope

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

Create an application specific scope within the session.

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

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

Restore a persisted session application scope

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
Map<String,ISessionApplicationScope> getAllSessionApplicationScopes()

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
int getSessionApplicationScopeCount()

Returns:

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