Class GraphQlSseHandler

java.lang.Object

org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler

org.springframework.graphql.server.webflux.GraphQlSseHandler

public class GraphQlSseHandler
extends AbstractGraphQlHttpHandler

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

Since:

1.3.0

Author:

Brian Clozel, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GraphQlSseHandler.Builder	Builder for GraphQlSseHandler.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
GraphQlSseHandler(WebGraphQlHandler graphQlHandler)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of builder(WebGraphQlHandler)
GraphQlSseHandler(WebGraphQlHandler graphQlHandler, @Nullable Duration timeout)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of builder(WebGraphQlHandler)
GraphQlSseHandler(WebGraphQlHandler graphQlHandler, @Nullable Duration timeout, @Nullable Duration keepAliveDuration)	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of builder(WebGraphQlHandler)

Method Summary

Modifier and Type	Method	Description
static GraphQlSseHandler.Builder	builder(WebGraphQlHandler graphQlHandler)	Return a builder to create a GraphQlSseHandler, e.g.
Set<HttpMethod>	getHttpMethods()	Return the HTTP methods this handler is configured to support.
protected Set<graphql.language.OperationDefinition.Operation>	getSupportedOperations()	Return the GraphQL operation types that this handler supports, regardless of the semantics of any particular request.
protected reactor.core.publisher.Mono<ServerResponse>	prepareResponse(ServerRequest request, WebGraphQlResponse response)	Prepare the ServerResponse for the given GraphQL response.

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

bodyInserter, findRejection, handleRequest

Methods inherited from class java.lang.Object

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

Constructor Details

GraphQlSseHandler

@Deprecated(since="2.1.0",
            forRemoval=true)
public GraphQlSseHandler(WebGraphQlHandler graphQlHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of builder(WebGraphQlHandler)

Basic constructor with the handler to delegate to, and no timeout by default, which results in never timing out.

Parameters:

graphQlHandler - the handler to delegate to

GraphQlSseHandler

@Deprecated(since="2.1.0",
            forRemoval=true)
public GraphQlSseHandler(WebGraphQlHandler graphQlHandler,
 @Nullable Duration timeout)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of builder(WebGraphQlHandler)

Constructor with a timeout on how long to wait for the application to return the ServerResponse that will start the stream.

Parameters:

graphQlHandler - the handler to delegate to

timeout - the timeout value, or null to never time out

Since:

1.3.3

GraphQlSseHandler

@Deprecated(since="2.1.0",
            forRemoval=true)
public GraphQlSseHandler(WebGraphQlHandler graphQlHandler,
 @Nullable Duration timeout,
 @Nullable Duration keepAliveDuration)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of builder(WebGraphQlHandler)

Constructor with a keep-alive duration that determines how frequently to heartbeats during periods of inactivity.

Parameters:

graphQlHandler - the handler to delegate to

timeout - the timeout value to use or null to never time out

keepAliveDuration - how frequently to send empty comment messages when no other messages are sent

Since:

1.4.0

Method Details

builder

public static GraphQlSseHandler.Builder builder(WebGraphQlHandler graphQlHandler)

Return a builder to create a GraphQlSseHandler, e.g. to configure which HTTP methods it should support.

Parameters:

graphQlHandler - common handler for GraphQL over HTTP requests

Since:

2.1.0

getHttpMethods

public Set<HttpMethod> getHttpMethods()

Return the HTTP methods this handler is configured to support.

Applications should use this value when configuring the matching RequestPredicate, so that both stay in sync.

Since:

2.1.0

prepareResponse

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

Description copied from class: AbstractGraphQlHttpHandler

Prepare the ServerResponse for the given GraphQL response.

Specified by:

prepareResponse in class AbstractGraphQlHttpHandler

Parameters:

request - the current request

response - the GraphQL response

Returns:

the server response

getSupportedOperations

protected Set<graphql.language.OperationDefinition.Operation> getSupportedOperations()

Description copied from class: AbstractGraphQlHttpHandler

Return the GraphQL operation types that this handler supports, regardless of the semantics of any particular request.

Specified by:

getSupportedOperations in class AbstractGraphQlHttpHandler