org.mule.runtime.http.api.ws

Enum WebSocketProtocol

java.lang.Object

java.lang.Enum<WebSocketProtocol>

org.mule.runtime.http.api.ws.WebSocketProtocol

All Implemented Interfaces:

Serializable, Comparable<WebSocketProtocol>

@Experimental
public enum WebSocketProtocol
extends Enum<WebSocketProtocol>

The supported protocols

Enum Constant Summary

Enum Constants

Enum Constant and Description
WS ws protocol.
WSS wss protocol.

Method Summary

Modifier and Type	Method and Description
static WebSocketProtocol	forScheme(String scheme) Returns the WebSocketProtocol that corresponds to the given scheme
String	getScheme()
static WebSocketProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebSocketProtocol[]	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

WS

public static final WebSocketProtocol WS

ws protocol. Used when the Upgrade request was sent over standard HTTP

WSS

public static final WebSocketProtocol WSS

wss protocol. Used when the Upgrade request was sent over standard HTTPS

Method Detail

values

public static WebSocketProtocol[] 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 (WebSocketProtocol c : WebSocketProtocol.values())
    System.out.println(c);

Returns:

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

valueOf

public static WebSocketProtocol 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

forScheme

public static WebSocketProtocol forScheme(String scheme)

Returns the WebSocketProtocol that corresponds to the given scheme

Parameters:

scheme - a scheme

Returns:

a WebSocketProtocol

Throws:

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

getScheme

public String getScheme()