A C D F G H I N P R S T V W

A

acquireReader() - Method in class net.sourceforge.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 net.sourceforge.guacamole.net.GuacamoleTunnel
Acquires exclusive write access to the Guacamole instruction stream and returns a GuacamoleWriter for writing to that stream.
attachTunnel(GuacamoleTunnel) - Method in class net.sourceforge.guacamole.servlet.GuacamoleSession
Attaches the given tunnel to this GuacamoleSession.
available() - Method in interface net.sourceforge.guacamole.io.GuacamoleReader
Returns whether instruction data is available for reading.
available() - Method in class net.sourceforge.guacamole.io.ReaderGuacamoleReader
 

C

close() - Method in interface net.sourceforge.guacamole.net.GuacamoleSocket
Releases all resources in use by the connection represented by this GuacamoleSocket.
close() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Release all resources allocated to this GuacamoleTunnel.
close() - Method in class net.sourceforge.guacamole.net.InetGuacamoleSocket
 
close() - Method in class net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
 
ConfiguredGuacamoleSocket - Class in net.sourceforge.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 net.sourceforge.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 net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
Creates a new ConfiguredGuacamoleSocket which uses the given GuacamoleConfiguration and GuacamoleClientInformation to complete the initial protocol handshake over the given GuacamoleSocket.

D

detachTunnel(GuacamoleTunnel) - Method in class net.sourceforge.guacamole.servlet.GuacamoleSession
Detaches the given tunnel to this GuacamoleSession.
doConnect(HttpServletRequest) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
Called whenever the JavaScript Guacamole client makes a connection request.
doGet(HttpServletRequest, HttpServletResponse) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
 
doRead(HttpServletRequest, HttpServletResponse, String) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
Called whenever the JavaScript Guacamole client makes a read request.
doWrite(HttpServletRequest, HttpServletResponse, String) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
Called whenever the JavaScript Guacamole client makes a write request.

F

FileGuacamoleProperty - Class in net.sourceforge.guacamole.properties
A GuacamoleProperty whose value is a filename.
FileGuacamoleProperty() - Constructor for class net.sourceforge.guacamole.properties.FileGuacamoleProperty
 
fromOpcode(String) - Static method in enum net.sourceforge.guacamole.protocol.GuacamoleInstruction.Operation
Returns the corresponding Operation having the given opcode, if any.

G

getArgs() - Method in class net.sourceforge.guacamole.protocol.GuacamoleInstruction
Returns an array of all argument values specified for this GuacamoleInstruction.
getAudioMimetypes() - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Returns the list of audio mimetypes supported by the client.
getConfiguration() - Method in class net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
Returns the GuacamoleConfiguration used to configure this ConfiguredGuacamoleSocket.
getName() - Method in interface net.sourceforge.guacamole.properties.GuacamoleProperty
Returns the name of the property in guacamole.properties that this GuacamoleProperty will parse.
getOpcode() - Method in enum net.sourceforge.guacamole.protocol.GuacamoleInstruction.Operation
Returns the unique opcode associated with this Operation.
getOperation() - Method in class net.sourceforge.guacamole.protocol.GuacamoleInstruction
Returns the Operation associated with this GuacamoleInstruction.
getOptimalScreenHeight() - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Returns the optimal screen height requested by the client, in pixels.
getOptimalScreenWidth() - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Returns the optimal screen width requested by the client, in pixels.
getParameter(String) - Method in class net.sourceforge.guacamole.protocol.GuacamoleConfiguration
Returns the value set for the parameter with the given name, if any.
getProperty(GuacamoleProperty<Type>) - Static method in class net.sourceforge.guacamole.properties.GuacamoleProperties
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
getProtocol() - Method in class net.sourceforge.guacamole.protocol.GuacamoleConfiguration
Returns the name of the protocol to be used.
getReader() - Method in interface net.sourceforge.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 net.sourceforge.guacamole.net.InetGuacamoleSocket
 
getReader() - Method in class net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
 
