Package 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	Description
static interface	WebGraphQlHandler.Builder	Builder for a WebGraphQlHandler that executes a WebGraphQlInterceptor chain followed by a ExecutionGraphQlService.

Method Summary

Modifier and Type	Method	Description
static WebGraphQlHandler.Builder	builder(ExecutionGraphQlService graphQlService)	Provides access to a builder to create a WebGraphQlHandler instance.
io.micrometer.context.ContextSnapshotFactory	contextSnapshotFactory()	Return the configured ContextSnapshotFactory instance to use.
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 Details

getWebSocketInterceptor

WebSocketGraphQlInterceptor getWebSocketInterceptor()

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

contextSnapshotFactory

io.micrometer.context.ContextSnapshotFactory contextSnapshotFactory()

Return the configured ContextSnapshotFactory instance to use.

Since:

1.3.0

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