Spring Framework 6.1.4 · org.springframework.web.reactive.socket.CloseStatus

Field Summary

Modifier and Type	Field and Description
public static final CloseStatus	BAD_DATA "1007 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)."
private final int	code
public static final CloseStatus	GOING_AWAY "1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page."
public static final CloseStatus	NO_CLOSE_FRAME "1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
public static final CloseStatus	NO_STATUS_CODE "1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
public static final CloseStatus	NORMAL "1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled."
public static final CloseStatus	NOT_ACCEPTABLE "1003 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)."
public static final CloseStatus	POLICY_VIOLATION "1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
public static final CloseStatus	PROTOCOL_ERROR "1002 indicates that an endpoint is terminating the connection due to a protocol error."
private final String	reason
public static final CloseStatus	REQUIRED_EXTENSION "1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
public static final CloseStatus	SERVER_ERROR "1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request."
public static final CloseStatus	SERVICE_OVERLOAD "1013 indicates that the service is experiencing overload.
public static final CloseStatus	SERVICE_RESTARTED "1012 indicates that the service is restarted.
public static final CloseStatus	TLS_HANDSHAKE_FAILURE "1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
public static final CloseStatus	TOO_BIG_TO_PROCESS "1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process."

Constructor Summary

Access	Constructor and Description
public	CloseStatus(int the status code code) Create a new `CloseStatus` instance.
public	CloseStatus(int the status code code, String the reason reason) Create a new `CloseStatus` instance.

Method Summary

Modifier and Type	Method and Description
public static CloseStatus	create(int code, String reason) Return a constant for the given code, or create a new instance if the code does not match or there is a reason.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	equalsCode(CloseStatus other) Deprecated as of 5.3 in favor of comparing codes directly
public int	getCode() Return the status code.
public String	getReason() Return the reason, or `null` if none.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public CloseStatus	Returns: a new `CloseStatus` instance withReason(String the reason reason) Create a new `CloseStatus` from this one with the specified reason.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

BAD_DATA	back to summary
public static final CloseStatus BAD_DATA "1007 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)."

code	back to summary
private final int code

GOING_AWAY	back to summary
public static final CloseStatus GOING_AWAY "1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page."

NO_CLOSE_FRAME	back to summary
public static final CloseStatus NO_CLOSE_FRAME "1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame."

NO_STATUS_CODE	back to summary
public static final CloseStatus NO_STATUS_CODE "1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present."

NORMAL	back to summary
public static final CloseStatus NORMAL "1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled."

NOT_ACCEPTABLE	back to summary
public static final CloseStatus NOT_ACCEPTABLE "1003 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)."

POLICY_VIOLATION	back to summary
public static final CloseStatus POLICY_VIOLATION "1008 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., 1003 or 1009) or if there is a need to hide specific details about the policy."

PROTOCOL_ERROR	back to summary
public static final CloseStatus PROTOCOL_ERROR "1002 indicates that an endpoint is terminating the connection due to a protocol error."

reason	back to summary
private final String reason Annotations @Nullable

REQUIRED_EXTENSION	back to summary
public static final CloseStatus REQUIRED_EXTENSION "1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. The list of extensions that are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead."

REQUIRED_EXTENSION

back to summary

public static final CloseStatus REQUIRED_EXTENSION

"1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. The list of extensions that are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead."

SERVER_ERROR	back to summary
public static final CloseStatus SERVER_ERROR "1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request."

SERVICE_OVERLOAD	back to summary
public static final CloseStatus SERVICE_OVERLOAD "1013 indicates that the service is experiencing overload. A client should only connect to a different IP (when there are multiple for the target) or reconnect to the same IP upon user action."

SERVICE_RESTARTED	back to summary
public static final CloseStatus SERVICE_RESTARTED "1012 indicates that the service is restarted. A client may reconnect, and if it chooses to do, should reconnect using a randomized delay of 5 - 30s."

TLS_HANDSHAKE_FAILURE	back to summary
public static final CloseStatus TLS_HANDSHAKE_FAILURE "1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified)."

TOO_BIG_TO_PROCESS	back to summary
public static final CloseStatus TOO_BIG_TO_PROCESS "1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process."

Constructor Detail

CloseStatus back to summary

CloseStatus	back to summary
public CloseStatus(int code) Create a new `CloseStatus` instance. Parameters code:int the status code

public CloseStatus(int code)

Create a new CloseStatus instance.

Parameters

code:int: the status code

CloseStatus back to summary

CloseStatus	back to summary
public CloseStatus(int code, String reason) Create a new `CloseStatus` instance. Parameters code:int the status code reason:String the reason

public CloseStatus(int code, String reason)

Create a new CloseStatus instance.

Parameters

code:int: the status code
reason:String: the reason

Method Detail

create	back to summary
public static CloseStatus create(int code, String reason) Return a constant for the given code, or create a new instance if the code does not match or there is a reason. Since 5.3

create

back to summary

public static CloseStatus create(int code, String reason)

Return a constant for the given code, or create a new instance if the code does not match or there is a reason.

Since: 5.3

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equalsCode	back to summary
public boolean equalsCode(CloseStatus other) Deprecated as of 5.3 in favor of comparing codes directly Annotations @Deprecated

getCode	back to summary
public int getCode() Return the status code.

getReason back to summary

getReason	back to summary
public String getReason() Return the reason, or `null` if none. Annotations @Nullable

public String getReason()

Return the reason, or null if none.

Annotations

@Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.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` 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 `equals` 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. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 equals 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.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

withReason back to summary

withReason	back to summary
public CloseStatus withReason(String reason) Create a new `CloseStatus` from this one with the specified reason. Parameters reason:String the reason Returns:CloseStatus a new `CloseStatus` instance

public CloseStatus withReason(String reason)

Create a new CloseStatus from this one with the specified reason.

Parameters

reason:String: the reason

Returns:CloseStatus

a new CloseStatus instance

public final Class CloseStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail