com.helger.commons.scope

Class ScopeHelper

java.lang.Object

com.helger.commons.scope.ScopeHelper

@ThreadSafe
public final class ScopeHelper
extends Object

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

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DEBUG_APPLICATION_SCOPE
static boolean	DEFAULT_DEBUG_GLOBAL_SCOPE
static boolean	DEFAULT_DEBUG_LIFE_CYCLE
static boolean	DEFAULT_DEBUG_REQUEST_SCOPE
static boolean	DEFAULT_DEBUG_SESSION_APPLICATION_SCOPE
static boolean	DEFAULT_DEBUG_SESSION_SCOPE
static boolean	DEFAULT_DEBUG_WITH_STACK_TRACE

Method Summary

Modifier and Type	Method and Description
static boolean	debugApplicationScopeLifeCycle(org.slf4j.Logger aLogger) This is a just a helper method to determine whether application scope creation/deletion issues should be logged or not.
static boolean	debugGlobalScopeLifeCycle(org.slf4j.Logger aLogger) This is a just a helper method to determine whether global scope creation/deletion issues should be logged or not.
static boolean	debugRequestScopeLifeCycle(org.slf4j.Logger aLogger) This is a just a helper method to determine whether request scope creation/deletion issues should be logged or not.
static boolean	debugSessionApplicationScopeLifeCycle(org.slf4j.Logger aLogger) This is a just a helper method to determine whether global session application creation/deletion issues should be logged or not.
static boolean	debugSessionScopeLifeCycle(org.slf4j.Logger aLogger) This is a just a helper method to determine whether session scope creation/deletion issues should be logged or not.
static Throwable	getDebugStackTrace()
static boolean	isDebugApplicationScopeEnabled()
static boolean	isDebugGlobalScopeEnabled()
static boolean	isDebugRequestScopeEnabled()
static boolean	isDebugSessionApplicationScopeEnabled()
static boolean	isDebugSessionScopeEnabled()
static boolean	isDebugWithStackTrace()
static boolean	isLifeCycleDebuggingEnabled()
static void	setDebugApplicationScopeEnabled(boolean bDebugScope) Enable or disable application scope life cycle debugging.
static void	setDebugGlobalScopeEnabled(boolean bDebugScope) Enable or disable global scope life cycle debugging.
static void	setDebugRequestScopeEnabled(boolean bDebugScope) Enable or disable request scope life cycle debugging.
static void	setDebugSessionApplicationScopeEnabled(boolean bDebugScope) Enable or disable session application scope life cycle debugging.
static void	setDebugSessionScopeEnabled(boolean bDebugScope) Enable or disable session scope life cycle debugging.
static void	setDebugWithStackTrace(boolean bDebugWithStackTrace) Enable or disable stack traces when debugging scopes.
static void	setLifeCycleDebuggingEnabled(boolean bDebugLifeCycle) Enable or disable scope life cycle debugging for all scopes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEBUG_LIFE_CYCLE

public static final boolean DEFAULT_DEBUG_LIFE_CYCLE

See Also:

Constant Field Values

DEFAULT_DEBUG_GLOBAL_SCOPE

public static final boolean DEFAULT_DEBUG_GLOBAL_SCOPE

See Also:

Constant Field Values

DEFAULT_DEBUG_APPLICATION_SCOPE

public static final boolean DEFAULT_DEBUG_APPLICATION_SCOPE

See Also:

Constant Field Values

DEFAULT_DEBUG_SESSION_SCOPE

public static final boolean DEFAULT_DEBUG_SESSION_SCOPE

See Also:

Constant Field Values

DEFAULT_DEBUG_SESSION_APPLICATION_SCOPE

public static final boolean DEFAULT_DEBUG_SESSION_APPLICATION_SCOPE

See Also:

Constant Field Values

DEFAULT_DEBUG_REQUEST_SCOPE

public static final boolean DEFAULT_DEBUG_REQUEST_SCOPE

See Also:

Constant Field Values

DEFAULT_DEBUG_WITH_STACK_TRACE

public static final boolean DEFAULT_DEBUG_WITH_STACK_TRACE

See Also:

Constant Field Values

Method Detail

setLifeCycleDebuggingEnabled

public static void setLifeCycleDebuggingEnabled(boolean bDebugLifeCycle)

Enable or disable scope life cycle debugging for all scopes.

Parameters:

bDebugLifeCycle - true if the scope life cycle should be debugged, false to disable it. By default is is disabled.

isLifeCycleDebuggingEnabled

