org.glyptodon.guacamole.protocol

Enum GuacamoleStatus

java.lang.Object

java.lang.Enum<GuacamoleStatus>

org.glyptodon.guacamole.protocol.GuacamoleStatus

All Implemented Interfaces:

Serializable, Comparable<GuacamoleStatus>

public enum GuacamoleStatus
extends Enum<GuacamoleStatus>

All possible statuses returned by various Guacamole instructions, each having a corresponding code.

Author:

Michael Jumper

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_BAD_REQUEST The operation could not be performed because bad parameters were given.
CLIENT_BAD_TYPE The client sent data of an unsupported or unexpected type.
CLIENT_FORBIDDEN Permission was denied to perform the operation, and this operation will not be granted even if the user is authorized.
CLIENT_OVERRUN The client sent too much data.
CLIENT_TIMEOUT The client took too long to respond.
CLIENT_TOO_MANY The operation failed because the current client is already using too many resources.
CLIENT_UNAUTHORIZED Permission was denied to perform the operation, as the user is not yet authorized (not yet logged in, for example).
RESOURCE_CONFLICT The operation could not be performed as the requested resource is already in use.
RESOURCE_NOT_FOUND The operation could not be performed as the requested resource does not exist.
SERVER_BUSY The operation could not be performed as the server is busy.
SERVER_ERROR The operation could not be performed due to an internal failure.
SUCCESS The operation succeeded.
UNSUPPORTED The requested operation is unsupported.
UPSTREAM_ERROR The operation was unsuccessful due to an error or otherwise unexpected condition of the upstream server.
UPSTREAM_TIMEOUT The operation could not be performed because the upstream server is not responding.

Method Summary

Methods

Modifier and Type	Method and Description
int	getGuacamoleStatusCode() Returns the corresponding Guacamole protocol status code.
int	getHttpStatusCode() Returns the most applicable HTTP error code.
int	getWebSocketCode() Returns the most applicable HTTP error code.
static GuacamoleStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static GuacamoleStatus[]	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

SUCCESS

public static final GuacamoleStatus SUCCESS

The operation succeeded.

UNSUPPORTED

public static final GuacamoleStatus UNSUPPORTED

The requested operation is unsupported.

SERVER_ERROR

public static final GuacamoleStatus SERVER_ERROR

The operation could not be performed due to an internal failure.

SERVER_BUSY

public static final GuacamoleStatus SERVER_BUSY

The operation could not be performed as the server is busy.

UPSTREAM_TIMEOUT

public static final GuacamoleStatus UPSTREAM_TIMEOUT

The operation could not be performed because the upstream server is not responding.

UPSTREAM_ERROR

public static final GuacamoleStatus UPSTREAM_ERROR

The operation was unsuccessful due to an error or otherwise unexpected condition of the upstream server.

RESOURCE_NOT_FOUND

public static final GuacamoleStatus RESOURCE_NOT_FOUND

The operation could not be performed as the requested resource does not exist.

RESOURCE_CONFLICT

public static final GuacamoleStatus RESOURCE_CONFLICT

The operation could not be performed as the requested resource is already in use.

CLIENT_BAD_REQUEST

public static final GuacamoleStatus CLIENT_BAD_REQUEST

The operation could not be performed because bad parameters were given.

CLIENT_UNAUTHORIZED

public static final GuacamoleStatus CLIENT_UNAUTHORIZED

Permission was denied to perform the operation, as the user is not yet authorized (not yet logged in, for example). As HTTP 401 has implications for HTTP-specific authorization schemes, this status continues to map to HTTP 403 ("Forbidden"). To do otherwise would risk unintended effects.

CLIENT_FORBIDDEN

public static final GuacamoleStatus CLIENT_FORBIDDEN

Permission was denied to perform the operation, and this operation will not be granted even if the user is authorized.

CLIENT_TIMEOUT

public static final GuacamoleStatus CLIENT_TIMEOUT

The client took too long to respond.

CLIENT_OVERRUN

public static final GuacamoleStatus CLIENT_OVERRUN

The client sent too much data.

CLIENT_BAD_TYPE

public static final GuacamoleStatus CLIENT_BAD_TYPE

The client sent data of an unsupported or unexpected type.

CLIENT_TOO_MANY

public static final GuacamoleStatus CLIENT_TOO_MANY

The operation failed because the current client is already using too many resources.

Method Detail

values

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

Returns:

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

valueOf

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

getHttpStatusCode

public int getHttpStatusCode()

Returns the most applicable HTTP error code.

Returns:

The most applicable HTTP error code.

getWebSocketCode

public int getWebSocketCode()

Returns the most applicable HTTP error code.

Returns:

The most applicable HTTP error code.

getGuacamoleStatusCode

public int getGuacamoleStatusCode()

Returns the corresponding Guacamole protocol status code.

Returns:

The corresponding Guacamole protocol status code.