Package org.springframework.graphql.server.webmvc

Class GraphQlHttpHandler

java.lang.Object

org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler

org.springframework.graphql.server.webmvc.GraphQlHttpHandler

public class GraphQlHttpHandler
extends AbstractGraphQlHttpHandler

GraphQL handler to expose as a WebMvc functional endpoint via RouterFunctions.

Since:

1.0.0

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields inherited from class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler

logger

Constructor Summary

Constructors

Constructor	Description
GraphQlHttpHandler(WebGraphQlHandler graphQlHandler)	Create a new instance.
GraphQlHttpHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<?> converter)	Create a new instance with a custom message converter for GraphQL payloads.

Method Summary

Modifier and Type	Method	Description
protected ServerResponse	prepareResponse(ServerRequest request, reactor.core.publisher.Mono<WebGraphQlResponse> responseMono)	Prepare the ServerResponse for the given GraphQL response.

Methods inherited from class org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler

getWriteFunction, handleRequest

Methods inherited from class java.lang.Object

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

Constructor Details

GraphQlHttpHandler

public GraphQlHttpHandler(WebGraphQlHandler graphQlHandler)

Create a new instance.

Parameters:

graphQlHandler - common handler for GraphQL over HTTP requests

GraphQlHttpHandler

public GraphQlHttpHandler(WebGraphQlHandler graphQlHandler,
 @Nullable
 HttpMessageConverter<?> converter)

Create a new instance with a custom message converter for GraphQL payloads.

If no converter is provided, the handler will use the one configured for web use.

Parameters:

graphQlHandler - common handler for GraphQL over HTTP requests

converter - the converter to use to read and write GraphQL payloads

Method Details

prepareResponse

protected ServerResponse prepareResponse(ServerRequest request,
 reactor.core.publisher.Mono<WebGraphQlResponse> responseMono)

Description copied from class: AbstractGraphQlHttpHandler

Prepare the ServerResponse for the given GraphQL response.

Specified by:

prepareResponse in class AbstractGraphQlHttpHandler

Parameters:

request - the current request

responseMono - the GraphQL response

Returns:

the server response