org.springframework.graphql.server

Interface WebGraphQlHandler

public interface WebGraphQlHandler

Contract for common handling of a GraphQL request over HTTP or WebSocket, for use with Spring MVC or Spring WebFlux.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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
static WebGraphQlHandler.Builder	builder(ExecutionGraphQlService graphQlService) Provides access to a builder to create a WebGraphQlHandler instance.
ThreadLocalAccessor	getThreadLocalAccessor() Return the composite ThreadLocalAccessor that the handler is configured with.
WebSocketGraphQlInterceptor	getWebSocketInterceptor() Return the single interceptor of type WebSocketGraphQlInterceptor among all the configured interceptors.
reactor.core.publisher.Mono<WebGraphQlResponse>	handleRequest(WebGraphQlRequest request) Execute the given request and return the response.

Method Detail

getWebSocketInterceptor

WebSocketGraphQlInterceptor getWebSocketInterceptor()

Return the single interceptor of type WebSocketGraphQlInterceptor among all the configured interceptors.

getThreadLocalAccessor

@Nullable
ThreadLocalAccessor getThreadLocalAccessor()

Return the composite ThreadLocalAccessor that the handler is configured with.

handleRequest

reactor.core.publisher.Mono<WebGraphQlResponse> handleRequest(WebGraphQlRequest request)

Execute the given request and return the response.

Parameters:

request - the request to execute

Returns:

the response

builder

static WebGraphQlHandler.Builder builder(ExecutionGraphQlService graphQlService)

Provides access to a builder to create a WebGraphQlHandler instance.

Parameters:

graphQlService - the ExecutionGraphQlService to use for actual execution of the request.

Returns:

a builder for a WebGraphQlHandler