com.helger.commons.scope.mgr

Class ScopeManager

java.lang.Object

com.helger.commons.scope.mgr.ScopeManager

@ThreadSafe
public final class ScopeManager
extends Object

This is the manager class for non-web scope handling. The following scopes are supported:

• global
• application
• request
• session
• session application

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CREATE_SCOPE
static String	SCOPE_ATTRIBUTE_PREFIX_INTERNAL The prefix to be used for attribute names in any scope to indicate system internal attributes

Method Summary

Modifier and Type	Method and Description
static void	destroySessionScope(ISessionScope aSessionScope) Manually destroy the passed session scope.
static IApplicationScope	getApplicationScope() Get or create the current application scope using the application ID present in the request scope.
static IApplicationScope	getApplicationScope(boolean bCreateIfNotExisting) Get or create the current application scope using the application ID present in the request scope.
static IApplicationScope	getApplicationScope(String sApplicationID) Get or create an application scope.
static IApplicationScope	getApplicationScope(String sApplicationID, boolean bCreateIfNotExisting) Get or create an application scope.
static IGlobalScope	getGlobalScope()
static IGlobalScope	getGlobalScopeOrNull()
static String	getRequestApplicationID() Get the application ID associated to the current request scope
static String	getRequestApplicationID(IRequestScope aRequestScope) Get the application ID associated to the passed request scope
static IRequestScope	getRequestScope()
static IRequestScope	getRequestScopeOrNull()
static ISessionApplicationScope	getSessionApplicationScope()
static ISessionApplicationScope	getSessionApplicationScope(boolean bCreateIfNotExisting)
static ISessionApplicationScope	getSessionApplicationScope(String sApplicationID)
static ISessionApplicationScope	getSessionApplicationScope(String sApplicationID, boolean bCreateIfNotExisting)
static ISessionScope	getSessionScope() Get the current session scope, based on the current request scope.
static ISessionScope	getSessionScope(boolean bCreateIfNotExisting) Get the current session scope, based on the current request scope.
static boolean	isGlobalScopePresent()
static boolean	isInternalAttribute(String sAttributeName) Check if the passed attribute name is an internal attribute.
static boolean	isRequestScopePresent()
static IGlobalScope	onGlobalBegin(String sScopeID) This method is used to set the initial global scope.
static void	onGlobalEnd() To be called when the singleton global context is to be destroyed.
static IRequestScope	onRequestBegin(String sApplicationID, String sScopeID, String sSessionID)
static void	onRequestEnd() To be called after a request finished.
static void	setAndInitRequestScope(String sApplicationID, IRequestScope aRequestScope) This method is only to be called by this class and the web scope manager!
static void	setGlobalScope(IGlobalScope aGlobalScope) This method is only to be called by this class and the web scope manager!

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_ATTRIBUTE_PREFIX_INTERNAL

public static final String SCOPE_ATTRIBUTE_PREFIX_INTERNAL

The prefix to be used for attribute names in any scope to indicate system internal attributes

See Also:

Constant Field Values

DEFAULT_CREATE_SCOPE

public static final boolean DEFAULT_CREATE_SCOPE

See Also:

Constant Field Values

Method Detail

setGlobalScope

public static void setGlobalScope(@Nonnull
                                  IGlobalScope aGlobalScope)

This method is only to be called by this class and the web scope manager!

Parameters:

aGlobalScope - The scope to be set. May not be null.

onGlobalBegin

@Nonnull
public static IGlobalScope onGlobalBegin(@Nonnull @Nonempty
                                                   String sScopeID)

This method is used to set the initial global scope.

Parameters:

sScopeID - The scope ID to use

Returns:

The created global scope object. Never null.

getGlobalScopeOrNull

@Nullable
public static IGlobalScope getGlobalScopeOrNull()

isGlobalScopePresent

public static boolean isGlobalScopePresent()

getGlobalScope

@Nonnull
public static IGlobalScope getGlobalScope()

onGlobalEnd

public static void onGlobalEnd()

To be called when the singleton global context is to be destroyed.

getRequestApplicationID

@Nullable
public static String getRequestApplicationID(@Nonnull
                                                        IRequestScope aRequestScope)

Get the application ID associated to the passed request scope

Parameters:

aRequestScope - The request scope to use. May not be null.

Returns:

null if no application ID is present

