Package org.springframework.graphql.server.webmvc

Class GraphQlWebSocketHandler

java.lang.Object

org.springframework.web.socket.handler.AbstractWebSocketHandler

org.springframework.web.socket.handler.TextWebSocketHandler

org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler

All Implemented Interfaces:

SubProtocolCapable, WebSocketHandler

@RegisterReflectionForBinding(GraphQlWebSocketMessage.class)
public class GraphQlWebSocketHandler
extends TextWebSocketHandler
implements SubProtocolCapable

WebSocketHandler for GraphQL based on GraphQL Over WebSocket Protocol and for use on a Servlet container with spring-websocket.

Since:

1.0.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<?> converter, Duration connectionInitTimeout)	Create a new instance.
GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler, HttpMessageConverter<?> converter, Duration connectionInitTimeout, Duration keepAliveDuration)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void	afterConnectionEstablished(WebSocketSession session)
WebSocketHttpRequestHandler	asWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler)	Deprecated, for removal: This API element is subject to removal in a future version. as of 1.1.0 in favor of initWebSocketHttpRequestHandler(HandshakeHandler)
List<String>	getSubProtocols()
protected void	handleTextMessage(WebSocketSession session, TextMessage webSocketMessage)
WebSocketHttpRequestHandler	initWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler)	Initialize a WebSocketHttpRequestHandler that wraps this instance and also inserts a HandshakeInterceptor for context propagation.

Methods inherited from class org.springframework.web.socket.handler.TextWebSocketHandler

handleBinaryMessage

Methods inherited from class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleMessage, handlePongMessage, handleTransportError, supportsPartialMessages

Methods inherited from class java.lang.Object

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

Constructor Details

GraphQlWebSocketHandler

public GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler,
 HttpMessageConverter<?> converter,
 Duration connectionInitTimeout)

Create a new instance.

Parameters:

graphQlHandler - common handler for GraphQL over WebSocket requests

converter - for JSON encoding and decoding

connectionInitTimeout - how long to wait after the establishment of the WebSocket for the "connection_ini" message from the client.

GraphQlWebSocketHandler

public GraphQlWebSocketHandler(WebGraphQlHandler graphQlHandler,
 HttpMessageConverter<?> converter,
 Duration connectionInitTimeout,
 @Nullable
 Duration keepAliveDuration)

Create a new instance.

Parameters:

graphQlHandler - common handler for GraphQL over WebSocket requests

converter - for JSON encoding and decoding

connectionInitTimeout - how long to wait after the establishment of the WebSocket for the "connection_ini" message from the client.

keepAliveDuration - how frequently to send ping messages; if not set then ping messages are not sent.

Since:

1.3

Method Details

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface SubProtocolCapable

initWebSocketHttpRequestHandler

public WebSocketHttpRequestHandler initWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler)

Initialize a WebSocketHttpRequestHandler that wraps this instance and also inserts a HandshakeInterceptor for context propagation.

Parameters:

handshakeHandler - the handler for WebSocket handshake

Since:

1.1.0

asWebSocketHttpRequestHandler

@Deprecated(since="1.1.0",
            forRemoval=true)
public WebSocketHttpRequestHandler asWebSocketHttpRequestHandler(HandshakeHandler handshakeHandler)

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

as of 1.1.0 in favor of initWebSocketHttpRequestHandler(HandshakeHandler)

Return a WebSocketHttpRequestHandler that uses this instance as its WebGraphQlHandler and adds a HandshakeInterceptor to propagate context.

Parameters:

handshakeHandler - the handler for WebSocket handshake

afterConnectionEstablished

public void afterConnectionEstablished(WebSocketSession session)

Specified by:

afterConnectionEstablished in interface WebSocketHandler

Overrides:

afterConnectionEstablished in class AbstractWebSocketHandler

handleTextMessage

protected void handleTextMessage(WebSocketSession session,
 TextMessage webSocketMessage)
                          throws Exception

Overrides:

handleTextMessage in class AbstractWebSocketHandler

Throws:

Exception

afterConnectionClosed

public void afterConnectionClosed(WebSocketSession session,
 CloseStatus closeStatus)

Specified by:

afterConnectionClosed in interface WebSocketHandler

Overrides:

afterConnectionClosed in class AbstractWebSocketHandler