A B C D E G H I M O P R S T V W

A

AbstractGlobalSingleton - Class in com.helger.scope.singleton

This is the base class for singleton objects that reside in the global scope.

AbstractGlobalSingleton() - Constructor for class com.helger.scope.singleton.AbstractGlobalSingleton

AbstractRequestSingleton - Class in com.helger.scope.singleton

This is the base class for singleton objects that reside in the request scope.

AbstractRequestSingleton() - Constructor for class com.helger.scope.singleton.AbstractRequestSingleton

AbstractScope - Class in com.helger.scope

Abstract scope implementation based on a Map containing the attribute values.

AbstractScope(String) - Constructor for class com.helger.scope.AbstractScope

Ctor.

AbstractSessionSingleton - Class in com.helger.scope.singleton

This is the base class for singleton objects that reside in the session non-web scope.

AbstractSessionSingleton() - Constructor for class com.helger.scope.singleton.AbstractSessionSingleton

AbstractSingleton - Class in com.helger.scope.singleton

Base class for all singletons.

AbstractSingleton() - Constructor for class com.helger.scope.singleton.AbstractSingleton

Ctor.

after() - Method in class com.helger.scope.mock.ScopeTestRule

attrs() - Method in class com.helger.scope.AbstractScope

attrs() - Method in interface com.helger.scope.IScope

B

before() - Method in class com.helger.scope.mock.ScopeTestRule

C

cleanup() - Static method in class com.helger.scope.ScopeCleanup

Cleanup all custom caches contained in this library.

close() - Method in class com.helger.scope.mgr.Scoped

com.helger.scope - package com.helger.scope

com.helger.scope.mgr - package com.helger.scope.mgr

com.helger.scope.mock - package com.helger.scope.mock

com.helger.scope.singleton - package com.helger.scope.singleton

com.helger.scope.spi - package com.helger.scope.spi

containsAnySession() - Method in class com.helger.scope.mgr.ScopeSessionManager

D

debugGlobalScopeLifeCycle(Logger) - Static method in class com.helger.scope.ScopeHelper

This is a just a helper method to determine whether global scope creation/deletion issues should be logged or not.

debugRequestScopeLifeCycle(Logger) - Static method in class com.helger.scope.ScopeHelper

This is a just a helper method to determine whether request scope creation/deletion issues should be logged or not.

debugSessionScopeLifeCycle(Logger) - Static method in class com.helger.scope.ScopeHelper

This is a just a helper method to determine whether session scope creation/deletion issues should be logged or not.

DEFAULT_CREATE_SCOPE - Static variable in class com.helger.scope.mgr.ScopeManager

DEFAULT_DEBUG_CONSISTENCY - Static variable in class com.helger.scope.singleton.SingletonHelper

DEFAULT_DEBUG_GLOBAL_SCOPE - Static variable in class com.helger.scope.ScopeHelper

DEFAULT_DEBUG_LIFE_CYCLE - Static variable in class com.helger.scope.ScopeHelper

DEFAULT_DEBUG_REQUEST_SCOPE - Static variable in class com.helger.scope.ScopeHelper

DEFAULT_DEBUG_SESSION_SCOPE - Static variable in class com.helger.scope.ScopeHelper

DEFAULT_DEBUG_WITH_STACK_TRACE - Static variable in class com.helger.scope.ScopeHelper

DEFAULT_DEBUG_WITH_STACK_TRACE - Static variable in class com.helger.scope.singleton.SingletonHelper

DEFAULT_DESTROY_ALL_SESSIONS_ON_SCOPE_END - Static variable in class com.helger.scope.mgr.ScopeSessionManager

DEFAULT_END_ALL_SESSIONS_ON_SCOPE_END - Static variable in class com.helger.scope.mgr.ScopeSessionManager

destroyAllSessions() - Method in class com.helger.scope.mgr.ScopeSessionManager

Destroy all known session scopes.

destroyScope() - Method in class com.helger.scope.AbstractScope

destroyScope() - Method in interface com.helger.scope.IScope

Destroys the scopes and all child scopes.

