Package org.springframework.graphql.server.webmvc

Class GraphQlSseHandler

java.lang.Object

org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler

org.springframework.graphql.server.webmvc.GraphQlSseHandler

public class GraphQlSseHandler
extends AbstractGraphQlHttpHandler

GraphQL handler that supports the GraphQL Server-Sent Events Protocol and to be exposed as a WebMvc functional endpoint via RouterFunctions.

Since:

1.3.0

Author:

Brian Clozel, Rossen Stoyanchev

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
GraphQlSseHandler(WebGraphQlHandler graphQlHandler)	Constructor with the handler to delegate to, and no timeout, i.e.
GraphQlSseHandler(WebGraphQlHandler graphQlHandler, Duration timeout)	Variant constructor with a timeout to use for SSE subscriptions.

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

GraphQlSseHandler

public GraphQlSseHandler(WebGraphQlHandler graphQlHandler)

Constructor with the handler to delegate to, and no timeout, i.e. relying on underlying Server async request timeout.

Parameters:

graphQlHandler - the handler to delegate to

GraphQlSseHandler

public GraphQlSseHandler(WebGraphQlHandler graphQlHandler,
 @Nullable
 Duration timeout)

Variant constructor with a timeout to use for SSE subscriptions.

Parameters:

graphQlHandler - the handler to delegate to

timeout - the timeout value to set on AsyncWebRequest.setTimeout(Long)

Since:

1.3.3

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