org.springframework.graphql.server

Interface WebGraphQlHandler.Builder

Enclosing interface:

WebGraphQlHandler

public static interface WebGraphQlHandler.Builder

Builder for a WebGraphQlHandler that executes a WebGraphQlInterceptor chain followed by a ExecutionGraphQlService.

Method Summary

Modifier and Type	Method and Description
WebGraphQlHandler	build() Build the WebGraphQlHandler instance.
WebGraphQlHandler.Builder	interceptor(WebGraphQlInterceptor... interceptors) Configure interceptors to be invoked before the target GraphQlService.
WebGraphQlHandler.Builder	interceptors(List<WebGraphQlInterceptor> interceptors) Alternative to interceptor(WebGraphQlInterceptor...) with a List.
WebGraphQlHandler.Builder	threadLocalAccessor(ThreadLocalAccessor... accessors) Configure accessors for ThreadLocal variables to use to extract ThreadLocal values at the start of GraphQL execution in the web layer, and have those saved, and restored around the invocation of data fetchers and exception resolvers.
WebGraphQlHandler.Builder	threadLocalAccessors(List<ThreadLocalAccessor> accessors) Alternative to threadLocalAccessor(ThreadLocalAccessor...) with a List.

Method Detail

interceptor

WebGraphQlHandler.Builder interceptor(WebGraphQlInterceptor... interceptors)

Configure interceptors to be invoked before the target GraphQlService.

One of the interceptors can be of type WebSocketGraphQlInterceptor to handle data from the first ConnectionInit message expected on a GraphQL over WebSocket session, as well as the Complete message expected at the end of a session.

Parameters:

interceptors - the interceptors to add

Returns:

this builder

interceptors

WebGraphQlHandler.Builder interceptors(List<WebGraphQlInterceptor> interceptors)

Alternative to interceptor(WebGraphQlInterceptor...) with a List.

Parameters:

interceptors - the list of interceptors to add

Returns:

this builder

threadLocalAccessor

WebGraphQlHandler.Builder threadLocalAccessor(ThreadLocalAccessor... accessors)

Configure accessors for ThreadLocal variables to use to extract ThreadLocal values at the start of GraphQL execution in the web layer, and have those saved, and restored around the invocation of data fetchers and exception resolvers.

Parameters:

accessors - the accessors to add

Returns:

this builder

threadLocalAccessors

WebGraphQlHandler.Builder threadLocalAccessors(List<ThreadLocalAccessor> accessors)

Alternative to threadLocalAccessor(ThreadLocalAccessor...) with a List.

Parameters:

accessors - the list of accessors to add

Returns:

this builder

build

WebGraphQlHandler build()

Build the WebGraphQlHandler instance.

Returns:

the built WebGraphQlHandler