destroySessionScope(ISessionScope) - Static method in class com.helger.scope.mgr.ScopeManager

Manually destroy the passed session scope.

E

equals(Object) - Method in class com.helger.scope.AbstractScope

equals(Object) - Method in class com.helger.scope.RequestScope

EScope - Enum in com.helger.scope.mgr

This enumeration defines all the possible non-web scopes including some utility methods on it.

G

getAllGlobalScopeSPIs() - Method in class com.helger.scope.spi.ScopeSPIManager

getAllGlobalSingletons() - Static method in class com.helger.scope.singleton.AbstractGlobalSingleton

Get all instantiated singleton objects registered in the current global scope.

getAllRequestScopeSPIs() - Method in class com.helger.scope.spi.ScopeSPIManager

getAllRequestSingletons() - Static method in class com.helger.scope.singleton.AbstractRequestSingleton

Get all instantiated singleton objects registered in the current request scope.

getAllScopeRenewalAwareAttributes() - Method in interface com.helger.scope.IScope

getAllSessionScopes() - Method in class com.helger.scope.mgr.ScopeSessionManager

getAllSessionScopeSPIs() - Method in class com.helger.scope.spi.ScopeSPIManager

getAllSessionSingletons() - Static method in class com.helger.scope.singleton.AbstractSessionSingleton

Get all instantiated singleton objects registered in the current session scope.

getAllSingletons(IScope, Class<T>) - Static method in class com.helger.scope.singleton.AbstractSingleton

Get all singleton objects registered in the respective sub-class of this class.

getDebugStackTrace() - Static method in class com.helger.scope.ScopeHelper

getDebugStackTrace() - Static method in class com.helger.scope.singleton.SingletonHelper

getGlobalScope() - Static method in class com.helger.scope.mgr.ScopeManager

getGlobalScopeOrNull() - Static method in class com.helger.scope.mgr.ScopeManager

getGlobalSingleton(Class<T>) - Static method in class com.helger.scope.singleton.AbstractGlobalSingleton

Get the singleton object in the current global scope, using the passed class.

getGlobalSingletonIfInstantiated(Class<T>) - Static method in class com.helger.scope.singleton.AbstractGlobalSingleton

Get the singleton object if it is already instantiated inside the current global scope or null if it is not instantiated.

getID() - Method in class com.helger.scope.AbstractScope

getID() - Method in interface com.helger.scope.IScope

Get the ID of this scope.

getInstance() - Static method in class com.helger.scope.mgr.ScopeSessionManager

getInstance() - Static method in class com.helger.scope.spi.ScopeSPIManager

getRequestScope() - Method in class com.helger.scope.mgr.Scoped

getRequestScope() - Static method in class com.helger.scope.mgr.ScopeManager

getRequestScopeOrNull() - Static method in class com.helger.scope.mgr.ScopeManager

getRequestSingleton(Class<T>) - Static method in class com.helger.scope.singleton.AbstractRequestSingleton

Get the singleton object in the current request scope, using the passed class.

getRequestSingletonIfInstantiated(Class<T>) - Static method in class com.helger.scope.singleton.AbstractRequestSingleton

Get the singleton object if it is already instantiated inside the current request scope or null if it is not instantiated.

getScope() - Method in enum com.helger.scope.mgr.EScope

getScope(boolean) - Method in enum com.helger.scope.mgr.EScope

getScope(EScope, boolean) - Static method in enum com.helger.scope.mgr.EScope

Resolve the currently matching scope of the given EScope value.

getSessionCount() - Method in class com.helger.scope.mgr.ScopeSessionManager

getSessionID() - Method in interface com.helger.scope.IRequestScope

Shortcut for getSessionID(true)

getSessionID(boolean) - Method in interface com.helger.scope.IRequestScope

getSessionID(boolean) - Method in class com.helger.scope.RequestScope

getSessionScope() - Static method in class com.helger.scope.mgr.ScopeManager

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

getSessionScope(boolean) - Static method in class com.helger.scope.mgr.ScopeManager

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

