Package org.glassfish.tyrus.spi

Enum Class WebSocketEngine.UpgradeStatus

java.lang.Object

java.lang.Enum<WebSocketEngine.UpgradeStatus>

org.glassfish.tyrus.spi.WebSocketEngine.UpgradeStatus

All Implemented Interfaces:

Serializable, Comparable<WebSocketEngine.UpgradeStatus>, Constable

Enclosing interface:

WebSocketEngine

public static enum WebSocketEngine.UpgradeStatus
extends Enum<WebSocketEngine.UpgradeStatus>

Upgrade Status for HTTP request upgrading.

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
HANDSHAKE_FAILED	Upgrade failed due to version, extensions, origin check etc.
NOT_APPLICABLE	Not a WebSocketRequest or no mapping in the application.
SUCCESS	Upgrade is successful.

Method Summary

Modifier and Type	Method	Description
static WebSocketEngine.UpgradeStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebSocketEngine.UpgradeStatus[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_APPLICABLE

public static final WebSocketEngine.UpgradeStatus NOT_APPLICABLE

Not a WebSocketRequest or no mapping in the application. This may mean that HTTP request processing should continue (in servlet container, the next filter may be called).

HANDSHAKE_FAILED

public static final WebSocketEngine.UpgradeStatus HANDSHAKE_FAILED

Upgrade failed due to version, extensions, origin check etc. Tyrus would set an appropriate HTTP error status code in UpgradeResponse.

SUCCESS

public static final WebSocketEngine.UpgradeStatus SUCCESS

Upgrade is successful.

Method Details

values

public static WebSocketEngine.UpgradeStatus[] 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 WebSocketEngine.UpgradeStatus 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