A C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractGuacamoleTunnel - Class in org.apache.guacamole.net
-
Base GuacamoleTunnel implementation which synchronizes access to the underlying reader and writer with reentrant locks.
- AbstractGuacamoleTunnel() - Constructor for class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Creates a new GuacamoleTunnel which synchronizes access to the Guacamole instruction stream associated with the underlying GuacamoleSocket.
- acquireReader() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Acquires exclusive read access to the Guacamole instruction stream and returns a GuacamoleReader for reading from that stream.
- acquireReader() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- acquireReader() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Acquires exclusive read access to the Guacamole instruction stream and returns a GuacamoleReader for reading from that stream.
- acquireWriter() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Acquires exclusive write access to the Guacamole instruction stream and returns a GuacamoleWriter for writing to that stream.
- acquireWriter() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- acquireWriter() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Acquires exclusive write access to the Guacamole instruction stream and returns a GuacamoleWriter for writing to that stream.
- append(char[]) - Method in class org.apache.guacamole.protocol.GuacamoleParser
-
Appends data from the given buffer to the current instruction.
- append(char[], int, int) - Method in class org.apache.guacamole.protocol.GuacamoleParser
-
Appends data from the given buffer to the current instruction.
- ARBITRARY_HANDSHAKE_ORDER - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
The protocol does not require handshake instructions to be sent in a specific order, nor that all handshake instructions be sent.
- atLeast(GuacamoleProtocolVersion) - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Returns whether this GuacamoleProtocolVersion is at least as recent as (greater than or equal to) the given version.
- available() - Method in interface org.apache.guacamole.io.GuacamoleReader
-
Returns whether instruction data is available for reading.
- available() - Method in class org.apache.guacamole.io.ReaderGuacamoleReader
- available() - Method in class org.apache.guacamole.protocol.FilteredGuacamoleReader
C
- CLIENT_BAD_REQUEST - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed because bad parameters were given.
- CLIENT_BAD_TYPE - org.apache.guacamole.protocol.GuacamoleStatus
-
The client sent data of an unsupported or unexpected type.
- CLIENT_FORBIDDEN - org.apache.guacamole.protocol.GuacamoleStatus
-
Permission was denied to perform the operation, and this operation will not be granted even if the user is authorized.
- CLIENT_OVERRUN - org.apache.guacamole.protocol.GuacamoleStatus
-
The client sent too much data.
- CLIENT_TIMEOUT - org.apache.guacamole.protocol.GuacamoleStatus
-
The client took too long to respond.
- CLIENT_TOO_MANY - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation failed because the current client is already using too many resources.
- CLIENT_UNAUTHORIZED - org.apache.guacamole.protocol.GuacamoleStatus
-
Permission was denied to perform the operation, as the user is not yet authorized (not yet logged in, for example).
- close() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
- close() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
- close() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- close() - Method in interface org.apache.guacamole.net.GuacamoleSocket
-
Releases all resources in use by the connection represented by this GuacamoleSocket.
- close() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Release all resources allocated to this GuacamoleTunnel.
- close() - Method in class org.apache.guacamole.net.InetGuacamoleSocket
- close() - Method in class org.apache.guacamole.net.SSLGuacamoleSocket
- ConfiguredGuacamoleSocket - Class in org.apache.guacamole.protocol
-
A GuacamoleSocket which pre-configures the connection based on a given GuacamoleConfiguration, completing the initial protocol handshake before accepting data for read or write.
- ConfiguredGuacamoleSocket(GuacamoleSocket, GuacamoleConfiguration) - Constructor for class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
-
Creates a new ConfiguredGuacamoleSocket which uses the given GuacamoleConfiguration to complete the initial protocol handshake over the given GuacamoleSocket.
- ConfiguredGuacamoleSocket(GuacamoleSocket, GuacamoleConfiguration, GuacamoleClientInformation) - Constructor for class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
-
Creates a new ConfiguredGuacamoleSocket which uses the given GuacamoleConfiguration and GuacamoleClientInformation to complete the initial protocol handshake over the given GuacamoleSocket.
- createTunnel(Session, EndpointConfig) - Method in class org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint
-
Returns a new tunnel for the given session.
D
- DelegatingGuacamoleSocket - Class in org.apache.guacamole.net
-
GuacamoleSocket implementation which simply delegates all function calls to an underlying GuacamoleSocket.
- DelegatingGuacamoleSocket(GuacamoleSocket) - Constructor for class org.apache.guacamole.net.DelegatingGuacamoleSocket
-
Wraps the given GuacamoleSocket such that all function calls against this DelegatingGuacamoleSocket will be delegated to it.
- DelegatingGuacamoleTunnel - Class in org.apache.guacamole.net
-
GuacamoleTunnel implementation which simply delegates all function calls to an underlying GuacamoleTunnel.
- DelegatingGuacamoleTunnel(GuacamoleTunnel) - Constructor for class org.apache.guacamole.net.DelegatingGuacamoleTunnel
-
Wraps the given tunnel such that all function calls against this tunnel will be delegated to it.
- deregisterTunnel(String) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Deregisters the HTTP tunnel associated with the given tunnel-specific session token such that future read/write requests to that tunnel will be rejected.
- deregisterTunnel(GuacamoleTunnel) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Deprecated.This function has been deprecated in favor of
deregisterTunnel(java.lang.String)
, which decouples identification of HTTP tunnel sessions from the tunnel UUID. - destroy() - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
- doConnect(HttpServletRequest) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Called whenever the JavaScript Guacamole client makes a connection request via HTTP.
- doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
- doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
- doRead(HttpServletRequest, HttpServletResponse, String) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Called whenever the JavaScript Guacamole client makes a read request.
- doWrite(HttpServletRequest, HttpServletResponse, String) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Called whenever the JavaScript Guacamole client makes a write request.
E
- equals(Object) - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
F
- FailoverGuacamoleSocket - Class in org.apache.guacamole.protocol
-
GuacamoleSocket which intercepts errors received early in the Guacamole session.
- FailoverGuacamoleSocket(GuacamoleSocket) - Constructor for class org.apache.guacamole.protocol.FailoverGuacamoleSocket
-
Creates a new FailoverGuacamoleSocket which reads Guacamole instructions from the given socket, searching for errors from the upstream remote desktop until a maximum of 128KB of instruction data has been queued.
- FailoverGuacamoleSocket(GuacamoleSocket, int) - Constructor for class org.apache.guacamole.protocol.FailoverGuacamoleSocket
-
Creates a new FailoverGuacamoleSocket which reads Guacamole instructions from the given socket, searching for errors from the upstream remote desktop until the given instruction queue limit is reached.
- filter(GuacamoleInstruction) - Method in interface org.apache.guacamole.protocol.GuacamoleFilter
-
Applies the filter to the given instruction, returning the original instruction, a modified version of the original, or null, depending on the implementation.
- FilteredGuacamoleReader - Class in org.apache.guacamole.protocol
-
GuacamoleReader which applies a given GuacamoleFilter to observe or alter all read instructions.
- FilteredGuacamoleReader(GuacamoleReader, GuacamoleFilter) - Constructor for class org.apache.guacamole.protocol.FilteredGuacamoleReader
-
Wraps the given GuacamoleReader, applying the given filter to all read instructions.
- FilteredGuacamoleSocket - Class in org.apache.guacamole.protocol
-
Implementation of GuacamoleSocket which allows individual instructions to be intercepted, overridden, etc.
- FilteredGuacamoleSocket(GuacamoleSocket, GuacamoleFilter, GuacamoleFilter) - Constructor for class org.apache.guacamole.protocol.FilteredGuacamoleSocket
-
Creates a new FilteredGuacamoleSocket which uses the given filters to determine whether instructions read/written are allowed through, modified, etc.
- FilteredGuacamoleWriter - Class in org.apache.guacamole.protocol
-
GuacamoleWriter which applies a given GuacamoleFilter to observe or alter all written instructions.
- FilteredGuacamoleWriter(GuacamoleWriter, GuacamoleFilter) - Constructor for class org.apache.guacamole.protocol.FilteredGuacamoleWriter
-
Wraps the given GuacamoleWriter, applying the given filter to all written instructions.
- fromGuacamoleStatusCode(int) - Static method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns the GuacamoleStatus corresponding to the given Guacamole protocol status code.
G
- generateToken() - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Generates a new, securely-random session token that may be used to represent the ongoing communication session of a distinct HTTP tunnel connection.
- getArgs() - Method in class org.apache.guacamole.protocol.GuacamoleInstruction
-
Returns a List of all argument values specified for this GuacamoleInstruction.
- getAudioMimetypes() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the list of audio mimetypes supported by the client.
- getConfiguration() - Method in class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
-
Returns the GuacamoleConfiguration used to configure this ConfiguredGuacamoleSocket.
- getConnectionID() - Method in class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
-
Returns the unique ID associated with the Guacamole connection negotiated by this ConfiguredGuacamoleSocket.
- getConnectionID() - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Returns the ID of the connection being joined, if any.
- getDelegateSocket() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
-
Returns the underlying GuacamoleSocket wrapped by this DelegatingGuacamoleSocket.
- getGuacamoleStatusCode() - Method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns the corresponding Guacamole protocol status code.
- getHttpStatusCode() - Method in exception org.apache.guacamole.GuacamoleException
-
Returns the most applicable HTTP status code that can be associated with this exception.
- getHttpStatusCode() - Method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns the most applicable HTTP error code.
- getImageMimetypes() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the list of image mimetypes supported by the client.
- getMajor() - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Return the major version component of the protocol version.
- getMinor() - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Return the minor version component of the protocol version.
- getName() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the name of the Guacamole user as reported by the client, or null if the user name is not set.
- getOpcode() - Method in class org.apache.guacamole.protocol.GuacamoleInstruction
-
Returns the opcode associated with this GuacamoleInstruction.
- getOptimalResolution() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the resolution of the screen if the optimal width and height are used, in DPI.
- getOptimalScreenHeight() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the optimal screen height requested by the client, in pixels.
- getOptimalScreenWidth() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the optimal screen width requested by the client, in pixels.
- getParameter(String) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Returns the value set for the parameter with the given name, if any.
- getParameterNames() - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Returns a set of all currently defined parameter names.
- getParameters() - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Returns a map which contains parameter name/value pairs as key/value pairs.
- getPatch() - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Return the patch version component of the protocol version.
- getProtocol() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
- getProtocol() - Method in interface org.apache.guacamole.net.GuacamoleSocket
-
Returns the name of the protocol to be used.
- getProtocol() - Method in class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
- getProtocol() - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Returns the name of the protocol to be used.
- getProtocolVersion() - Method in class org.apache.guacamole.protocol.ConfiguredGuacamoleSocket
-
Returns the version of the Guacamole protocol associated with the Guacamole connection negotiated by this ConfiguredGuacamoleSocket.
- getReader() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
- getReader() - Method in interface org.apache.guacamole.net.GuacamoleSocket
-
Returns a GuacamoleReader which can be used to read from the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
- getReader() - Method in class org.apache.guacamole.net.InetGuacamoleSocket
- getReader() - Method in class org.apache.guacamole.net.SSLGuacamoleSocket
- getReader() - Method in class org.apache.guacamole.protocol.FailoverGuacamoleSocket
- getReader() - Method in class org.apache.guacamole.protocol.FilteredGuacamoleSocket
- getSocket() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- getSocket() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Returns the GuacamoleSocket used by this GuacamoleTunnel for reading and writing.
- getSocket() - Method in class org.apache.guacamole.net.SimpleGuacamoleTunnel
- getStatus() - Method in exception org.apache.guacamole.GuacamoleClientBadTypeException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleClientException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleClientOverrunException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleClientTimeoutException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleClientTooManyException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleConnectionClosedException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleException
-
Returns the Guacamole status associated with this exception.
- getStatus() - Method in exception org.apache.guacamole.GuacamoleResourceClosedException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleResourceConflictException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleResourceNotFoundException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleSecurityException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleServerBusyException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleServerException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleSessionClosedException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleSessionConflictException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleSessionTimeoutException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUnauthorizedException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUnsupportedException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUpstreamException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUpstreamNotFoundException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUpstreamTimeoutException
- getStatus() - Method in exception org.apache.guacamole.GuacamoleUpstreamUnavailableException
- getTimezone() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Return the timezone as reported by the client, or null if the timezone is not set.
- getTunnel(String) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Returns the tunnel associated with the given tunnel-specific session token, if it has been registered with
registerTunnel(java.lang.String, org.apache.guacamole.net.GuacamoleTunnel)
and not yet deregistered withderegisterTunnel(java.lang.String)
. - getUUID() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- getUUID() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Returns the unique identifier associated with this GuacamoleTunnel.
- getUUID() - Method in class org.apache.guacamole.net.SimpleGuacamoleTunnel
- getVideoMimetypes() - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Returns the list of video mimetypes supported by the client.
- getWebSocketCode() - Method in exception org.apache.guacamole.GuacamoleException
-
Returns the most applicable WebSocket status code that can be associated with this exception.
- getWebSocketCode() - Method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns the most applicable HTTP error code.
- getWriter() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
- getWriter() - Method in interface org.apache.guacamole.net.GuacamoleSocket
-
Returns a GuacamoleWriter which can be used to write to the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
- getWriter() - Method in class org.apache.guacamole.net.InetGuacamoleSocket
- getWriter() - Method in class org.apache.guacamole.net.SSLGuacamoleSocket
- getWriter() - Method in class org.apache.guacamole.protocol.FilteredGuacamoleSocket
- GuacamoleClientBadTypeException - Exception in org.apache.guacamole
-
An exception which is thrown when data has been submitted with an unsupported mimetype.
- GuacamoleClientBadTypeException(String) - Constructor for exception org.apache.guacamole.GuacamoleClientBadTypeException
-
Creates a new GuacamoleClientBadTypeException with the given message.
- GuacamoleClientBadTypeException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientBadTypeException
-
Creates a new GuacamoleClientBadTypeException with the given message and cause.
- GuacamoleClientBadTypeException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientBadTypeException
-
Creates a new GuacamoleClientBadTypeException with the given cause.
- GuacamoleClientException - Exception in org.apache.guacamole
-
A generic exception thrown when part of the Guacamole API encounters an error in the client's request.
- GuacamoleClientException(String) - Constructor for exception org.apache.guacamole.GuacamoleClientException
-
Creates a new GuacamoleException with the given message.
- GuacamoleClientException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientException
-
Creates a new GuacamoleException with the given message and cause.
- GuacamoleClientException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientException
-
Creates a new GuacamoleException with the given cause.
- GuacamoleClientInformation - Class in org.apache.guacamole.protocol
-
An abstract representation of Guacamole client information, including all information required by the Guacamole protocol during the preamble.
- GuacamoleClientInformation() - Constructor for class org.apache.guacamole.protocol.GuacamoleClientInformation
- GuacamoleClientOverrunException - Exception in org.apache.guacamole
-
An exception which is thrown when the client has sent too much data.
- GuacamoleClientOverrunException(String) - Constructor for exception org.apache.guacamole.GuacamoleClientOverrunException
-
Creates a new GuacamoleClientOverrunException with the given message.
- GuacamoleClientOverrunException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientOverrunException
-
Creates a new GuacamoleClientOverrunException with the given message and cause.
- GuacamoleClientOverrunException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientOverrunException
-
Creates a new GuacamoleClientOverrunException with the given cause.
- GuacamoleClientTimeoutException - Exception in org.apache.guacamole
-
An exception which is thrown when the client is taking too long to respond.
- GuacamoleClientTimeoutException(String) - Constructor for exception org.apache.guacamole.GuacamoleClientTimeoutException
-
Creates a new GuacamoleClientTimeoutException with the given message.
- GuacamoleClientTimeoutException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientTimeoutException
-
Creates a new GuacamoleClientTimeoutException with the given message and cause.
- GuacamoleClientTimeoutException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientTimeoutException
-
Creates a new GuacamoleClientTimeoutException with the given cause.
- GuacamoleClientTooManyException - Exception in org.apache.guacamole
-
An exception which is thrown when too many requests have been received by the current client, and further requests are being rejected, either temporarily or permanently.
- GuacamoleClientTooManyException(String) - Constructor for exception org.apache.guacamole.GuacamoleClientTooManyException
-
Creates a new GuacamoleClientTooManyException with the given message.
- GuacamoleClientTooManyException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientTooManyException
-
Creates a new GuacamoleClientTooManyException with the given message and cause.
- GuacamoleClientTooManyException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleClientTooManyException
-
Creates a new GuacamoleClientTooManyException with the given cause.
- GuacamoleConfiguration - Class in org.apache.guacamole.protocol
-
All information necessary to complete the initial protocol handshake of a Guacamole session.
- GuacamoleConfiguration() - Constructor for class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Creates a new, blank GuacamoleConfiguration with its protocol, connection ID, and parameters unset.
- GuacamoleConfiguration(GuacamoleConfiguration) - Constructor for class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Copies the given GuacamoleConfiguration, creating a new, indepedent GuacamoleConfiguration containing the same protocol, connection ID, and parameter values, if any.
- GuacamoleConnectionClosedException - Exception in org.apache.guacamole
-
An exception which is thrown when an operation cannot be performed because its corresponding connection is closed.
- GuacamoleConnectionClosedException(String) - Constructor for exception org.apache.guacamole.GuacamoleConnectionClosedException
-
Creates a new GuacamoleConnectionClosedException with the given message.
- GuacamoleConnectionClosedException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleConnectionClosedException
-
Creates a new GuacamoleConnectionClosedException with the given message and cause.
- GuacamoleConnectionClosedException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleConnectionClosedException
-
Creates a new GuacamoleConnectionClosedException with the given cause.
- GuacamoleException - Exception in org.apache.guacamole
-
A generic exception thrown when parts of the Guacamole API encounter errors.
- GuacamoleException(String) - Constructor for exception org.apache.guacamole.GuacamoleException
-
Creates a new GuacamoleException with the given message.
- GuacamoleException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleException
-
Creates a new GuacamoleException with the given message and cause.
- GuacamoleException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleException
-
Creates a new GuacamoleException with the given cause.
- GuacamoleFilter - Interface in org.apache.guacamole.protocol
-
Interface which provides for the filtering of individual instructions.
- GuacamoleHTTPTunnelServlet - Class in org.apache.guacamole.servlet
-
A HttpServlet implementing and abstracting the operations required by the HTTP implementation of the JavaScript Guacamole client's tunnel.
- GuacamoleHTTPTunnelServlet() - Constructor for class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
- GuacamoleInstruction - Class in org.apache.guacamole.protocol
-
An abstract representation of a Guacamole instruction, as defined by the Guacamole protocol.
- GuacamoleInstruction(String, String...) - Constructor for class org.apache.guacamole.protocol.GuacamoleInstruction
-
Creates a new GuacamoleInstruction having the given Operation and list of arguments values.
- GuacamoleInstruction(String, List<String>) - Constructor for class org.apache.guacamole.protocol.GuacamoleInstruction
-
Creates a new GuacamoleInstruction having the given Operation and list of arguments values.
- GuacamoleParser - Class in org.apache.guacamole.protocol
-
Parser for the Guacamole protocol.
- GuacamoleParser() - Constructor for class org.apache.guacamole.protocol.GuacamoleParser
- GuacamoleProtocolCapability - Enum in org.apache.guacamole.protocol
-
Capabilities which may not be present in all versions of the Guacamole protocol.
- GuacamoleProtocolVersion - Class in org.apache.guacamole.protocol
-
Representation of a Guacamole protocol version.
- GuacamoleProtocolVersion(int, int, int) - Constructor for class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Generate a new GuacamoleProtocolVersion object with the given major version, minor version, and patch version.
- GuacamoleReader - Interface in org.apache.guacamole.io
-
Provides abstract and raw character read access to a stream of Guacamole instructions.
- GuacamoleResourceClosedException - Exception in org.apache.guacamole
-
An exception which is thrown when a resource is no longer available because it is closed.
- GuacamoleResourceClosedException(String) - Constructor for exception org.apache.guacamole.GuacamoleResourceClosedException
-
Creates a new GuacamoleResourceClosedException with the given message.
- GuacamoleResourceClosedException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceClosedException
-
Creates a new GuacamoleResourceClosedException with the given message and cause.
- GuacamoleResourceClosedException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceClosedException
-
Creates a new GuacamoleResourceClosedException with the given cause.
- GuacamoleResourceConflictException - Exception in org.apache.guacamole
-
An exception which is thrown when a resource has been requested, but that resource is locked or currently in use, and cannot be accessed by the current user.
- GuacamoleResourceConflictException(String) - Constructor for exception org.apache.guacamole.GuacamoleResourceConflictException
-
Creates a new GuacamoleResourceConflictException with the given message.
- GuacamoleResourceConflictException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceConflictException
-
Creates a new GuacamoleResourceConflictException with the given message and cause.
- GuacamoleResourceConflictException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceConflictException
-
Creates a new GuacamoleResourceConflictException with the given cause.
- GuacamoleResourceNotFoundException - Exception in org.apache.guacamole
-
A generic exception thrown when part of the Guacamole API fails to find a requested resource, such as a configuration or tunnel.
- GuacamoleResourceNotFoundException(String) - Constructor for exception org.apache.guacamole.GuacamoleResourceNotFoundException
-
Creates a new GuacamoleResourceNotFoundException with the given message.
- GuacamoleResourceNotFoundException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceNotFoundException
-
Creates a new GuacamoleResourceNotFoundException with the given message and cause.
- GuacamoleResourceNotFoundException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleResourceNotFoundException
-
Creates a new GuacamoleResourceNotFoundException with the given cause.
- GuacamoleSecurityException - Exception in org.apache.guacamole
-
A security-related exception thrown when parts of the Guacamole API is denying access to a resource.
- GuacamoleSecurityException(String) - Constructor for exception org.apache.guacamole.GuacamoleSecurityException
-
Creates a new GuacamoleSecurityException with the given message.
- GuacamoleSecurityException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSecurityException
-
Creates a new GuacamoleSecurityException with the given message and cause.
- GuacamoleSecurityException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSecurityException
-
Creates a new GuacamoleSecurityException with the given cause.
- GuacamoleServerBusyException - Exception in org.apache.guacamole
-
An exception which is thrown when the server is too busy to service the request.
- GuacamoleServerBusyException(String) - Constructor for exception org.apache.guacamole.GuacamoleServerBusyException
-
Creates a new GuacamoleServerBusyException with the given message.
- GuacamoleServerBusyException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleServerBusyException
-
Creates a new GuacamoleServerBusyException with the given message and cause.
- GuacamoleServerBusyException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleServerBusyException
-
Creates a new GuacamoleServerBusyException with the given cause.
- GuacamoleServerException - Exception in org.apache.guacamole
-
A generic exception thrown when part of the Guacamole API encounters an unexpected, internal error.
- GuacamoleServerException(String) - Constructor for exception org.apache.guacamole.GuacamoleServerException
-
Creates a new GuacamoleServerException with the given message.
- GuacamoleServerException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleServerException
-
Creates a new GuacamoleServerException with the given message and cause.
- GuacamoleServerException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleServerException
-
Creates a new GuacamoleServerException with the given cause.
- GuacamoleSessionClosedException - Exception in org.apache.guacamole
-
An exception which indicates that a session within an upstream server (such as the remote desktop) has been forcibly terminated.
- GuacamoleSessionClosedException(String) - Constructor for exception org.apache.guacamole.GuacamoleSessionClosedException
-
Creates a new GuacamoleSessionClosedException with the given message.
- GuacamoleSessionClosedException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionClosedException
-
Creates a new GuacamoleSessionClosedException with the given message and cause.
- GuacamoleSessionClosedException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionClosedException
-
Creates a new GuacamoleSessionClosedException with the given cause.
- GuacamoleSessionConflictException - Exception in org.apache.guacamole
-
An exception which indicates that a session within an upstream server (such as the remote desktop) has ended because it conflicted with another session.
- GuacamoleSessionConflictException(String) - Constructor for exception org.apache.guacamole.GuacamoleSessionConflictException
-
Creates a new GuacamoleSessionConflictException with the given message.
- GuacamoleSessionConflictException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionConflictException
-
Creates a new GuacamoleSessionConflictException with the given message and cause.
- GuacamoleSessionConflictException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionConflictException
-
Creates a new GuacamoleSessionConflictException with the given cause.
- GuacamoleSessionTimeoutException - Exception in org.apache.guacamole
-
An exception which indicates that a session within an upstream server (such as the remote desktop) has ended because it appeared to be inactive.
- GuacamoleSessionTimeoutException(String) - Constructor for exception org.apache.guacamole.GuacamoleSessionTimeoutException
-
Creates a new GuacamoleSessionTimeoutException with the given message.
- GuacamoleSessionTimeoutException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionTimeoutException
-
Creates a new GuacamoleSessionTimeoutException with the given message and cause.
- GuacamoleSessionTimeoutException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleSessionTimeoutException
-
Creates a new GuacamoleSessionTimeoutException with the given cause.
- GuacamoleSocket - Interface in org.apache.guacamole.net
-
Provides abstract socket-like access to a Guacamole connection.
- GuacamoleStatus - Enum in org.apache.guacamole.protocol
-
All possible statuses returned by various Guacamole instructions, each having a corresponding code.
- GuacamoleTunnel - Interface in org.apache.guacamole.net
-
Provides a unique identifier and synchronized access to the GuacamoleReader and GuacamoleWriter associated with a GuacamoleSocket.
- GuacamoleUnauthorizedException - Exception in org.apache.guacamole
-
A security-related exception thrown when parts of the Guacamole API is denying access to a resource, but access MAY be granted were the user authorized (logged in).
- GuacamoleUnauthorizedException(String) - Constructor for exception org.apache.guacamole.GuacamoleUnauthorizedException
-
Creates a new GuacamoleUnauthorizedException with the given message.
- GuacamoleUnauthorizedException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUnauthorizedException
-
Creates a new GuacamoleUnauthorizedException with the given message and cause.
- GuacamoleUnauthorizedException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUnauthorizedException
-
Creates a new GuacamoleUnauthorizedException with the given cause.
- GuacamoleUnsupportedException - Exception in org.apache.guacamole
-
An exception which is thrown when the requested operation is unsupported or unimplemented.
- GuacamoleUnsupportedException(String) - Constructor for exception org.apache.guacamole.GuacamoleUnsupportedException
-
Creates a new GuacamoleUnsupportedException with the given message.
- GuacamoleUnsupportedException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUnsupportedException
-
Creates a new GuacamoleUnsupportedException with the given message and cause.
- GuacamoleUnsupportedException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUnsupportedException
-
Creates a new GuacamoleUnsupportedException with the given cause.
- GuacamoleUpstreamException - Exception in org.apache.guacamole
-
An exception which indicates than an upstream server (such as the remote desktop) is returning an error or is otherwise unreachable.
- GuacamoleUpstreamException(String) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamException
-
Creates a new GuacamoleUpstreamException with the given message.
- GuacamoleUpstreamException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamException
-
Creates a new GuacamoleUpstreamException with the given message and cause.
- GuacamoleUpstreamException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamException
-
Creates a new GuacamoleUpstreamException with the given cause.
- GuacamoleUpstreamNotFoundException - Exception in org.apache.guacamole
-
An exception which indicates that an upstream server (such as the remote desktop) does not appear to exist.
- GuacamoleUpstreamNotFoundException(String) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamNotFoundException
-
Creates a new GuacamoleUpstreamNotFoundException with the given message.
- GuacamoleUpstreamNotFoundException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamNotFoundException
-
Creates a new GuacamoleUpstreamNotFoundException with the given message and cause.
- GuacamoleUpstreamNotFoundException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamNotFoundException
-
Creates a new GuacamoleUpstreamNotFoundException with the given cause.
- GuacamoleUpstreamTimeoutException - Exception in org.apache.guacamole
-
An exception which indicates than an upstream server (such as the remote desktop) is taking too long to respond.
- GuacamoleUpstreamTimeoutException(String) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamTimeoutException
-
Creates a new GuacamoleUpstreamException with the given message.
- GuacamoleUpstreamTimeoutException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamTimeoutException
-
Creates a new GuacamoleUpstreamException with the given message and cause.
- GuacamoleUpstreamTimeoutException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamTimeoutException
-
Creates a new GuacamoleUpstreamException with the given cause.
- GuacamoleUpstreamUnavailableException - Exception in org.apache.guacamole
-
An exception which indicates that an upstream server (such as the remote desktop) is not available to service the request.
- GuacamoleUpstreamUnavailableException(String) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamUnavailableException
-
Creates a new GuacamoleUpstreamUnavailableException with the given message.
- GuacamoleUpstreamUnavailableException(String, Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamUnavailableException
-
Creates a new GuacamoleUpstreamUnavailableException with the given message and cause.
- GuacamoleUpstreamUnavailableException(Throwable) - Constructor for exception org.apache.guacamole.GuacamoleUpstreamUnavailableException
-
Creates a new GuacamoleUpstreamUnavailableException with the given cause.
- GuacamoleWebSocketTunnelEndpoint - Class in org.apache.guacamole.websocket
-
A WebSocket implementation of GuacamoleTunnel functionality, compatible with the Guacamole.WebSocketTunnel object included with the JavaScript API.
- GuacamoleWebSocketTunnelEndpoint() - Constructor for class org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint
- GuacamoleWriter - Interface in org.apache.guacamole.io
-
Provides abstract and raw character write access to a stream of Guacamole instructions.
H
- handleTunnelRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Dispatches every HTTP GET and POST request to the appropriate handler function based on the query string.
- hashCode() - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
- hasNext() - Method in class org.apache.guacamole.protocol.GuacamoleParser
- hasQueuedReaderThreads() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Returns whether there are threads waiting for read access to the Guacamole instruction stream.
- hasQueuedReaderThreads() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- hasQueuedReaderThreads() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Returns whether there are threads waiting for read access to the Guacamole instruction stream.
- hasQueuedWriterThreads() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
- hasQueuedWriterThreads() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- hasQueuedWriterThreads() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Returns whether there are threads waiting for write access to the Guacamole instruction stream.
I
- InetGuacamoleSocket - Class in org.apache.guacamole.net
-
Provides abstract socket-like access to a Guacamole connection over a given hostname and port.
- InetGuacamoleSocket(String, int) - Constructor for class org.apache.guacamole.net.InetGuacamoleSocket
-
Creates a new InetGuacamoleSocket which reads and writes instructions to the Guacamole instruction stream of the Guacamole proxy server running at the given hostname and port.
- INSTRUCTION_MAX_DIGITS - Static variable in class org.apache.guacamole.protocol.GuacamoleParser
-
The maximum number of digits to allow per length prefix.
- INSTRUCTION_MAX_ELEMENTS - Static variable in class org.apache.guacamole.protocol.GuacamoleParser
-
The maximum number of elements per instruction, including the opcode.
- INSTRUCTION_MAX_LENGTH - Static variable in class org.apache.guacamole.protocol.GuacamoleParser
-
The maximum number of characters per instruction.
- INTERNAL_DATA_OPCODE - Static variable in interface org.apache.guacamole.net.GuacamoleTunnel
-
The Guacamole protocol instruction opcode reserved for arbitrary internal use by tunnel implementations.
- isOpen() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
- isOpen() - Method in class org.apache.guacamole.net.DelegatingGuacamoleSocket
- isOpen() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- isOpen() - Method in interface org.apache.guacamole.net.GuacamoleSocket
-
Returns whether this GuacamoleSocket is open and can be used for reading and writing.
- isOpen() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Returns whether this GuacamoleTunnel is open, or has been closed.
- isOpen() - Method in class org.apache.guacamole.net.InetGuacamoleSocket
- isOpen() - Method in class org.apache.guacamole.net.SSLGuacamoleSocket
- isSupported(GuacamoleProtocolVersion) - Method in enum org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Returns whether this capability is supported in the given Guacamole protocol version.
L
- LATEST - Static variable in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
The most recent version of the Guacamole protocol at the time this version of GuacamoleProtocolVersion was built.
M
- MSG_INSTRUCTION - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Support for the "msg" instruction.
N
- NAME_HANDSHAKE - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Support for the "name" handshake instruction, allowing clients to send the name of the Guacamole user to be passed to guacd and associated with connections.
- next() - Method in class org.apache.guacamole.protocol.GuacamoleParser
O
- onClose(Session, CloseReason) - Method in class org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint
- onMessage(String) - Method in class org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint
- onOpen(Session, EndpointConfig) - Method in class org.apache.guacamole.websocket.GuacamoleWebSocketTunnelEndpoint
- org.apache.guacamole - package org.apache.guacamole
-
All classes which apply generally across the Guacamole web application and all other web applications which use the API provided by the Guacamole project.
- org.apache.guacamole.io - package org.apache.guacamole.io
-
All classes relating directly to data input or output.
- org.apache.guacamole.net - package org.apache.guacamole.net
-
Classes which apply to network-specific concepts, such as low-level sockets and tunnels.
- org.apache.guacamole.protocol - package org.apache.guacamole.protocol
-
Classes relating directly to the Guacamole protocol.
- org.apache.guacamole.servlet - package org.apache.guacamole.servlet
-
Classes which build upon the Java Servlet API, providing an HTTP-based tunnel and session management.
- org.apache.guacamole.websocket - package org.apache.guacamole.websocket
P
- parseVersion(String) - Static method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Parse the String format of the version provided and return the the enum value matching that version.
- PROTOCOL_VERSION_DETECTION - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Negotiation of Guacamole protocol version between client and server during the protocol handshake.
R
- read() - Method in interface org.apache.guacamole.io.GuacamoleReader
-
Reads at least one complete Guacamole instruction, returning a buffer containing one or more complete Guacamole instructions and no incomplete Guacamole instructions.
- read() - Method in class org.apache.guacamole.io.ReaderGuacamoleReader
- read() - Method in class org.apache.guacamole.protocol.FilteredGuacamoleReader
- ReaderGuacamoleReader - Class in org.apache.guacamole.io
-
A GuacamoleReader which wraps a standard Java Reader, using that Reader as the Guacamole instruction stream.
- ReaderGuacamoleReader(Reader) - Constructor for class org.apache.guacamole.io.ReaderGuacamoleReader
-
Creates a new ReaderGuacamoleReader which will use the given Reader as the Guacamole instruction stream.
- readInstruction() - Method in interface org.apache.guacamole.io.GuacamoleReader
-
Reads exactly one complete Guacamole instruction and returns the fully parsed instruction.
- readInstruction() - Method in class org.apache.guacamole.io.ReaderGuacamoleReader
- readInstruction() - Method in class org.apache.guacamole.protocol.FilteredGuacamoleReader
- registerTunnel(String, GuacamoleTunnel) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Registers the given HTTP tunnel such that future read/write requests including the given tunnel-specific session token will be properly directed.
- registerTunnel(GuacamoleTunnel) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Deprecated.This function has been deprecated in favor of
registerTunnel(java.lang.String, org.apache.guacamole.net.GuacamoleTunnel)
, which decouples identification of HTTP tunnel sessions from the tunnel UUID. - releaseReader() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Relinquishes exclusive read access to the Guacamole instruction stream.
- releaseReader() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- releaseReader() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Relinquishes exclusive read access to the Guacamole instruction stream.
- releaseWriter() - Method in class org.apache.guacamole.net.AbstractGuacamoleTunnel
-
Relinquishes exclusive write access to the Guacamole instruction stream.
- releaseWriter() - Method in class org.apache.guacamole.net.DelegatingGuacamoleTunnel
- releaseWriter() - Method in interface org.apache.guacamole.net.GuacamoleTunnel
-
Relinquishes exclusive write access to the Guacamole instruction stream.
- remove() - Method in class org.apache.guacamole.protocol.GuacamoleParser
- REQUIRED_INSTRUCTION - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Support for the "required" instruction.
- RESOURCE_CLOSED - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed as the requested resource is now closed.
- RESOURCE_CONFLICT - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed as the requested resource is already in use.
- RESOURCE_NOT_FOUND - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed as the requested resource does not exist.
S
- sendError(HttpServletResponse, int, int, String) - Method in class org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet
-
Sends an error on the given HTTP response using the information within the given GuacamoleStatus.
- SERVER_BUSY - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed as the server is busy.
- SERVER_ERROR - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed due to an internal failure.
- SESSION_CLOSED - org.apache.guacamole.protocol.GuacamoleStatus
-
The session within the upstream server has been forcibly terminated.
- SESSION_CONFLICT - org.apache.guacamole.protocol.GuacamoleStatus
-
The session within the upstream server has ended because it conflicted with another session.
- SESSION_TIMEOUT - org.apache.guacamole.protocol.GuacamoleStatus
-
The session within the upstream server has ended because it appeared to be inactive.
- setConnectionID(String) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Sets the ID of the connection being joined, if any.
- setName(String) - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Set the human-readable name of the user associated with this client.
- setOptimalResolution(int) - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Sets the resolution of the screen if the optimal width and height are used, in DPI.
- setOptimalScreenHeight(int) - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Sets the client's optimal screen height.
- setOptimalScreenWidth(int) - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Sets the client's optimal screen width.
- setParameter(String, String) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Sets the value for the parameter with the given name.
- setParameters(Map<String, String>) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Replaces all current parameters with the parameters defined within the given map.
- setProtocol(String) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Sets the name of the protocol to be used.
- setTimezone(String) - Method in class org.apache.guacamole.protocol.GuacamoleClientInformation
-
Set the string value of the timezone, or null if the timezone will not be provided by the client.
- SimpleGuacamoleTunnel - Class in org.apache.guacamole.net
-
GuacamoleTunnel implementation which uses a provided socket.
- SimpleGuacamoleTunnel(GuacamoleSocket) - Constructor for class org.apache.guacamole.net.SimpleGuacamoleTunnel
-
Creates a new GuacamoleTunnel which synchronizes access to the Guacamole instruction stream associated with the given GuacamoleSocket.
- SSLGuacamoleSocket - Class in org.apache.guacamole.net
-
Provides abstract socket-like access to a Guacamole connection over SSL to a given hostname and port.
- SSLGuacamoleSocket(String, int) - Constructor for class org.apache.guacamole.net.SSLGuacamoleSocket
-
Creates a new SSLGuacamoleSocket which reads and writes instructions to the Guacamole instruction stream of the Guacamole proxy server running at the given hostname and port using SSL.
- SUCCESS - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation succeeded.
T
- TIMEZONE_HANDSHAKE - org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Support for the "timezone" handshake instruction.
- toException(String) - Method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns an instance of the
GuacamoleException
subclass corresponding to this Guacamole protocol status code. - toString() - Method in class org.apache.guacamole.protocol.GuacamoleInstruction
-
Returns this GuacamoleInstruction in the form it would be sent over the Guacamole protocol.
- toString() - Method in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
U
- unsetParameter(String) - Method in class org.apache.guacamole.protocol.GuacamoleConfiguration
-
Removes the value set for the parameter with the given name.
- UNSUPPORTED - org.apache.guacamole.protocol.GuacamoleStatus
-
The requested operation is unsupported.
- UPSTREAM_ERROR - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation was unsuccessful due to an error or otherwise unexpected condition of the upstream server.
- UPSTREAM_NOT_FOUND - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed because the upstream server does not appear to exist.
- UPSTREAM_TIMEOUT - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed because the upstream server is not responding.
- UPSTREAM_UNAVAILABLE - org.apache.guacamole.protocol.GuacamoleStatus
-
The operation could not be performed because the upstream server is not available to service the request.
V
- valueOf(String) - Static method in enum org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.guacamole.protocol.GuacamoleProtocolCapability
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.guacamole.protocol.GuacamoleStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VERSION_1_0_0 - Static variable in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Protocol version 1.0.0 and older.
- VERSION_1_1_0 - Static variable in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Protocol version 1.1.0, which introduces Client-Server version detection, arbitrary handshake instruction order, and support for passing the client timezone to the server during the handshake.
- VERSION_1_3_0 - Static variable in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Protocol version 1.3.0, which introduces the "required" instruction allowing the server to explicitly request connection parameters from the client.
- VERSION_1_5_0 - Static variable in class org.apache.guacamole.protocol.GuacamoleProtocolVersion
-
Protocol version 1.5.0, which introduces the "msg" instruction, allowing the server to send message notifications that will be displayed on the client.
W
- write(char[]) - Method in interface org.apache.guacamole.io.GuacamoleWriter
-
Writes the entire given array of characters to the Guacamole instruction stream.
- write(char[]) - Method in class org.apache.guacamole.io.WriterGuacamoleWriter
- write(char[]) - Method in class org.apache.guacamole.protocol.FilteredGuacamoleWriter
- write(char[], int, int) - Method in interface org.apache.guacamole.io.GuacamoleWriter
-
Writes a portion of the given array of characters to the Guacamole instruction stream.
- write(char[], int, int) - Method in class org.apache.guacamole.io.WriterGuacamoleWriter
- write(char[], int, int) - Method in class org.apache.guacamole.protocol.FilteredGuacamoleWriter
- writeInstruction(GuacamoleInstruction) - Method in interface org.apache.guacamole.io.GuacamoleWriter
-
Writes the given fully parsed instruction to the Guacamole instruction stream.
- writeInstruction(GuacamoleInstruction) - Method in class org.apache.guacamole.io.WriterGuacamoleWriter
- writeInstruction(GuacamoleInstruction) - Method in class org.apache.guacamole.protocol.FilteredGuacamoleWriter
- WriterGuacamoleWriter - Class in org.apache.guacamole.io
-
A GuacamoleWriter which wraps a standard Java Writer, using that Writer as the Guacamole instruction stream.
- WriterGuacamoleWriter(Writer) - Constructor for class org.apache.guacamole.io.WriterGuacamoleWriter
-
Creates a new WriterGuacamoleWriter which will use the given Writer as the Guacamole instruction stream.
All Classes All Packages