getSessionScope(boolean, Function<? super String, ? extends ISessionScope>) - Static method in class com.helger.scope.mgr.ScopeManager

getSessionScopeOfID(String) - Method in class com.helger.scope.mgr.ScopeSessionManager

Get the session scope with the specified ID.

getSessionSingleton(Class<T>) - Static method in class com.helger.scope.singleton.AbstractSessionSingleton

Get the singleton object in the current session scope, using the passed class.

getSessionSingletonIfInstantiated(Class<T>) - Static method in class com.helger.scope.singleton.AbstractSessionSingleton

Get the singleton object if it is already instantiated inside the current session scope or null if it is not instantiated.

getSingleton(IScope, Class<T>) - Static method in class com.helger.scope.singleton.AbstractSingleton

Get the singleton object in the passed scope, using the passed class.

getSingletonIfInstantiated(IScope, Class<T>) - Static method in class com.helger.scope.singleton.AbstractSingleton

Get the singleton object if it is already instantiated inside a scope or null if it is not instantiated.

getSingletonScopeKey(Class<? extends AbstractSingleton>) - Static method in class com.helger.scope.singleton.AbstractSingleton

Create the key which is used to reference the object within the scope.

GlobalScope - Class in com.helger.scope

Base implementation of the IGlobalScope interface.

GlobalScope(String) - Constructor for class com.helger.scope.GlobalScope

H

hashCode() - Method in class com.helger.scope.AbstractScope

hashCode() - Method in class com.helger.scope.RequestScope

I

IGlobalScope - Interface in com.helger.scope

Interface for a single global scope object.

IGlobalScopeSPI - Interface in com.helger.scope.spi

SPI for handling the global scope lifecycle.

initScope() - Method in class com.helger.scope.GlobalScope

initScope() - Method in interface com.helger.scope.IScope

Init the scope.

initScope() - Method in class com.helger.scope.RequestScope

initScope() - Method in class com.helger.scope.SessionScope

internalClearRequestScope() - Static method in class com.helger.scope.mgr.ScopeManager

Internal method to clear request scope thread local.

internalSetAndInitRequestScope(IRequestScope) - Static method in class com.helger.scope.mgr.ScopeManager

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

IRequestScope - Interface in com.helger.scope

Interface for a single request scope object.

IRequestScopeSPI - Interface in com.helger.scope.spi

SPI for handling the request scope lifecycle.

IScope - Interface in com.helger.scope

This interface is used for all the common stuff of a scope.

IScopeDestructionAware - Interface in com.helger.scope

A listener interfaces that is invoked before a scope is destroyed.

IScopeRenewalAware - Interface in com.helger.scope

This is a marker interface for all objects that should survive a session renewal.

isDebugConsistency() - Static method in class com.helger.scope.singleton.SingletonHelper

isDebugGlobalScopeEnabled() - Static method in class com.helger.scope.ScopeHelper

isDebugRequestScopeEnabled() - Static method in class com.helger.scope.ScopeHelper

isDebugSessionScopeEnabled() - Static method in class com.helger.scope.ScopeHelper

isDebugWithStackTrace() - Static method in class com.helger.scope.ScopeHelper

isDebugWithStackTrace() - Static method in class com.helger.scope.singleton.SingletonHelper

isDestroyAllSessionsOnScopeEnd() - Method in class com.helger.scope.mgr.ScopeSessionManager

isDestroyed() - Method in class com.helger.scope.AbstractScope

isDestroyed() - Method in interface com.helger.scope.IScope

isDestroyed() - Method in class com.helger.scope.singleton.AbstractSingleton

isEndAllSessionsOnScopeEnd() - Method in class com.helger.scope.mgr.ScopeSessionManager

ISessionScope - Interface in com.helger.scope

Interface for a single session scope object.

ISessionScopeSPI - Interface in com.helger.scope.spi

SPI for handling the session scope lifecycle.

isGlobalScopePresent() - Static method in class com.helger.scope.mgr.ScopeManager

isGlobalSingletonInstantiated(Class<? extends AbstractGlobalSingleton>) - Static method in class com.helger.scope.singleton.AbstractGlobalSingleton

