Class WebGraphQlResponse

java.lang.Object

org.springframework.graphql.support.AbstractGraphQlResponse

org.springframework.graphql.support.DefaultExecutionGraphQlResponse

org.springframework.graphql.server.WebGraphQlResponse

All Implemented Interfaces:

ExecutionGraphQlResponse, GraphQlResponse

public class WebGraphQlResponse
extends DefaultExecutionGraphQlResponse

GraphQlResponse implementation for server handling over HTTP or over WebSocket.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebGraphQlResponse.Builder	Builder to transform a WebGraphQlResponse.

Constructor Summary

Constructors

Constructor	Description
WebGraphQlResponse(ExecutionGraphQlResponse response)	Create an instance that wraps the given ExecutionGraphQlResponse.

Method Summary

Modifier and Type	Method	Description
HttpHeaders	getResponseHeaders()	Return the headers to be added to the HTTP response.
WebGraphQlResponse	transform(Consumer<WebGraphQlResponse.Builder> consumer)	Transform the underlying ExecutionResult through a WebGraphQlResponse.Builder and return a new instance with the modified values.

Methods inherited from class DefaultExecutionGraphQlResponse

getData, getErrors, getExecutionInput, getExecutionResult, getExtensions, isValid, toMap, toString

Methods inherited from class AbstractGraphQlResponse

field

Methods inherited from class Object

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

Methods inherited from interface GraphQlResponse

field

Constructor Details

WebGraphQlResponse

public WebGraphQlResponse(ExecutionGraphQlResponse response)

Create an instance that wraps the given ExecutionGraphQlResponse.

Parameters:

response - the response to wrap

Method Details

getResponseHeaders

public HttpHeaders getResponseHeaders()

Return the headers to be added to the HTTP response.

By default, this is empty.

Note: This is for use with GraphQL over HTTP requests but not for GraphQL over WebSocket where the initial handshake HTTP request completes before queries begin.

transform

public WebGraphQlResponse transform(Consumer<WebGraphQlResponse.Builder> consumer)

Transform the underlying ExecutionResult through a WebGraphQlResponse.Builder and return a new instance with the modified values.

Parameters:

consumer - callback to transform the result

Returns:

the new response instance with the mutated ExecutionResult