Package org.springframework.graphql.server

Class WebGraphQlRequest

java.lang.Object

org.springframework.graphql.support.DefaultGraphQlRequest

org.springframework.graphql.support.DefaultExecutionGraphQlRequest

org.springframework.graphql.server.WebGraphQlRequest

All Implemented Interfaces:

ExecutionGraphQlRequest, GraphQlRequest

Direct Known Subclasses:

WebSocketGraphQlRequest

public class WebGraphQlRequest
extends DefaultExecutionGraphQlRequest
implements ExecutionGraphQlRequest

GraphQlRequest implementation for server handling over HTTP or WebSocket. Provides access to the URL and headers of the underlying request. For WebSocket, these are the URL and headers of the HTTP handshake request.

Since:

1.0.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.graphql.support.DefaultGraphQlRequest

EXTENSIONS_KEY, OPERATION_NAME_KEY, QUERY_KEY, VARIABLES_KEY

Constructor Summary

Constructors

Constructor	Description
WebGraphQlRequest(URI uri, HttpHeaders headers, MultiValueMap<String,HttpCookie> cookies, InetSocketAddress remoteAddress, Map<String,Object> attributes, Map<String,Object> body, String id, Locale locale)	Constructor variant with a Map for the request body.
WebGraphQlRequest(URI uri, HttpHeaders headers, MultiValueMap<String,HttpCookie> cookies, InetSocketAddress remoteAddress, Map<String,Object> attributes, GraphQlRequest body, String id, Locale locale)	Create an instance.
WebGraphQlRequest(URI uri, HttpHeaders headers, MultiValueMap<String,HttpCookie> cookies, Map<String,Object> attributes, Map<String,Object> body, String id, Locale locale)	Deprecated, for removal: This API element is subject to removal in a future version. since 1.3.0 in favor WebGraphQlRequest(URI, HttpHeaders, MultiValueMap, InetSocketAddress, Map, Map, String, Locale)
WebGraphQlRequest(URI uri, HttpHeaders headers, MultiValueMap<String,HttpCookie> cookies, Map<String,Object> attributes, GraphQlRequest body, String id, Locale locale)	Deprecated, for removal: This API element is subject to removal in a future version. since 1.3.0 in favor WebGraphQlRequest(URI, HttpHeaders, MultiValueMap, InetSocketAddress, Map, Map, String, Locale)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributes()	Return the request or WebSocket session attributes.
MultiValueMap<String,HttpCookie>	getCookies()	Return the cookies of the request of WebSocket handshake.
HttpHeaders	getHeaders()	Return the HTTP headers of the request or WebSocket handshake.
InetSocketAddress	getRemoteAddress()	Return the remote address of the client, if available.
UriComponents	getUri()	Return the URL for the HTTP request or WebSocket handshake.

Methods inherited from class org.springframework.graphql.support.DefaultExecutionGraphQlRequest

configureExecutionInput, executionId, getExecutionId, getId, getLocale, toExecutionInput, toString

Methods inherited from class org.springframework.graphql.support.DefaultGraphQlRequest

equals, getDocument, getExtensions, getOperationName, getVariables, hashCode, toMap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.graphql.ExecutionGraphQlRequest

configureExecutionInput, executionId, getExecutionId, getId, getLocale, toExecutionInput

Methods inherited from interface org.springframework.graphql.GraphQlRequest

getDocument, getExtensions, getOperationName, getVariables, toMap

Constructor Details

WebGraphQlRequest

public WebGraphQlRequest(URI uri,
 HttpHeaders headers,
 @Nullable
 MultiValueMap<String,HttpCookie> cookies,
 @Nullable
 InetSocketAddress remoteAddress,
 Map<String,Object> attributes,
 GraphQlRequest body,
 String id,
 @Nullable
 Locale locale)

Create an instance.

Parameters:

uri - the URL for the HTTP request or WebSocket handshake

headers - the HTTP request headers

cookies - the HTTP request cookies

remoteAddress - the HTTP client remote address

attributes - request attributes

body - the deserialized content of the GraphQL request

id - an identifier for the GraphQL request

locale - the locale from the HTTP request, if any

Since:

1.3.0

WebGraphQlRequest

public WebGraphQlRequest(URI uri,
 HttpHeaders headers,
 @Nullable
 MultiValueMap<String,HttpCookie> cookies,
 @Nullable
 InetSocketAddress remoteAddress,
 Map<String,Object> attributes,
 Map<String,Object> body,
 String id,
 @Nullable
 Locale locale)

Constructor variant with a Map for the request body.

Parameters:

uri - the URL for the HTTP request or WebSocket handshake

headers - the HTTP request headers

cookies - the HTTP request cookies

remoteAddress - the HTTP client remote address

attributes - request attributes

body - the deserialized content of the GraphQL request

id - an identifier for the GraphQL request

locale - the locale from the HTTP request, if any

Since:

1.3.0

WebGraphQlRequest

@Deprecated(since="1.3.0",
            forRemoval=true)
public WebGraphQlRequest(URI uri,
 HttpHeaders headers,
 @Nullable
 MultiValueMap<String,HttpCookie> cookies,
 Map<String,Object> attributes,
 GraphQlRequest body,
 String id,
 @Nullable
 Locale locale)

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

since 1.3.0 in favor WebGraphQlRequest(URI, HttpHeaders, MultiValueMap, InetSocketAddress, Map, Map, String, Locale)

Create an instance.

Parameters:

uri - the URL for the HTTP request or WebSocket handshake

headers - the HTTP request headers

cookies - the HTTP request cookies

attributes - request attributes

body - the deserialized content of the GraphQL request

id - an identifier for the GraphQL request

locale - the locale from the HTTP request, if any

Since:

1.2.5

WebGraphQlRequest

@Deprecated(since="1.3.0",
            forRemoval=true)
public WebGraphQlRequest(URI uri,
 HttpHeaders headers,
 @Nullable
 MultiValueMap<String,HttpCookie> cookies,
 Map<String,Object> attributes,
 Map<String,Object> body,
 String id,
 @Nullable
 Locale locale)

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

since 1.3.0 in favor WebGraphQlRequest(URI, HttpHeaders, MultiValueMap, InetSocketAddress, Map, Map, String, Locale)

Create an instance.

Parameters:

uri - the URL for the HTTP request or WebSocket handshake

headers - the HTTP request headers

cookies - the HTTP request cookies

attributes - request attributes

body - the deserialized content of the GraphQL request

id - an identifier for the GraphQL request

locale - the locale from the HTTP request, if any

Since:

1.1.3

Method Details

getUri

public UriComponents getUri()

Return the URL for the HTTP request or WebSocket handshake.

getHeaders

public HttpHeaders getHeaders()

Return the HTTP headers of the request or WebSocket handshake.

getCookies

public MultiValueMap<String,HttpCookie> getCookies()

Return the cookies of the request of WebSocket handshake.

Since:

1.1.3

getRemoteAddress

@Nullable
public InetSocketAddress getRemoteAddress()

Return the remote address of the client, if available.

Since:

1.3.0

getAttributes

public Map<String,Object> getAttributes()

Return the request or WebSocket session attributes.

Since:

1.1.3