Check if a singleton is already instantiated inside the current global scope

isInDestruction() - Method in class com.helger.scope.AbstractScope

isInDestruction() - Method in interface com.helger.scope.IScope

isInDestruction() - Method in class com.helger.scope.singleton.AbstractSingleton

isInInstantiation() - Method in class com.helger.scope.singleton.AbstractSingleton

isInPreDestruction() - Method in class com.helger.scope.AbstractScope

isInPreDestruction() - Method in class com.helger.scope.singleton.AbstractSingleton

isInstantiated() - Method in class com.helger.scope.singleton.AbstractSingleton

isInstantiated() - Static method in class com.helger.scope.spi.ScopeSPIManager

isInternalAttribute(String) - Static method in class com.helger.scope.mgr.ScopeManager

Check if the passed attribute name is an internal attribute.

isLifeCycleDebuggingEnabled() - Static method in class com.helger.scope.ScopeHelper

isRequestScopePresent() - Static method in class com.helger.scope.mgr.ScopeManager

isRequestSingletonInstantiated(Class<? extends AbstractRequestSingleton>) - Static method in class com.helger.scope.singleton.AbstractRequestSingleton

Check if a singleton is already instantiated inside the current request scope

isSessionSingletonInstantiated(Class<? extends AbstractSessionSingleton>) - Static method in class com.helger.scope.singleton.AbstractSessionSingleton

Check if a singleton is already instantiated inside the current session scope

isSingletonInstantiated(IScope, Class<? extends AbstractSingleton>) - Static method in class com.helger.scope.singleton.AbstractSingleton

Check if a singleton is already instantiated inside a scope

isUsableObject() - Method in class com.helger.scope.singleton.AbstractSingleton

isValid() - Method in class com.helger.scope.AbstractScope

isValid() - Method in interface com.helger.scope.IScope

M

m_aRWLock - Variable in class com.helger.scope.AbstractScope

m_aRWLock - Variable in class com.helger.scope.singleton.AbstractSingleton

MOCK_GLOBAL_SCOPE_ID - Static variable in class com.helger.scope.mock.ScopeAwareTestSetup

MOCK_REQUEST_SCOPE_ID - Static variable in class com.helger.scope.mock.ScopeAwareTestSetup

MOCK_SESSION_SCOPE_ID - Static variable in class com.helger.scope.mock.ScopeAwareTestSetup

O

onAfterInstantiation(IScope) - Method in class com.helger.scope.singleton.AbstractSingleton

Called after the singleton was instantiated.

onBeforeDestroy(IScope) - Method in class com.helger.scope.singleton.AbstractSingleton

Called before this singleton is destroyed.

onBeforeScopeDestruction(IScope) - Method in interface com.helger.scope.IScopeDestructionAware

Called before the owning scope is destroyed.

onBeforeScopeDestruction(IScope) - Method in class com.helger.scope.singleton.AbstractSingleton

onDestroy(IScope) - Method in class com.helger.scope.mgr.ScopeSessionManager

onDestroy(IScope) - Method in class com.helger.scope.singleton.AbstractSingleton

Called when this singleton is destroyed.

onGlobalBegin(String) - Static method in class com.helger.scope.mgr.ScopeManager

This method is used to set the initial global scope.

onGlobalBegin(String, Function<? super String, T>) - Static method in class com.helger.scope.mgr.ScopeManager

onGlobalEnd() - Static method in class com.helger.scope.mgr.ScopeManager

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

onGlobalScopeBegin(IGlobalScope) - Method in interface com.helger.scope.spi.IGlobalScopeSPI

Called after the global scope was started

onGlobalScopeBegin(IGlobalScope) - Method in class com.helger.scope.spi.ScopeSPIManager

onGlobalScopeEnd(IGlobalScope) - Method in interface com.helger.scope.spi.IGlobalScopeSPI

Called before the global scope is shut down

onGlobalScopeEnd(IGlobalScope) - Method in class com.helger.scope.spi.ScopeSPIManager

onRequestBegin(String, String) - Static method in class com.helger.scope.mgr.ScopeManager