getRequiredProperty(GuacamoleProperty<Type>) - Static method in class net.sourceforge.guacamole.properties.GuacamoleProperties
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties.
getSocket() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Returns the GuacamoleSocket used by this GuacamoleTunnel for reading and writing.
getTunnel(String) - Method in class net.sourceforge.guacamole.servlet.GuacamoleSession
Returns the tunnel with the given UUID attached to this GuacamoleSession, if any.
getUUID() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Returns the unique identifier associated with this GuacamoleTunnel.
getVideoMimetypes() - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Returns the list of video mimetypes supported by the client.
getWriter() - Method in interface net.sourceforge.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 net.sourceforge.guacamole.net.InetGuacamoleSocket
 
getWriter() - Method in class net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
 
GuacamoleClientException - Exception in net.sourceforge.guacamole
A generic exception thrown when part of the Guacamole API encounters an error in the client's request.
GuacamoleClientException(String, Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleClientException
Creates a new GuacamoleException with the given message and cause.
GuacamoleClientException(String) - Constructor for exception net.sourceforge.guacamole.GuacamoleClientException
Creates a new GuacamoleException with the given message.
GuacamoleClientException(Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleClientException
Creates a new GuacamoleException with the given cause.
GuacamoleClientInformation - Class in net.sourceforge.guacamole.protocol
An abstract representation of Guacamole client information, including all information required by the Guacamole protocol during the preamble.
GuacamoleClientInformation() - Constructor for class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
 
GuacamoleConfiguration - Class in net.sourceforge.guacamole.protocol
All information necessary to complete the initial protocol handshake of a Guacamole session.
GuacamoleConfiguration() - Constructor for class net.sourceforge.guacamole.protocol.GuacamoleConfiguration
 
GuacamoleException - Exception in net.sourceforge.guacamole
A generic exception thrown when parts of the Guacamole API encounter errors.
GuacamoleException(String, Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleException
Creates a new GuacamoleException with the given message and cause.
GuacamoleException(String) - Constructor for exception net.sourceforge.guacamole.GuacamoleException
Creates a new GuacamoleException with the given message.
GuacamoleException(Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleException
Creates a new GuacamoleException with the given cause.
GuacamoleHTTPTunnelServlet - Class in net.sourceforge.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 net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
 
GuacamoleInstruction - Class in net.sourceforge.guacamole.protocol
An abstract representation of a Guacamole instruction, as defined by the Guacamole protocol.
GuacamoleInstruction(GuacamoleInstruction.Operation, String...) - Constructor for class net.sourceforge.guacamole.protocol.GuacamoleInstruction
Creates a new GuacamoleInstruction having the given Operation and list of arguments values.
GuacamoleInstruction.Operation - Enum in net.sourceforge.guacamole.protocol
The operation performed by a particular Guacamole instruction.
GuacamoleProperties - Class in net.sourceforge.guacamole.properties
Simple utility class for reading properties from the guacamole.properties file in the root of the classpath.
GuacamoleProperty<Type> - Interface in net.sourceforge.guacamole.properties
An abstract representation of a property in the guacamole.properties file, which parses into a specific type.
GuacamoleReader - Interface in net.sourceforge.guacamole.io
Provides abstract and raw character read access to a stream of Guacamole instructions.
GuacamoleResourceNotFoundException - Exception in net.sourceforge.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, Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleResourceNotFoundException
Creates a new GuacamoleResourceNotFoundException with the given message and cause.
GuacamoleResourceNotFoundException(String) - Constructor for exception net.sourceforge.guacamole.GuacamoleResourceNotFoundException
Creates a new GuacamoleResourceNotFoundException with the given message.
GuacamoleResourceNotFoundException(Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleResourceNotFoundException
Creates a new GuacamoleResourceNotFoundException with the given cause.
GuacamoleSecurityException - Exception in net.sourceforge.guacamole
A security-related exception thrown when parts of the Guacamole API is denying access to a resource.
GuacamoleSecurityException(String, Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleSecurityException
Creates a new GuacamoleSecurityException with the given message and cause.
GuacamoleSecurityException(String) - Constructor for exception net.sourceforge.guacamole.GuacamoleSecurityException
Creates a new GuacamoleSecurityException with the given message.
GuacamoleSecurityException(Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleSecurityException
Creates a new GuacamoleSecurityException with the given cause.
GuacamoleServerException - Exception in net.sourceforge.guacamole
A generic exception thrown when part of the Guacamole API encounters an unexpected, internal error.
GuacamoleServerException(String, Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleServerException
Creates a new GuacamoleException with the given message and cause.
GuacamoleServerException(String) - Constructor for exception net.sourceforge.guacamole.GuacamoleServerException
Creates a new GuacamoleException with the given message.
GuacamoleServerException(Throwable) - Constructor for exception net.sourceforge.guacamole.GuacamoleServerException
Creates a new GuacamoleException with the given cause.
GuacamoleSession - Class in net.sourceforge.guacamole.servlet
Provides abstract access to the tunnels associated with a Guacamole session.
GuacamoleSession(HttpSession) - Constructor for class net.sourceforge.guacamole.servlet.GuacamoleSession
Creates a new GuacamoleSession, storing and retrieving tunnels from the given HttpSession.
GuacamoleSocket - Interface in net.sourceforge.guacamole.net
Provides abstract socket-like access to a Guacamole connection.
GuacamoleTunnel - Class in net.sourceforge.guacamole.net
Provides a unique identifier and synchronized access to the GuacamoleReader and GuacamoleWriter associated with a GuacamoleSocket.
GuacamoleTunnel(GuacamoleSocket) - Constructor for class net.sourceforge.guacamole.net.GuacamoleTunnel
Creates a new GuacamoleTunnel which synchronizes access to the Guacamole instruction stream associated with the given GuacamoleSocket.
GuacamoleWriter - Interface in net.sourceforge.guacamole.io
Provides abstract and raw character write access to a stream of Guacamole instructions.
GUACD_HOSTNAME - Static variable in class net.sourceforge.guacamole.properties.GuacamoleProperties
The hostname of the server where guacd (the Guacamole proxy server) is running.
GUACD_PORT - Static variable in class net.sourceforge.guacamole.properties.GuacamoleProperties
The port that guacd (the Guacamole proxy server) is listening on.

H

handleTunnelRequest(HttpServletRequest, HttpServletResponse) - Method in class net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet
Dispatches every HTTP GET and POST request to the appropriate handler function based on the query string.
hasQueuedReaderThreads() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Returns whether there are threads waiting for read access to the Guacamole instruction stream.
hasQueuedWriterThreads() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Returns whether there are threads waiting for write access to the Guacamole instruction stream.

I

InetGuacamoleSocket - Class in net.sourceforge.guacamole.net
Provides abstract socket-like access to a Guacamole connection over a given hostname and port.
InetGuacamoleSocket(String, int) - Constructor for class net.sourceforge.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.
IntegerGuacamoleProperty - Class in net.sourceforge.guacamole.properties
A GuacamoleProperty whose value is an integer.
IntegerGuacamoleProperty() - Constructor for class net.sourceforge.guacamole.properties.IntegerGuacamoleProperty
 
isOpen() - Method in interface net.sourceforge.guacamole.net.GuacamoleSocket
Returns whether this GuacamoleSocket is open and can be used for reading and writing.
isOpen() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Returns whether this GuacamoleTunnel is open, or has been closed.
isOpen() - Method in class net.sourceforge.guacamole.net.InetGuacamoleSocket
 
isOpen() - Method in class net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket
 

N

net.sourceforge.guacamole - package net.sourceforge.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.
net.sourceforge.guacamole.io - package net.sourceforge.guacamole.io
All classes relating directly to data input or output.
net.sourceforge.guacamole.net - package net.sourceforge.guacamole.net
Classes which apply to network-specific concepts, such as low-level sockets and tunnels.
net.sourceforge.guacamole.properties - package net.sourceforge.guacamole.properties
Provides classes for reading properties from the web-application-wide guacamole.properties file.
net.sourceforge.guacamole.protocol - package net.sourceforge.guacamole.protocol
Classes relating directly to the Guacamole protocol.
net.sourceforge.guacamole.servlet - package net.sourceforge.guacamole.servlet
Classes which build upon the Java Servlet API, providing an HTTP-based tunnel and session management.

P

parseValue(String) - Method in class net.sourceforge.guacamole.properties.FileGuacamoleProperty
 
parseValue(String) - Method in interface net.sourceforge.guacamole.properties.GuacamoleProperty
Parses the given string value into the type associated with this GuacamoleProperty.
parseValue(String) - Method in class net.sourceforge.guacamole.properties.IntegerGuacamoleProperty
 
parseValue(String) - Method in class net.sourceforge.guacamole.properties.StringGuacamoleProperty
 

R

read() - Method in interface net.sourceforge.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 net.sourceforge.guacamole.io.ReaderGuacamoleReader
 
ReaderGuacamoleReader - Class in net.sourceforge.guacamole.io
A GuacamoleReader which wraps a standard Java Reader, using that Reader as the Guacamole instruction stream.
ReaderGuacamoleReader(Reader) - Constructor for class net.sourceforge.guacamole.io.ReaderGuacamoleReader
Creates a new ReaderGuacamoleReader which will use the given Reader as the Guacamole instruction stream.
readInstruction() - Method in interface net.sourceforge.guacamole.io.GuacamoleReader
Reads exactly one complete Guacamole instruction and returns the fully parsed instruction.
readInstruction() - Method in class net.sourceforge.guacamole.io.ReaderGuacamoleReader
 
releaseReader() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Relinquishes exclusive read access to the Guacamole instruction stream.
releaseWriter() - Method in class net.sourceforge.guacamole.net.GuacamoleTunnel
Relinquishes exclusive write access to the Guacamole instruction stream.

S

setOptimalScreenHeight(int) - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Sets the client's optimal screen height.
setOptimalScreenWidth(int) - Method in class net.sourceforge.guacamole.protocol.GuacamoleClientInformation
Sets the client's optimal screen width.
setParameter(String, String) - Method in class net.sourceforge.guacamole.protocol.GuacamoleConfiguration
Sets the value for the parameter with the given name.
setProtocol(String) - Method in class net.sourceforge.guacamole.protocol.GuacamoleConfiguration
Sets the name of the protocol to be used.
StringGuacamoleProperty - Class in net.sourceforge.guacamole.properties
A GuacamoleProperty whose value is a simple string.
StringGuacamoleProperty() - Constructor for class net.sourceforge.guacamole.properties.StringGuacamoleProperty
 

T

toString() - Method in class net.sourceforge.guacamole.protocol.GuacamoleInstruction
Returns this GuacamoleInstruction in the form it would be sent over the Guacamole protocol.

V

valueOf(String) - Static method in enum net.sourceforge.guacamole.protocol.GuacamoleInstruction.Operation
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.sourceforge.guacamole.protocol.GuacamoleInstruction.Operation
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(char[], int, int) - Method in interface net.sourceforge.guacamole.io.GuacamoleWriter
Writes a portion of the given array of characters to the Guacamole instruction stream.
write(char[]) - Method in interface net.sourceforge.guacamole.io.GuacamoleWriter
Writes the entire given array of characters to the Guacamole instruction stream.
write(char[], int, int) - Method in class net.sourceforge.guacamole.io.WriterGuacamoleWriter
 
write(char[]) - Method in class net.sourceforge.guacamole.io.WriterGuacamoleWriter
 
writeInstruction(GuacamoleInstruction) - Method in interface net.sourceforge.guacamole.io.GuacamoleWriter
Writes the given fully parsed instruction to the Guacamole instruction stream.
writeInstruction(GuacamoleInstruction) - Method in class net.sourceforge.guacamole.io.WriterGuacamoleWriter
 
WriterGuacamoleWriter - Class in net.sourceforge.guacamole.io
A GuacamoleWriter which wraps a standard Java Writer, using that Writer as the Guacamole instruction stream.
WriterGuacamoleWriter(Writer) - Constructor for class net.sourceforge.guacamole.io.WriterGuacamoleWriter
Creates a new WriterGuacamoleWriter which will use the given Writer as the Guacamole instruction stream.

A C D F G H I N P R S T V W

Copyright © 2013. All Rights Reserved.