Package org.apache.guacamole.protocol
Enum GuacamoleProtocolCapability
- java.lang.Object
-
- java.lang.Enum<GuacamoleProtocolCapability>
-
- org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
- All Implemented Interfaces:
Serializable
,Comparable<GuacamoleProtocolCapability>
public enum GuacamoleProtocolCapability extends Enum<GuacamoleProtocolCapability>
Capabilities which may not be present in all versions of the Guacamole protocol.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ARBITRARY_HANDSHAKE_ORDER
The protocol does not require handshake instructions to be sent in a specific order, nor that all handshake instructions be sent.PROTOCOL_VERSION_DETECTION
Negotiation of Guacamole protocol version between client and server during the protocol handshake.REQUIRED_INSTRUCTION
Support for the "required" instruction.TIMEZONE_HANDSHAKE
Support for the "timezone" handshake instruction.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isSupported(GuacamoleProtocolVersion version)
Returns whether this capability is supported in the given Guacamole protocol version.static GuacamoleProtocolCapability
valueOf(String name)
Returns the enum constant of this type with the specified name.static GuacamoleProtocolCapability[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ARBITRARY_HANDSHAKE_ORDER
public static final GuacamoleProtocolCapability ARBITRARY_HANDSHAKE_ORDER
The protocol does not require handshake instructions to be sent in a specific order, nor that all handshake instructions be sent. Arbitrary handshake order was introduced inGuacamoleProtocolVersion.VERSION_1_1_0
.
-
PROTOCOL_VERSION_DETECTION
public static final GuacamoleProtocolCapability PROTOCOL_VERSION_DETECTION
Negotiation of Guacamole protocol version between client and server during the protocol handshake. The ability to negotiate protocol versions was introduced inGuacamoleProtocolVersion.VERSION_1_1_0
.
-
REQUIRED_INSTRUCTION
public static final GuacamoleProtocolCapability REQUIRED_INSTRUCTION
Support for the "required" instruction. The "required" instruction allows the server to explicitly request connection parameters from the client without which the connection cannot continue, such as user credentials. Support for this instruction was introduced inGuacamoleProtocolVersion.VERSION_1_3_0
.
-
TIMEZONE_HANDSHAKE
public static final GuacamoleProtocolCapability TIMEZONE_HANDSHAKE
Support for the "timezone" handshake instruction. The "timezone" instruction allows the client to request that the server forward their local timezone for use within the remote desktop session. Support for forwarding the client timezone was introduced inGuacamoleProtocolVersion.VERSION_1_1_0
.
-
-
Method Detail
-
values
public static GuacamoleProtocolCapability[] 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 (GuacamoleProtocolCapability c : GuacamoleProtocolCapability.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GuacamoleProtocolCapability 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 nameNullPointerException
- if the argument is null
-
isSupported
public boolean isSupported(GuacamoleProtocolVersion version)
Returns whether this capability is supported in the given Guacamole protocol version.- Parameters:
version
- The Guacamole protocol version to check.- Returns:
- true if this capability is supported by the given protocol version, false otherwise.
-
-