onRequestBegin(String, String, BiFunction<? super String, ? super String, T>) - Static method in class com.helger.scope.mgr.ScopeManager

onRequestEnd() - Static method in class com.helger.scope.mgr.ScopeManager

To be called after a request finished.

onRequestScopeBegin(IRequestScope) - Method in interface com.helger.scope.spi.IRequestScopeSPI

Called after the request scope was started

onRequestScopeBegin(IRequestScope) - Method in class com.helger.scope.spi.ScopeSPIManager

onRequestScopeEnd(IRequestScope) - Method in interface com.helger.scope.spi.IRequestScopeSPI

Called before the request scope is shut down

onRequestScopeEnd(IRequestScope) - Method in class com.helger.scope.spi.ScopeSPIManager

onScopeBegin(ISessionScope) - Method in class com.helger.scope.mgr.ScopeSessionManager

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

onScopeDestruction(IScope) - Method in interface com.helger.scope.IScopeDestructionAware

Called when the owning scope is destroyed.

onScopeDestruction(IScope) - Method in class com.helger.scope.singleton.AbstractSingleton

onScopeEnd(ISessionScope) - Method in class com.helger.scope.mgr.ScopeSessionManager

Close the passed session scope gracefully.

onSessionScopeBegin(ISessionScope) - Method in interface com.helger.scope.spi.ISessionScopeSPI

Called after the session scope was started

onSessionScopeBegin(ISessionScope) - Method in class com.helger.scope.spi.ScopeSPIManager

onSessionScopeEnd(ISessionScope) - Method in interface com.helger.scope.spi.ISessionScopeSPI

Called before the session scope is shut down

onSessionScopeEnd(ISessionScope) - Method in class com.helger.scope.spi.ScopeSPIManager

P

postDestroy() - Method in class com.helger.scope.AbstractScope

Override this method to perform further actions AFTER the scope was destroyed.

postDestroy() - Method in class com.helger.scope.GlobalScope

postDestroy() - Method in class com.helger.scope.RequestScope

postDestroy() - Method in class com.helger.scope.SessionScope

preDestroy() - Method in class com.helger.scope.AbstractScope

Override this method to perform further actions BEFORE the scope is destroyed.

preDestroy() - Method in class com.helger.scope.GlobalScope

preDestroy() - Method in class com.helger.scope.RequestScope

preDestroy() - Method in class com.helger.scope.SessionScope

R

readAbstractSingletonFields(ObjectInputStream) - Method in class com.helger.scope.singleton.AbstractSingleton

Set all internal status variables to the values read from the specified ObjectInputStream.

reinitialize() - Method in class com.helger.scope.spi.ScopeSPIManager

RequestScope - Class in com.helger.scope

Default implementation for non-web request scopes.

RequestScope(String, String) - Constructor for class com.helger.scope.RequestScope

runAtomic(Function<? super IScope, ? extends T>) - Method in class com.helger.scope.AbstractScope

runAtomic(Consumer<? super IScope>) - Method in class com.helger.scope.AbstractScope

runAtomic(Consumer<? super IScope>) - Method in interface com.helger.scope.IScope

Perform stuff as a single action.

runAtomic(Function<? super IScope, ? extends T>) - Method in interface com.helger.scope.IScope

Perform stuff as a single action.

S

SCOPE_ATTRIBUTE_PREFIX_INTERNAL - Static variable in class com.helger.scope.mgr.ScopeManager

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

ScopeAwareTestSetup - Class in com.helger.scope.mock

This class provides the initialization handling for scopes in unit tests.

ScopeCleanup - Class in com.helger.scope

The sole purpose of this class to clear all caches, that reside in this library.

Scoped - Class in com.helger.scope.mgr

Auto closable wrapper around ScopeManager.onRequestBegin( String, String) and ScopeManager.onRequestEnd()

Scoped() - Constructor for class com.helger.scope.mgr.Scoped

Scoped(String, String) - Constructor for class com.helger.scope.mgr.Scoped

ScopeHelper - Class in com.helger.scope