public static boolean isLifeCycleDebuggingEnabled()

Returns:

true if life cycle debugging for all scopes is enabled, false if it is disabled. The default value is disabled.

setDebugGlobalScopeEnabled

public static void setDebugGlobalScopeEnabled(boolean bDebugScope)

Enable or disable global scope life cycle debugging.

Parameters:

bDebugScope - true if the global scope life cycle should be debugged, false to disable it. By default is is disabled.

isDebugGlobalScopeEnabled

public static boolean isDebugGlobalScopeEnabled()

Returns:

true if global scope life cycle debugging is enabled, false if it is disabled. The default value is disabled.

setDebugApplicationScopeEnabled

public static void setDebugApplicationScopeEnabled(boolean bDebugScope)

Enable or disable application scope life cycle debugging.

Parameters:

bDebugScope - true if the application scope life cycle should be debugged, false to disable it. By default is is disabled.

isDebugApplicationScopeEnabled

public static boolean isDebugApplicationScopeEnabled()

Returns:

true if application scope life cycle debugging is enabled, false if it is disabled. The default value is disabled.

setDebugSessionScopeEnabled

public static void setDebugSessionScopeEnabled(boolean bDebugScope)

Enable or disable session scope life cycle debugging.

Parameters:

bDebugScope - true if the session scope life cycle should be debugged, false to disable it. By default is is disabled.

isDebugSessionScopeEnabled

public static boolean isDebugSessionScopeEnabled()

Returns:

true if session scope life cycle debugging is enabled, false if it is disabled. The default value is disabled.

setDebugSessionApplicationScopeEnabled

public static void setDebugSessionApplicationScopeEnabled(boolean bDebugScope)

Enable or disable session application scope life cycle debugging.

Parameters:

bDebugScope - true if the session application scope life cycle should be debugged, false to disable it. By default is is disabled.

isDebugSessionApplicationScopeEnabled

public static boolean isDebugSessionApplicationScopeEnabled()

Returns:

true if session application scope life cycle debugging is enabled, false if it is disabled. The default value is disabled.

setDebugRequestScopeEnabled

public static void setDebugRequestScopeEnabled(boolean bDebugScope)

Enable or disable request scope life cycle debugging.

Parameters:

bDebugScope - true if the request scope life cycle should be debugged, false to disable it. By default is is disabled.

isDebugRequestScopeEnabled

public static boolean isDebugRequestScopeEnabled()

Returns:

true if request scope life cycle debugging is enabled, false if it is disabled. The default value is disabled.

setDebugWithStackTrace

public static void setDebugWithStackTrace(boolean bDebugWithStackTrace)

Enable or disable stack traces when debugging scopes.

Parameters:

bDebugWithStackTrace - true to enable stack traces, false to disable them. By default is is disabled.

isDebugWithStackTrace

public static boolean isDebugWithStackTrace()

Returns:

true if stack traces should be logged, false if not. The default value is disabled.

debugGlobalScopeLifeCycle

public static boolean debugGlobalScopeLifeCycle(@Nonnull
                                                org.slf4j.Logger aLogger)

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

Parameters:

aLogger - The logger to check.

Returns:

true if global scope creation/deletion should be logged, false otherwise.

debugApplicationScopeLifeCycle

public static boolean debugApplicationScopeLifeCycle(@Nonnull
                                                     org.slf4j.Logger aLogger)

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

Parameters:

aLogger - The logger to check.

Returns:

true if application scope creation/deletion should be logged, false otherwise.

debugSessionScopeLifeCycle

public static boolean debugSessionScopeLifeCycle(@Nonnull
                                                 org.slf4j.Logger aLogger)

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

Parameters:

aLogger - The logger to check.

Returns:

true if session scope creation/deletion should be logged, false otherwise.

debugSessionApplicationScopeLifeCycle

public static boolean debugSessionApplicationScopeLifeCycle(@Nonnull
                                                            org.slf4j.Logger aLogger)

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

Parameters:

aLogger - The logger to check.

Returns:

true if session application scope creation/deletion should be logged, false otherwise.

debugRequestScopeLifeCycle

public static boolean debugRequestScopeLifeCycle(@Nonnull
                                                 org.slf4j.Logger aLogger)

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

Parameters:

aLogger - The logger to check.

Returns:

true if request scope creation/deletion should be logged, false otherwise.

getDebugStackTrace

@Nullable
public static Throwable getDebugStackTrace()

Returns:

An exception with the current stack trace or null if isDebugWithStackTrace() is false

See Also:

isDebugWithStackTrace()