Package | Description |
---|---|
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 |
All classes relating directly to data input or output.
|
org.apache.guacamole.net |
Classes which apply to network-specific concepts, such as low-level sockets
and tunnels.
|
org.apache.guacamole.protocol |
Classes relating directly to the Guacamole protocol.
|
org.apache.guacamole.servlet |
Classes which build upon the Java Servlet API, providing an HTTP-based
tunnel and session management.
|
org.apache.guacamole.websocket |
Modifier and Type | Class and Description |
---|---|
class |
GuacamoleClientBadTypeException
An exception which is thrown when data has been submitted with an unsupported
mimetype.
|
class |
GuacamoleClientException
A generic exception thrown when part of the Guacamole API encounters
an error in the client's request.
|
class |
GuacamoleClientOverrunException
An exception which is thrown when the client has sent too much data.
|
class |
GuacamoleClientTimeoutException
An exception which is thrown when the client is taking too long to respond.
|
class |
GuacamoleClientTooManyException
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.
|
class |
GuacamoleConnectionClosedException
An exception which is thrown when an operation cannot be performed because
its corresponding connection is closed.
|
class |
GuacamoleResourceConflictException
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.
|
class |
GuacamoleResourceNotFoundException
A generic exception thrown when part of the Guacamole API fails to find
a requested resource, such as a configuration or tunnel.
|
class |
GuacamoleSecurityException
A security-related exception thrown when parts of the Guacamole API is
denying access to a resource.
|
class |
GuacamoleServerBusyException
An exception which is thrown when the server is too busy to service the
request.
|
class |
GuacamoleServerException
A generic exception thrown when part of the Guacamole API encounters
an unexpected, internal error.
|
class |
GuacamoleUnauthorizedException
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).
|
class |
GuacamoleUnsupportedException
An exception which is thrown when the requested operation is unsupported
or unimplemented.
|
class |
GuacamoleUpstreamException
An exception which indicates than an upstream server (such as the remote
desktop) is returning an error or is otherwise unreachable.
|
class |
GuacamoleUpstreamTimeoutException
An exception which indicates than an upstream server (such as the remote
desktop) is taking too long to respond.
|
Modifier and Type | Method and Description |
---|---|
boolean |
GuacamoleReader.available()
Returns whether instruction data is available for reading.
|
boolean |
ReaderGuacamoleReader.available() |
char[] |
GuacamoleReader.read()
Reads at least one complete Guacamole instruction, returning a buffer
containing one or more complete Guacamole instructions and no
incomplete Guacamole instructions.
|
char[] |
ReaderGuacamoleReader.read() |
GuacamoleInstruction |
GuacamoleReader.readInstruction()
Reads exactly one complete Guacamole instruction and returns the fully
parsed instruction.
|
GuacamoleInstruction |
ReaderGuacamoleReader.readInstruction() |
void |
WriterGuacamoleWriter.write(char[] chunk) |
void |
GuacamoleWriter.write(char[] chunk)
Writes the entire given array of characters to the Guacamole instruction
stream.
|
void |
WriterGuacamoleWriter.write(char[] chunk,
int off,
int len) |
void |
GuacamoleWriter.write(char[] chunk,
int off,
int len)
Writes a portion of the given array of characters to the Guacamole
instruction stream.
|
void |
WriterGuacamoleWriter.writeInstruction(GuacamoleInstruction instruction) |
void |
GuacamoleWriter.writeInstruction(GuacamoleInstruction instruction)
Writes the given fully parsed instruction to the Guacamole instruction
stream.
|
Modifier and Type | Method and Description |
---|---|
void |
GuacamoleSocket.close()
Releases all resources in use by the connection represented by this
GuacamoleSocket.
|
void |
GuacamoleTunnel.close()
Release all resources allocated to this GuacamoleTunnel.
|
void |
AbstractGuacamoleTunnel.close() |
void |
DelegatingGuacamoleTunnel.close() |
void |
InetGuacamoleSocket.close() |
void |
SSLGuacamoleSocket.close() |
Constructor and Description |
---|
InetGuacamoleSocket(String hostname,
int port)
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.
|
SSLGuacamoleSocket(String hostname,
int port)
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.
|
Modifier and Type | Method and Description |
---|---|
int |
GuacamoleParser.append(char[] chunk)
Appends data from the given buffer to the current instruction.
|
int |
GuacamoleParser.append(char[] chunk,
int offset,
int length)
Appends data from the given buffer to the current instruction.
|
boolean |
FilteredGuacamoleReader.available() |
void |
FilteredGuacamoleSocket.close() |
void |
ConfiguredGuacamoleSocket.close() |
GuacamoleInstruction |
GuacamoleFilter.filter(GuacamoleInstruction instruction)
Applies the filter to the given instruction, returning the original
instruction, a modified version of the original, or null, depending
on the implementation.
|
char[] |
FilteredGuacamoleReader.read() |
GuacamoleInstruction |
FilteredGuacamoleReader.readInstruction() |
void |
FilteredGuacamoleWriter.write(char[] chunk) |
void |
FilteredGuacamoleWriter.write(char[] chunk,
int offset,
int length) |
void |
FilteredGuacamoleWriter.writeInstruction(GuacamoleInstruction instruction) |
Constructor and Description |
---|
ConfiguredGuacamoleSocket(GuacamoleSocket socket,
GuacamoleConfiguration config)
Creates a new ConfiguredGuacamoleSocket which uses the given
GuacamoleConfiguration to complete the initial protocol handshake over
the given GuacamoleSocket.
|
ConfiguredGuacamoleSocket(GuacamoleSocket socket,
GuacamoleConfiguration config,
GuacamoleClientInformation info)
Creates a new ConfiguredGuacamoleSocket which uses the given
GuacamoleConfiguration and GuacamoleClientInformation to complete the
initial protocol handshake over the given GuacamoleSocket.
|
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleHTTPTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request)
Called whenever the JavaScript Guacamole client makes a connection
request via HTTP.
|
protected void |
GuacamoleHTTPTunnelServlet.doRead(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String tunnelUUID)
Called whenever the JavaScript Guacamole client makes a read request.
|
protected void |
GuacamoleHTTPTunnelServlet.doWrite(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String tunnelUUID)
Called whenever the JavaScript Guacamole client makes a write request.
|
protected GuacamoleTunnel |
GuacamoleHTTPTunnelServlet.getTunnel(String tunnelUUID)
Returns the tunnel with the given UUID, if it has been registered with
registerTunnel() and not yet deregistered with deregisterTunnel().
|
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleWebSocketTunnelEndpoint.createTunnel(javax.websocket.Session session,
javax.websocket.EndpointConfig config)
Returns a new tunnel for the given session.
|
Copyright © 2016. All rights reserved.