Package org.springframework.graphql.server.support

Enum Class GraphQlWebSocketMessageType

java.lang.Object

java.lang.Enum<GraphQlWebSocketMessageType>

org.springframework.graphql.server.support.GraphQlWebSocketMessageType

All Implemented Interfaces:

Serializable, Comparable<GraphQlWebSocketMessageType>, Constable

public enum GraphQlWebSocketMessageType
extends Enum<GraphQlWebSocketMessageType>

Enum for a message type as defined in the GraphQL over WebSocket spec proposal.

Since:

1.0.0

Author:

Rossen Stoyanchev

See Also:

• GraphQL Over WebSocket Protocol

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETE	Indicates that the requested operation execution has completed.
CONNECTION_ACK	Expected response to the CONNECTION_INIT message from the client acknowledging a successful connection with the server.
CONNECTION_INIT	Indicates that the client wants to establish a connection within the existing socket.
ERROR	Operation execution error(s) in response to the SUBSCRIBE message.
NEXT	Operation execution result(s) from the source stream created by the binding SUBSCRIBE message.
NOT_SPECIFIED	Indicates the GraphQL message did not have a message type.
PING	Useful for detecting failed connections, displaying latency metrics or other types of network probing.
PONG	The response to the PING message.
SUBSCRIBE	Requests an operation specified in the message payload.

Method Summary

Modifier and Type	Method	Description
boolean	doesNotRequirePayload()	Return if the message type has a payload, and it is required.
static GraphQlWebSocketMessageType	fromValue(String value)
String	toString()
String	value()	The protocol value for the message type.
static GraphQlWebSocketMessageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GraphQlWebSocketMessageType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONNECTION_INIT

public static final GraphQlWebSocketMessageType CONNECTION_INIT

Indicates that the client wants to establish a connection within the existing socket.

CONNECTION_ACK

public static final GraphQlWebSocketMessageType CONNECTION_ACK

Expected response to the CONNECTION_INIT message from the client acknowledging a successful connection with the server.

PING

public static final GraphQlWebSocketMessageType PING

Useful for detecting failed connections, displaying latency metrics or other types of network probing.

PONG

public static final GraphQlWebSocketMessageType PONG

The response to the PING message. Must be sent as soon as the PING message is received.

SUBSCRIBE

public static final GraphQlWebSocketMessageType SUBSCRIBE

Requests an operation specified in the message payload.

NEXT

public static final GraphQlWebSocketMessageType NEXT

Operation execution result(s) from the source stream created by the binding SUBSCRIBE message.

ERROR

public static final GraphQlWebSocketMessageType ERROR

Operation execution error(s) in response to the SUBSCRIBE message.

COMPLETE

public static final GraphQlWebSocketMessageType COMPLETE

Indicates that the requested operation execution has completed.

NOT_SPECIFIED

public static final GraphQlWebSocketMessageType NOT_SPECIFIED

Indicates the GraphQL message did not have a message type.

Method Details

values

public static GraphQlWebSocketMessageType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GraphQlWebSocketMessageType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

The protocol value for the message type.

doesNotRequirePayload

public boolean doesNotRequirePayload()

Return if the message type has a payload, and it is required.

fromValue

public static GraphQlWebSocketMessageType fromValue(String value)

toString

public String toString()

Overrides:

toString in class Enum<GraphQlWebSocketMessageType>