org.springframework.graphql.execution

Interface ThreadLocalAccessor

All Known Implementing Classes:

SecurityContextThreadLocalAccessor

public interface ThreadLocalAccessor

Interface to be implemented to assist with the extraction of ThreadLocal values at the start of GraphQL request execution, e.g. in the web layer. Those values are saved in ExecutionInput and restored later around the invocation of data fetchers and exception resolvers which may be in a different thread.

Implementations of this interface are typically declared as beans in Spring configuration and are invoked in order as defined in ObjectProvider.orderedStream().

Currently supported for GraphQL requests over HTTP and WebSocket in Spring MVC applications.

Since:

1.0.0

Author:

Rossen Stoyanchev

See Also:

WebGraphQlHandler.Builder.threadLocalAccessor(ThreadLocalAccessor...)

Method Summary

Modifier and Type	Method and Description
static ThreadLocalAccessor	composite(List<ThreadLocalAccessor> accessors) Create a composite accessor that applies all of the given ThreadLocal accessors.
void	extractValues(Map<String,Object> container) Extract ThreadLocal values and add them to the given Map, so they can be saved and subsequently restored around the invocation of data fetchers and exception resolvers.
void	resetValues(Map<String,Object> values) Reset ThreadLocal context for the given, previously extracted and then restored values.
void	restoreValues(Map<String,Object> values) Restore ThreadLocal context by looking up previously extracted values.

Method Detail

extractValues

void extractValues(Map<String,Object> container)

Extract ThreadLocal values and add them to the given Map, so they can be saved and subsequently restored around the invocation of data fetchers and exception resolvers.

Parameters:

container - to add extracted ThreadLocal values to

restoreValues

void restoreValues(Map<String,Object> values)

Restore ThreadLocal context by looking up previously extracted values.

Parameters:

values - previously extracted saved ThreadLocal values

resetValues

void resetValues(Map<String,Object> values)

Reset ThreadLocal context for the given, previously extracted and then restored values.

Parameters:

values - previously extracted saved ThreadLocal values

composite

static ThreadLocalAccessor composite(List<ThreadLocalAccessor> accessors)

Create a composite accessor that applies all of the given ThreadLocal accessors.

Parameters:

accessors - the accessors to apply

Returns:

the composite accessor