Module java.httpclient

Package java.net.http

Class WebSocket.CloseCode

java.lang.Object

java.net.http.WebSocket.CloseCode

Enclosing interface:

WebSocket

public static final class WebSocket.CloseCode
extends Object

A WebSocket close status code.

Some codes specified in the WebSocket Protocol are defined as named constants here. Others can be retrieved on demand.

This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of CloseCode may have unpredictable results and should be avoided.

Since:

9

Field Summary

Fields

Modifier and Type	Field	Description
static WebSocket.CloseCode	CANNOT_ACCEPT	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).
static WebSocket.CloseCode	GOING_AWAY	Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
static WebSocket.CloseCode	NORMAL_CLOSURE	Indicates a normal close, meaning that the purpose for which the connection was established has been fulfilled.
static WebSocket.CloseCode	NOT_CONSISTENT	Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).
static WebSocket.CloseCode	PROTOCOL_ERROR	Indicates that an endpoint is terminating the connection due to a protocol error.
static WebSocket.CloseCode	TOO_BIG	Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
static WebSocket.CloseCode	UNEXPECTED_CONDITION	Indicates that an endpoint is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
static WebSocket.CloseCode	VIOLATED_POLICY	Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares this close code to the specified object.
int	getCode()	Returns a numerical representation of this close code.
int	hashCode()	Returns a hash code value for the object.
static WebSocket.CloseCode	of(int code)	Returns a CloseCode from its numerical representation.
String	toString()	Returns a human-readable representation of this close code.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CANNOT_ACCEPT

public static final WebSocket.CloseCode CANNOT_ACCEPT

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).

Numerical representation: 1003

GOING_AWAY

public static final WebSocket.CloseCode GOING_AWAY

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

Numerical representation: 1001

NORMAL_CLOSURE

public static final WebSocket.CloseCode NORMAL_CLOSURE

Indicates a normal close, meaning that the purpose for which the connection was established has been fulfilled.

Numerical representation: 1000

NOT_CONSISTENT

public static final WebSocket.CloseCode NOT_CONSISTENT

Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).

Numerical representation: 1007

PROTOCOL_ERROR

public static final WebSocket.CloseCode PROTOCOL_ERROR

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

Numerical representation: 1002

TOO_BIG

public static final WebSocket.CloseCode TOO_BIG

Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

Numerical representation: 1009

UNEXPECTED_CONDITION

public static final WebSocket.CloseCode UNEXPECTED_CONDITION

Indicates that an endpoint is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Numerical representation: 1011

VIOLATED_POLICY

public static final WebSocket.CloseCode VIOLATED_POLICY

Indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., CANNOT_ACCEPT or TOO_BIG) or if there is a need to hide specific details about the policy.

Numerical representation: 1008

Method Detail

of

public static WebSocket.CloseCode of(int code)

Returns a CloseCode from its numerical representation.

The given code should be in the range 1000 <= code <= 4999, and should not be equal to any of the following codes: 1004, 1005, 1006 and 1015.

Parameters:

code - numerical representation

Returns:

a close code corresponding to the provided numerical value

Throws:

IllegalArgumentException - if code violates any of the requirements above

getCode

public int getCode()

Returns a numerical representation of this close code.

Returns:

a numerical representation

equals

public boolean equals(Object o)

Compares this close code to the specified object.

Overrides:

equals in class Object

Parameters:

o - the object to compare this CloseCode against

Returns:

true iff the argument is a close code with the same numerical representation as this one

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns a human-readable representation of this close code.

Overrides:

toString in class Object

API Note:

The representation is not designed to be parsed; the format may change unexpectedly.

Returns:

a string representation