Package | Description |
---|---|
net.sourceforge.guacamole.net.basic | |
org.glyptodon.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.glyptodon.guacamole.io |
All classes relating directly to data input or output.
|
org.glyptodon.guacamole.net |
Classes which apply to network-specific concepts, such as low-level sockets
and tunnels.
|
org.glyptodon.guacamole.net.auth |
Provides classes which can be used to extend or replace the authentication
functionality of the Guacamole web application.
|
org.glyptodon.guacamole.net.auth.simple |
Provides a basic AuthenticationProvider base class that can be used to create
simple AuthenticationProviders in the same way allowed by the old
authentication API.
|
org.glyptodon.guacamole.net.basic |
Classes specific to the general-purpose web application implemented by
the Guacamole project using the Guacamole APIs.
|
org.glyptodon.guacamole.net.basic.crud.connectiongroups |
Servlets dedicated to CRUD operations related to ConnectionGroups.
|
org.glyptodon.guacamole.net.basic.crud.connections |
Servlets dedicated to CRUD operations related to Connections.
|
org.glyptodon.guacamole.net.basic.crud.permissions |
Servlets dedicated to CRUD operations related to Permissions.
|
org.glyptodon.guacamole.net.basic.crud.protocols |
Servlets dedicated to CRUD operations related to protocols.
|
org.glyptodon.guacamole.net.basic.crud.users |
Servlets dedicated to CRUD operations related to Users.
|
org.glyptodon.guacamole.net.basic.event |
Classes used by the Guacamole web application to broadcast events.
|
org.glyptodon.guacamole.net.basic.properties |
Classes related to the properties which the Guacamole web application
(and stock parts of it) read from guacamole.properties.
|
org.glyptodon.guacamole.net.basic.websocket.jetty |
Jetty WebSocket tunnel implementation.
|
org.glyptodon.guacamole.net.basic.websocket.tomcat |
Tomcat WebSocket tunnel implementation.
|
org.glyptodon.guacamole.net.event.listener |
Provides classes for hooking into various events that take place as
users log into and use the Guacamole web application.
|
org.glyptodon.guacamole.properties |
Provides classes for reading properties from the web-application-wide
guacamole.properties file.
|
org.glyptodon.guacamole.protocol |
Classes relating directly to the Guacamole protocol.
|
org.glyptodon.guacamole.servlet |
Classes which build upon the Java Servlet API, providing an HTTP-based
tunnel and session management.
|
Modifier and Type | Method and Description |
---|---|
Map<String,GuacamoleConfiguration> |
BasicFileAuthenticationProvider.getAuthorizedConfigurations(Credentials credentials) |
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 |
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 |
ReaderGuacamoleReader.available() |
boolean |
GuacamoleReader.available()
Returns whether instruction data is available for reading.
|
char[] |
ReaderGuacamoleReader.read() |
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.
|
GuacamoleInstruction |
ReaderGuacamoleReader.readInstruction() |
GuacamoleInstruction |
GuacamoleReader.readInstruction()
Reads exactly one complete Guacamole instruction and returns the fully
parsed instruction.
|
void |
GuacamoleWriter.write(char[] chunk)
Writes the entire given array of characters to the Guacamole instruction
stream.
|
void |
WriterGuacamoleWriter.write(char[] chunk) |
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.write(char[] chunk,
int off,
int len) |
void |
GuacamoleWriter.writeInstruction(GuacamoleInstruction instruction)
Writes the given fully parsed instruction to the Guacamole instruction
stream.
|
void |
WriterGuacamoleWriter.writeInstruction(GuacamoleInstruction instruction) |
Modifier and Type | Method and Description |
---|---|
void |
GuacamoleSocket.close()
Releases all resources in use by the connection represented by this
GuacamoleSocket.
|
void |
InetGuacamoleSocket.close() |
void |
GuacamoleTunnel.close()
Release all resources allocated to this GuacamoleTunnel.
|
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 |
---|---|
void |
Directory.add(ObjectType object)
Adds the given object to the overall set.
|
void |
User.addPermission(Permission permission)
Adds the specified permission to this user.
|
GuacamoleSocket |
Connection.connect(GuacamoleClientInformation info)
Establishes a connection to guacd using the GuacamoleConfiguration
associated with this Connection, and returns the resulting, connected
GuacamoleSocket.
|
GuacamoleSocket |
ConnectionGroup.connect(GuacamoleClientInformation info)
Establishes a connection to guacd using a connection chosen from among
the connections in this ConnectionGroup, and returns the resulting,
connected GuacamoleSocket.
|
ObjectType |
Directory.get(IdentifierType identifier)
Returns the object having the given identifier.
|
Directory<String,Connection> |
ConnectionGroup.getConnectionDirectory()
Retrieves a Directory which can be used to view and manipulate
connections and their configurations, but only as allowed by the
permissions given to the user.
|
Directory<String,ConnectionGroup> |
ConnectionGroup.getConnectionGroupDirectory()
Retrieves a Directory which can be used to view and manipulate
connection groups and their members, but only as allowed by the
permissions given to the user.
|
List<? extends ConnectionRecord> |
Connection.getHistory()
Returns a list of ConnectionRecords representing the usage history
of this Connection, including any active users.
|
Set<IdentifierType> |
Directory.getIdentifiers()
Returns a Set containing all identifiers for all objects within this
Directory.
|
Set<Permission> |
User.getPermissions()
Lists all permissions given to this user.
|
ConnectionGroup |
UserContext.getRootConnectionGroup()
Retrieves a connection group which can be used to view and manipulate
connections, but only as allowed by the permissions given to the user of
this UserContext.
|
UserContext |
AuthenticationProvider.getUserContext(Credentials credentials)
Returns the UserContext of the user authorized by the given credentials.
|
Directory<String,User> |
UserContext.getUserDirectory()
Retrieves a Directory which can be used to view and manipulate other
users, but only as allowed by the permissions given to the user of this
UserContext.
|
boolean |
User.hasPermission(Permission permission)
Tests whether this user has the specified permission.
|
void |
Directory.move(IdentifierType identifier,
Directory<IdentifierType,ObjectType> directory)
Moves the object with the given identifier to the given directory.
|
void |
Directory.remove(IdentifierType identifier)
Removes the object with the given identifier from the overall set.
|
void |
User.removePermission(Permission permission)
Removes the specified permission from this specified user.
|
void |
Directory.update(ObjectType object)
Updates the stored object with the data contained in the given object.
|
UserContext |
AuthenticationProvider.updateUserContext(UserContext context,
Credentials credentials)
Returns a new or updated UserContext for the user authorized by the
give credentials and having the given existing UserContext.
|
Modifier and Type | Method and Description |
---|---|
void |
SimpleConnectionDirectory.add(Connection connection) |
void |
SimpleConnectionGroupDirectory.add(ConnectionGroup connectionGroup) |
void |
SimpleUserDirectory.add(User user) |
void |
SimpleUser.addPermission(Permission permission) |
GuacamoleSocket |
SimpleConnection.connect(GuacamoleClientInformation info) |
GuacamoleSocket |
SimpleConnectionGroup.connect(GuacamoleClientInformation info) |
ConnectionGroup |
SimpleConnectionGroupDirectory.get(String identifier) |
User |
SimpleUserDirectory.get(String username) |
Connection |
SimpleConnectionDirectory.get(String identifier) |
abstract Map<String,GuacamoleConfiguration> |
SimpleAuthenticationProvider.getAuthorizedConfigurations(Credentials credentials)
Given an arbitrary credentials object, returns a Map containing all
configurations authorized by those credentials.
|
Directory<String,Connection> |
SimpleConnectionGroup.getConnectionDirectory() |
Directory<String,ConnectionGroup> |
SimpleConnectionGroup.getConnectionGroupDirectory() |
List<ConnectionRecord> |
SimpleConnection.getHistory() |
Set<String> |
SimpleConnectionGroupDirectory.getIdentifiers() |
Set<String> |
SimpleUserDirectory.getIdentifiers() |
Set<String> |
SimpleConnectionDirectory.getIdentifiers() |
Set<Permission> |
SimpleUser.getPermissions() |
ConnectionGroup |
SimpleUserContext.getRootConnectionGroup() |
UserContext |
SimpleAuthenticationProvider.getUserContext(Credentials credentials) |
Directory<String,User> |
SimpleUserContext.getUserDirectory() |
boolean |
SimpleUser.hasPermission(Permission permission) |
void |
SimpleConnectionDirectory.move(String identifier,
Directory<String,Connection> directory) |
void |
SimpleConnectionGroupDirectory.move(String identifier,
Directory<String,ConnectionGroup> directory) |
void |
SimpleUserDirectory.move(String identifier,
Directory<String,User> directory) |
void |
SimpleConnectionGroupDirectory.remove(String identifier) |
void |
SimpleUserDirectory.remove(String username) |
void |
SimpleConnectionDirectory.remove(String identifier) |
void |
SimpleUser.removePermission(Permission permission) |
void |
SimpleConnectionDirectory.update(Connection connection) |
void |
SimpleConnectionGroupDirectory.update(ConnectionGroup connectionGroup) |
void |
SimpleUserDirectory.update(User user) |
UserContext |
SimpleAuthenticationProvider.updateUserContext(UserContext context,
Credentials credentials) |
Modifier and Type | Method and Description |
---|---|
protected void |
BasicGuacamoleTunnelServlet.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected abstract void |
AuthenticatingHttpServlet.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Function called after the credentials given in the request (if any)
are authenticated.
|
protected void |
CaptureClipboard.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
boolean |
MonitoringGuacamoleReader.available() |
static GuacamoleTunnel |
BasicTunnelRequestUtility.createTunnel(javax.servlet.http.HttpServletRequest request)
Creates a new tunnel using the parameters and credentials present in
the given request.
|
static GuacamoleClassLoader |
GuacamoleClassLoader.getInstance()
Returns an instance of a GuacamoleClassLoader which finds classes
within the directory configured in guacamole.properties.
|
char[] |
MonitoringGuacamoleReader.read() |
GuacamoleInstruction |
MonitoringGuacamoleReader.readInstruction() |
Modifier and Type | Method and Description |
---|---|
protected void |
Delete.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Update.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
List.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Move.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Create.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
GuacamoleSocket |
DummyConnectionGroup.connect(GuacamoleClientInformation info) |
Directory<String,Connection> |
DummyConnectionGroup.getConnectionDirectory() |
Directory<String,ConnectionGroup> |
DummyConnectionGroup.getConnectionGroupDirectory() |
Modifier and Type | Method and Description |
---|---|
protected void |
Delete.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Update.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
List.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Move.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Create.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
GuacamoleSocket |
DummyConnection.connect(GuacamoleClientInformation info) |
List<ConnectionRecord> |
DummyConnection.getHistory() |
Modifier and Type | Method and Description |
---|---|
protected void |
List.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Modifier and Type | Method and Description |
---|---|
protected void |
List.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Modifier and Type | Method and Description |
---|---|
void |
DummyUser.addPermission(Permission permission) |
protected void |
Delete.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Update.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
List.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
Create.authenticatedService(UserContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Set<Permission> |
DummyUser.getPermissions() |
boolean |
DummyUser.hasPermission(Permission permission) |
void |
DummyUser.removePermission(Permission permission) |
Constructor and Description |
---|
SessionListenerCollection(javax.servlet.http.HttpSession session)
Creates a new SessionListenerCollection which stores all listeners
defined in guacamole.properties in the provided session.
|
Modifier and Type | Method and Description |
---|---|
Collection<Class> |
EventListenersProperty.parseValue(String classNameList) |
AuthenticationProvider |
AuthenticationProviderProperty.parseValue(String authProviderClassName) |
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleWebSocketTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request) |
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleWebSocketTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request) |
Modifier and Type | Method and Description |
---|---|
void |
AuthenticationFailureListener.authenticationFailed(AuthenticationFailureEvent e)
Event hook which fires immediately after a user's authentication attempt
fails.
|
boolean |
AuthenticationSuccessListener.authenticationSucceeded(AuthenticationSuccessEvent e)
Event hook which fires immediately after a user's authentication attempt
succeeds.
|
boolean |
TunnelCloseListener.tunnelClosed(TunnelCloseEvent e)
Event hook which fires immediately after an existing tunnel is closed.
|
boolean |
TunnelConnectListener.tunnelConnected(TunnelConnectEvent e)
Event hook which fires immediately after a new tunnel is connected.
|
Modifier and Type | Method and Description |
---|---|
static <Type> Type |
GuacamoleProperties.getProperty(GuacamoleProperty<Type> property)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
static <Type> Type |
GuacamoleProperties.getProperty(GuacamoleProperty<Type> property,
Type defaultValue)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
static <Type> Type |
GuacamoleProperties.getRequiredProperty(GuacamoleProperty<Type> property)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties.
|
Type |
GuacamoleProperty.parseValue(String value)
Parses the given string value into the type associated with this
GuacamoleProperty.
|
Boolean |
BooleanGuacamoleProperty.parseValue(String value) |
Long |
LongGuacamoleProperty.parseValue(String value) |
Integer |
IntegerGuacamoleProperty.parseValue(String value) |
String |
StringGuacamoleProperty.parseValue(String value) |
File |
FileGuacamoleProperty.parseValue(String value) |
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.
|
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.
|
Constructor and Description |
---|
GuacamoleSession(javax.servlet.http.HttpSession session)
Creates a new GuacamoleSession, storing and retrieving tunnels from the
given HttpSession.
|
Copyright © 2015. All rights reserved.