org.bitbucket.gt_tech.spring.data.querydsl.value.operators.experimental

Class QuerydslHttpRequestContextHolder

java.lang.Object

org.bitbucket.gt_tech.spring.data.querydsl.value.operators.experimental.QuerydslHttpRequestContextHolder

public final class QuerydslHttpRequestContextHolder
extends Object

Provides access to users of this component to persist, retrieve, unset QuerydslHttpRequestContext. It delegates to a specific QuerydslHttpRequestContextHolderStrategy based on runtime configurations. Default strategy used is MODE_THREADLOCAL which can be used by configuring JVM property - SYSTEM_PROPERTY. The property can contain either of MODE_THREADLOCAL or MODE_INHERITABLETHREADLOCAL but if it contains any other value, it is assumed to be a cannonical classname for strategy to be used by this holder.

Author:

gt_tech

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODE_INHERITABLETHREADLOCAL InheritableThreadLocal based QuerydslHttpRequestContextHolderStrategy to be used.
static String	MODE_THREADLOCAL ThreadLocal based QuerydslHttpRequestContextHolderStrategy to be used.
static String	SYSTEM_PROPERTY System property to configure/override the QuerydslHttpRequestContextHolderStrategy to be used.

Constructor Summary

Constructors

Constructor and Description
QuerydslHttpRequestContextHolder()

Method Summary

Modifier and Type	Method and Description
static void	clearContext() Explicitly clears the context value from the current thread.
static QuerydslHttpRequestContext	getContext() Obtain the current QuerydslHttpRequestContext.
static QuerydslHttpRequestContextHolderStrategy	getContextHolderStrategy() Allows retrieval of the context strategy.
static void	setContext(QuerydslHttpRequestContext context) Associates a new QuerydslHttpRequestContext with the holder strategy
static void	setStrategyName(String strategyName) Changes the preferred strategy.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_THREADLOCAL

public static final String MODE_THREADLOCAL

ThreadLocal based QuerydslHttpRequestContextHolderStrategy to be used.

See Also:

Constant Field Values

MODE_INHERITABLETHREADLOCAL

public static final String MODE_INHERITABLETHREADLOCAL

InheritableThreadLocal based QuerydslHttpRequestContextHolderStrategy to be used.

See Also:

Constant Field Values

SYSTEM_PROPERTY

public static final String SYSTEM_PROPERTY

System property to configure/override the QuerydslHttpRequestContextHolderStrategy to be used.

The property can contain either of MODE_THREADLOCAL or MODE_INHERITABLETHREADLOCAL but if it contains any other value, it is assumed to be a cannonical classname for strategy to be used by this holder.

See Also:

Constant Field Values

Constructor Detail

QuerydslHttpRequestContextHolder

public QuerydslHttpRequestContextHolder()

Method Detail

clearContext

public static void clearContext()

Explicitly clears the context value from the current thread.

getContext

public static QuerydslHttpRequestContext getContext()

Obtain the current QuerydslHttpRequestContext.

Returns:

the context if available, null otherwise

setContext

public static void setContext(QuerydslHttpRequestContext context)

Associates a new QuerydslHttpRequestContext with the holder strategy

Parameters:

context - the new QuerydslHttpRequestContext (may not be null)

setStrategyName

public static void setStrategyName(String strategyName)

Changes the preferred strategy. Do NOT call this method more than once for a given JVM, as it will re-initialize the strategy and adversely affect any existing threads using the old strategy.

Parameters:

strategyName - the fully qualified class name of the strategy that should be used.

getContextHolderStrategy

public static QuerydslHttpRequestContextHolderStrategy getContextHolderStrategy()

Allows retrieval of the context strategy.

Returns:

the configured strategy for storing the security context.