GUACAMOLE-422: Clarify meaning of protocol capabilities.

This commit is contained in:
Michael Jumper
2019-06-08 12:44:00 -07:00
parent a247ec1edc
commit 9d1b264417

View File

@@ -20,29 +20,33 @@
package org.apache.guacamole.protocol; package org.apache.guacamole.protocol;
/** /**
* An enum that specifies protocol capabilities that can be used to help * Capabilities which may not be present in all versions of the Guacamole
* detect whether or not a particular protocol version contains a capability. * protocol.
*/ */
public enum GuacamoleProtocolCapability { public enum GuacamoleProtocolCapability {
/** /**
* Whether or not the protocol supports arbitrary ordering of the * The protocol does not require handshake instructions to be sent in a
* handshake instructions. This was introduced in VERSION_1_1_0. * specific order, nor that all handshake instructions be sent. Arbitrary
* handshake order was introduced in
* {@link GuacamoleProtocolVersion#VERSION_1_1_0}.
*/ */
ARBITRARY_HANDSHAKE_ORDER(GuacamoleProtocolVersion.VERSION_1_1_0), ARBITRARY_HANDSHAKE_ORDER(GuacamoleProtocolVersion.VERSION_1_1_0),
/** /**
* Whether or not the protocol supports the ability to dynamically * Negotiation of Guacamole protocol version between client and server
* detect the version client and server are running in order to allow * during the protocol handshake. The ability to negotiate protocol
* compatibility between differing client and server versions. This * versions was introduced in
* was introduced in VERSION_1_1_0. * {@link GuacamoleProtocolVersion#VERSION_1_1_0}.
*/ */
PROTOCOL_VERSION_DETECTION(GuacamoleProtocolVersion.VERSION_1_1_0), PROTOCOL_VERSION_DETECTION(GuacamoleProtocolVersion.VERSION_1_1_0),
/** /**
* Whether or not the protocol supports the timezone instruction during * Support for the "timezone" handshake instruction. The "timezone"
* the Client-Server handshake phase. This was introduced in * instruction allows the client to request that the server forward their
* VERSION_1_1_0. * local timezone for use within the remote desktop session. Support for
* forwarding the client timezone was introduced in
* {@link GuacamoleProtocolVersion#VERSION_1_1_0}.
*/ */
TIMEZONE_HANDSHAKE(GuacamoleProtocolVersion.VERSION_1_1_0); TIMEZONE_HANDSHAKE(GuacamoleProtocolVersion.VERSION_1_1_0);