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

Constructor Summary

Constructors

Constructor and Description
WebSocketGraphQlRequest(URI uri, HttpHeaders headers, Map<String,Object> body, String id, Locale locale, WebSocketSessionInfo sessionInfo) Create an instance.

Method Summary

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

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

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 Detail

WebSocketGraphQlRequest

public WebSocketGraphQlRequest(URI uri,
                               HttpHeaders headers,
                               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

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

Method Detail

getSessionInfo

public WebSocketSessionInfo getSessionInfo()

Return information about the underlying WebSocket session.