org.mule.runtime.http.api.ws

Enum WebSocketCloseCode

java.lang.Object

java.lang.Enum<WebSocketCloseCode>

org.mule.runtime.http.api.ws.WebSocketCloseCode

All Implemented Interfaces:

Serializable, Comparable<WebSocketCloseCode>

@Experimental
public enum WebSocketCloseCode
extends Enum<WebSocketCloseCode>

The codes of the close frame that will be sent (or has been received) when closing a WebSocket

Since:

4.1.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENDPOINT_GOING_DOWN Indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.
INVALID_DATA Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g.
MESSAGE_TOO_LARGE indicates that an endpoint is terminating the connection because it has received a message that is too large.
NORMAL_CLOSURE Indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.
PROTOCOL_ERROR Indicates that an endpoint is terminating the connection due to a protocol error.

Method Summary

Modifier and Type	Method and Description
static WebSocketCloseCode	fromProtocolCode(int protocolCode) Returns the WebSocketCloseCode that matches the given raw protocolCode
int	getProtocolCode()
static WebSocketCloseCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebSocketCloseCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL_CLOSURE

public static final WebSocketCloseCode NORMAL_CLOSURE

Indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.

ENDPOINT_GOING_DOWN

public static final WebSocketCloseCode ENDPOINT_GOING_DOWN

Indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.

PROTOCOL_ERROR

public static final WebSocketCloseCode PROTOCOL_ERROR

Indicates that an endpoint is terminating the connection due to a protocol error.

INVALID_DATA

public static final WebSocketCloseCode INVALID_DATA

Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g. an endpoint that understands only text data may send this if it receives a binary message.)

MESSAGE_TOO_LARGE

public static final WebSocketCloseCode MESSAGE_TOO_LARGE

indicates that an endpoint is terminating the connection because it has received a message that is too large.

Method Detail

values

public static WebSocketCloseCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WebSocketCloseCode c : WebSocketCloseCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static WebSocketCloseCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

fromProtocolCode

public static WebSocketCloseCode fromProtocolCode(int protocolCode)

Returns the WebSocketCloseCode that matches the given raw protocolCode

Parameters:

protocolCode - a protocol level code

Returns:

a WebSocketCloseCode

Throws:

IllegalArgumentException - if the protocolCode doesn't match any of the items in this enum

getProtocolCode

public int getProtocolCode()