org.springframework.graphql.web

Class WebInput

java.lang.Object

org.springframework.graphql.RequestInput

org.springframework.graphql.web.WebInput

public class WebInput
extends RequestInput

Container for the input of a GraphQL query over HTTP. The input includes the URL and the headers of the request, as well as the query name, operation name, and variables from the request body.

Since:

1.0.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
WebInput(URI uri, HttpHeaders headers, Map<String,Object> body, String id) Create an instance.

Method Summary

Modifier and Type	Method and Description
HttpHeaders	getHeaders() Return the headers of the request.
String	getId() Return the identifier for the request, which may be a subscription id for correlating request and response messages, or the underlying request or connection id, when available, or otherwise it's an identity hash based this WebInput instance.
UriComponents	getUri() Return the URI of the HTTP request including URL query parameters.

Methods inherited from class org.springframework.graphql.RequestInput

configureExecutionInput, getOperationName, getQuery, getVariables, toExecutionInput, toMap, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebInput

public WebInput(URI uri,
                HttpHeaders headers,
                Map<String,Object> body,
                @Nullable
                String id)

Create an instance.

Parameters:

uri - the url for the HTTP request, or WebSocket handshake

headers - the HTTP request headers

body - the content of the request deserialized from JSON

id - an identifier for the GraphQL request, e.g. a subscription id for correlating request and response messages, or it could be an id associated with the underlying request/connection id, if available

Method Detail

getUri

public UriComponents getUri()

Return the URI of the HTTP request including URL query parameters.

Returns:

the HTTP request URI

getHeaders

public HttpHeaders getHeaders()

Return the headers of the request.

Returns:

the HTTP request headers

getId

public String getId()

Return the identifier for the request, which may be a subscription id for correlating request and response messages, or the underlying request or connection id, when available, or otherwise it's an identity hash based this WebInput instance.

Returns:

the HTTP request identifier