getRequestApplicationID

@Nonnull
public static String getRequestApplicationID()

Get the application ID associated to the current request scope

Returns:

Never null

Throws:

IllegalStateException - if no application ID is present

getApplicationScope

@Nonnull
public static IApplicationScope getApplicationScope()

Get or create the current application scope using the application ID present in the request scope.

Returns:

Never null.

getApplicationScope

@Nullable
public static IApplicationScope getApplicationScope(boolean bCreateIfNotExisting)

Get or create the current application scope using the application ID present in the request scope.

Parameters:

bCreateIfNotExisting - if false an no application scope is present, none will be created

Returns:

null if bCreateIfNotExisting is false and no such scope is present

getApplicationScope

@Nonnull
public static IApplicationScope getApplicationScope(@Nonnull @Nonempty
                                                              String sApplicationID)

Get or create an application scope.

Parameters:

sApplicationID - The ID of the application scope be retrieved or created. May neither be null nor empty.

Returns:

Never null.

getApplicationScope

@Nullable
public static IApplicationScope getApplicationScope(@Nonnull @Nonempty
                                                               String sApplicationID,
                                                               boolean bCreateIfNotExisting)

Get or create an application scope.

Parameters:

sApplicationID - The ID of the application scope be retrieved or created. May neither be null nor empty.

bCreateIfNotExisting - if false an no application scope is present, none will be created

Returns:

null if bCreateIfNotExisting is false and no such scope is present

getSessionScope

@Nonnull
public static ISessionScope getSessionScope()

Get the current session scope, based on the current request scope.

Returns:

Never null.

Throws:

IllegalStateException - If no request scope is present or if the underlying request scope does not have a session ID.

getSessionScope

@Nullable
public static ISessionScope getSessionScope(boolean bCreateIfNotExisting)

Get the current session scope, based on the current request scope.

Parameters:

bCreateIfNotExisting - true to create a new scope, if none is present yet, false to return null if either no request scope or no session scope is present.

Returns:

null if bCreateIfNotExisting is false and either no request scope or no session scope is present, the ISessionScope otherwise.

Throws:

IllegalStateException - if bCreateIfNotExisting is true but no request scope is present. This exception is also thrown if the underlying request scope does not have a session ID.

destroySessionScope

public static void destroySessionScope(@Nonnull
                                       ISessionScope aSessionScope)

Manually destroy the passed session scope.

Parameters:

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

getSessionApplicationScope

@Nonnull
public static ISessionApplicationScope getSessionApplicationScope()

getSessionApplicationScope

@Nullable
public static ISessionApplicationScope getSessionApplicationScope(boolean bCreateIfNotExisting)

getSessionApplicationScope

@Nonnull
public static ISessionApplicationScope getSessionApplicationScope(@Nonnull @Nonempty
                                                                            String sApplicationID)

getSessionApplicationScope

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

setAndInitRequestScope

public static void setAndInitRequestScope(@Nonnull @Nonempty
                                          String sApplicationID,
                                          @Nonnull
                                          IRequestScope aRequestScope)

This method is only to be called by this class and the web scope manager!

Parameters:

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

aRequestScope - The request scope to use. May not be null.

onRequestBegin

@Nonnull
public static IRequestScope onRequestBegin(@Nonnull @Nonempty
                                                     String sApplicationID,
                                                     @Nonnull @Nonempty
                                                     String sScopeID,
                                                     @Nonnull @Nonempty
                                                     String sSessionID)

getRequestScopeOrNull

@Nullable
public static IRequestScope getRequestScopeOrNull()

Returns:

The current request scope or null if no request scope is present.

isRequestScopePresent

public static boolean isRequestScopePresent()

Returns:

true if a request scope is present, false otherwise

getRequestScope

@Nonnull
public static IRequestScope getRequestScope()

Returns:

The current request scope and never null.

Throws:

IllegalStateException - If no request scope is present

onRequestEnd

public static void onRequestEnd()

To be called after a request finished.

isInternalAttribute

public static boolean isInternalAttribute(@Nullable
                                          String sAttributeName)

Check if the passed attribute name is an internal attribute.

Parameters:

sAttributeName - The name of the attribute to check. May be null.

Returns:

true if the passed attribute name is not null and starts with the SCOPE_ATTRIBUTE_PREFIX_INTERNAL prefix.