Package org.springframework.graphql.server

Class WebSocketGraphQlRequest

java.lang.Object

org.springframework.graphql.support.DefaultGraphQlRequest

org.springframework.graphql.support.DefaultExecutionGraphQlRequest

org.springframework.graphql.server.WebGraphQlRequest

org.springframework.graphql.server.WebSocketGraphQlRequest

All Implemented Interfaces:

ExecutionGraphQlRequest, GraphQlRequest

public class WebSocketGraphQlRequest
extends WebGraphQlRequest

WebGraphQlRequest extension for server handling of GraphQL over WebSocket requests.

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
WebSocketGraphQlRequest(URI uri, HttpHeaders headers, Map<String,Object> body, String id, Locale locale, WebSocketSessionInfo sessionInfo)	Deprecated, for removal: This API element is subject to removal in a future version. as of 1.1.3 in favor of the constructor with cookies
WebSocketGraphQlRequest(URI uri, HttpHeaders headers, MultiValueMap<String,HttpCookie> cookies, Map<String,Object> attributes, Map<String,Object> body, String id, Locale locale, WebSocketSessionInfo sessionInfo)	Create an instance.

Method Summary

Modifier and Type	Method	Description
WebSocketSessionInfo	getSessionInfo()	Return information about the underlying WebSocket session.

Methods inherited from class org.springframework.graphql.server.WebGraphQlRequest

getAttributes, getCookies, getHeaders, getUri

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

WebSocketGraphQlRequest

@Deprecated(since="1.1.3",
            forRemoval=true)
public WebSocketGraphQlRequest(URI uri,
 HttpHeaders headers,
 Map<String,Object> body,
 String id,
 @Nullable
 Locale locale,
 WebSocketSessionInfo sessionInfo)

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

as of 1.1.3 in favor of the constructor with cookies

Create an instance.

Parameters:

uri - the URL for the HTTP request or WebSocket handshake

headers - the HTTP request headers

body - the deserialized content of the GraphQL request

id - the id from the GraphQL over WebSocket "subscribe" message

locale - the locale from the HTTP request, if any

sessionInfo - the WebSocket session id

WebSocketGraphQlRequest

public WebSocketGraphQlRequest(URI uri,
 HttpHeaders headers,
 @Nullable
 MultiValueMap<String,HttpCookie> cookies,
 Map<String,Object> attributes,
 Map<String,Object> body,
 String id,
 @Nullable
 Locale locale,
 WebSocketSessionInfo sessionInfo)

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 - session attributes

body - the deserialized content of the GraphQL request

id - the id from the GraphQL over WebSocket "subscribe" message

locale - the locale from the HTTP request, if any

sessionInfo - the WebSocket session id

Since:

1.1.3

Method Details

getSessionInfo

public WebSocketSessionInfo getSessionInfo()

Return information about the underlying WebSocket session.