Global scope utility methods that don't nicely fit somewhere else.

ScopeManager - Class in com.helger.scope.mgr

This is the manager class for non-web scope handling.

ScopeSessionManager - Class in com.helger.scope.mgr

Internal manager class for session scopes.

ScopeSessionManager() - Constructor for class com.helger.scope.mgr.ScopeSessionManager

Deprecated.

ScopeSPIManager - Class in com.helger.scope.spi

This is an internal class, that triggers the SPI implementations registered for scope lifecycle SPI implementations.

ScopeTestRule - Class in com.helger.scope.mock

Special JUnit test rule to initialize scopes correctly.

ScopeTestRule() - Constructor for class com.helger.scope.mock.ScopeTestRule

selfDestruct() - Method in interface com.helger.scope.ISessionScope

A special internal method that destroys the session.

selfDestruct() - Method in class com.helger.scope.SessionScope

SessionScope - Class in com.helger.scope

Default implementation of the ISessionScope interface

SessionScope(String) - Constructor for class com.helger.scope.SessionScope

setDebugConsistency(boolean) - Static method in class com.helger.scope.singleton.SingletonHelper

Enable or disable singleton consistency debugging.

setDebugGlobalScopeEnabled(boolean) - Static method in class com.helger.scope.ScopeHelper

Enable or disable global scope life cycle debugging.

setDebugRequestScopeEnabled(boolean) - Static method in class com.helger.scope.ScopeHelper

Enable or disable request scope life cycle debugging.

setDebugSessionScopeEnabled(boolean) - Static method in class com.helger.scope.ScopeHelper

Enable or disable session scope life cycle debugging.

setDebugWithStackTrace(boolean) - Static method in class com.helger.scope.ScopeHelper

Enable or disable stack traces when debugging scopes.

setDebugWithStackTrace(boolean) - Static method in class com.helger.scope.singleton.SingletonHelper

Enable or disable stack traces when debugging singletons.

setDestroyAllSessionsOnScopeEnd(boolean) - Method in class com.helger.scope.mgr.ScopeSessionManager

setDestroyed(boolean) - Method in class com.helger.scope.singleton.AbstractSingleton

setEndAllSessionsOnScopeEnd(boolean) - Method in class com.helger.scope.mgr.ScopeSessionManager

setGlobalScope(IGlobalScope) - Static method in class com.helger.scope.mgr.ScopeManager

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

setInDestruction(boolean) - Method in class com.helger.scope.singleton.AbstractSingleton

setInInstantiation(boolean) - Method in class com.helger.scope.singleton.AbstractSingleton

setInPreDestruction(boolean) - Method in class com.helger.scope.singleton.AbstractSingleton

setInstantiated(boolean) - Method in class com.helger.scope.singleton.AbstractSingleton

setLifeCycleDebuggingEnabled(boolean) - Static method in class com.helger.scope.ScopeHelper

Enable or disable scope life cycle debugging for all scopes.

setupScopeTests() - Static method in class com.helger.scope.mock.ScopeAwareTestSetup

Run this before tests are executed to initialize a global scope and a request.

shutdownScopeTests() - Static method in class com.helger.scope.mock.ScopeAwareTestSetup

Run this after your tests to shutdown the request and the global scope.

SingletonHelper - Class in com.helger.scope.singleton

Global singleton utility methods that don't nicely fit somewhere else.

STORAGE_PATH - Static variable in class com.helger.scope.mock.ScopeAwareTestSetup

STORAGE_PATH - Static variable in class com.helger.scope.mock.ScopeTestRule

T

toString() - Method in class com.helger.scope.AbstractScope

toString() - Method in class com.helger.scope.RequestScope

toString() - Method in class com.helger.scope.singleton.AbstractSingleton

V

valueOf(String) - Static method in enum com.helger.scope.mgr.EScope

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.helger.scope.mgr.EScope

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeAbstractSingletonFields(ObjectOutputStream) - Method in class com.helger.scope.singleton.AbstractSingleton

Write the internal status variables to the passed ObjectOutputStream.

A B C D E G H I M O P R S T V W