All Classes and Interfaces
Class
Description
Base implementation of an ActiveConnection, providing storage and simply
getters/setters for its main properties.
Base implementation of an ActivityLog, providing storage and simple
getters/setters for its main properties.
Basic implementation of an AuthenticatedUser which uses the username to
determine equality.
Base implementation of AuthenticationProvider which provides default
implementations of most functions.
Basic implementation of a Guacamole connection.
Basic implementation of a Guacamole connection group.
Abstract implementation of Identifiable which provides equals() and
hashCode() implementations which use the identifier to determine equality.
Base implementation of a sharing profile which can be used to share a
Guacamole connection.
Base implementation of User which provides default implementations of
most functions.
Base implementation of UserContext which provides default implementations of
most functions.
Base implementation of UserGroup which provides default implementations of
most functions.
A pairing of username and GuacamoleTunnel representing an active usage of a
particular connection.
An arbitrary log of an activity whose content may be exposed to a user with
sufficient privileges.
All possible types of
ActivityLog
.A logging record describing when a user started and ended a particular
activity.
A set of all available records related to a type of activity which has a
defined start and end time, such as a user being logged in or connected, or a
subset of those records.
All properties of activity records which can be used as sorting
criteria.
Event that is dispatched when the web application has nearly completely shut
down, including the authentication/authorization portion of extensions.
Event that is dispatched when the web application has finished starting up,
including all extensions.
An operation that should be attempted atomically when passed to
Directory.tryAtomically(org.apache.guacamole.net.auth.AtomicDirectoryOperation<ObjectType>)
, if atomic operations are supported by
the Directory.An object which is associated with a set of arbitrary attributes that may
be modifiable, defined as name/value pairs.
A user of the Guacamole web application who has been authenticated by an
AuthenticationProvider.
An event which is triggered whenever a user's credentials fail to be
authenticated.
Deprecated.
Provides means of authorizing users and for accessing and managing data
associated with those users.
An event which may be dispatched due to a specific AuthenticationProvider.
An event which is triggered whenever a user's credentials have been
submitted for authentication, but that latest authentication request has not
yet succeeded or failed.
Representation of an in-progress authentication attempt.
Manager service that temporarily stores a user's authentication status while
the authentication flow is underway.
An event which is triggered whenever a user's credentials pass
authentication.
Deprecated.
Listeners should instead implement the
Listener
interface.Represents a field with strictly one possible value.
A GuacamoleProperty whose value is an boolean.
A GuacamoleProperty whose value is a byte array.
An enum that supports configuring various user and group case sensitivity
settings.
An object which Guacamole can connect to.
Represents a pairing of a GuacamoleConfiguration with a unique,
human-readable identifier, and abstracts the connection process.
Represents a connection group, which can contain both other connection groups
as well as connections.
All legal types of connection group.
A logging record describing when a user started and ended usage of a
particular connection.
Deprecated.
Use
ActivityRecordSet
<ConnectionRecord
> instead.Abstract basis for events which may have associated user credentials when
triggered.
Simple arbitrary set of credentials, including a username/password pair and
a copy of the details of the HTTP request received for authentication.
Information which describes a set of valid credentials.
Represents a date field.
ActivityRecordSet implementation which simplifies decorating the records
within an underlying ActivityRecordSet.
Directory implementation which simplifies decorating the objects within an
underlying Directory.
ActivityRecord implementation which simply delegates all function calls to an
underlying ActivityRecord.
ActivityRecordSet implementation which simply delegates all function calls
to an underlying ActivityRecordSet.
Connection implementation which simply delegates all function calls to an
underlying Connection.
ConnectionGroup implementation which simply delegates all function calls to
an underlying ConnectionGroup.
ConnectionRecord implementation which simply delegates all function calls to
an underlying ConnectionRecord.
Directory implementation which simply delegates all function calls to an
underlying Directory.
Environment implementation which simply delegates all function calls to a
wrapped Environment instance.
SharingProfile implementation which simply delegates all function calls to an
underlying SharingProfile.
User implementation which simply delegates all function calls to an
underlying User.
UserContext implementation which simply delegates all function calls to
an underlying UserContext.
UserGroup implementation which simply delegates all function calls to an
underlying UserGroup.
Provides access to a collection of all objects with associated identifiers,
and allows user manipulation and removal.
All Directory types that may be found on the
UserContext
interface.Abstract basis for events which involve a modification made to the objects
within a
Directory
through the operations exposed by the Directory
interface.The types of directory operations that may be represented by a
DirectoryEvent.
Event that is dispatched whenever a REST API request to create/modify/delete
an object within a
Directory
fails.Event that is dispatched whenever a REST API request to create/modify/delete
an object within a
Directory
succeeds.An interface that defines items that can be enabled or disabled.
A simple ContentHandler implementation which digests SAX document events and
produces simpler tag-level events, maintaining its own stack for the
convenience of the tag handlers.
Represents a text field which may contain an email address.
Represents an arbitrary field with a finite, enumerated set of possible
values.
A GuacamoleProperty whose possible values are defined by an enum.
Defines the string value which should be accepted and parsed into the
annotated enum constant.
Defines the string values which should be accepted and parsed into the
annotated enum constant.
The environment of an arbitrary Guacamole instance, describing available
protocols, configuration parameters, and the GUACAMOLE_HOME directory.
An event which represents failure of an operation, where that failure may
be associated with a particular Throwable.
Represents an arbitrary field, such as an HTTP parameter, the parameter of a
remote desktop protocol, or an input field within a form.
All types of fields which are available by default.
Describes an available legal value for an enumerated field.
ActivityLog implementation that exposes the content of a local file.
GuacamoleProperties implementation which reads all properties from a
standard Java properties file.
A GuacamoleProperty whose value is a filename.
Information which describes logical set of fields.
A security-related exception thrown when access is denied to a user because
of a problem related to the provided credentials.
A security-related exception thrown when access is denied to a user because
the provided credentials are not sufficient for authentication to succeed.
A security-related exception thrown when access is denied to a user because
the provided credentials are invalid.
An arbitrary set of Guacamole configuration property name/value pairs.
An abstract representation of a property in the guacamole.properties file,
which parses into a specific type.
Information which describes how the connection to guacd should be
established.
All possible types of encryption used by guacd.
An exception thrown when a token cannot be substituted because it has no
corresponding value.
An object which has a deterministic, unique identifier, which may not be
null.
Abstract basis for events which affect or directly relate to objects that
are
Identifiable
and may be stored within a Directory
.Generator of unique and unpredictable identifiers.
A GuacamoleProperty whose value is an integer.
A GuacamoleProperty implementation that parses a String for a comma-separated
list of IP addresses and/or IP subnets, both IPv4 and IPv6, and returns the
list of those valid IP addresses/subnets.
Represents a language field.
A listener for events that occur in handing various Guacamole requests
such as authentication, tunnel connect/close, etc.
The environment of the locally-running Guacamole instance, describing
available protocols, configuration parameters, and the GUACAMOLE_HOME
directory.
A GuacamoleProperty whose value is an long.
Represents a field which can contain multiple lines of text.
An object which has a human-readable, arbitrary name.
Represents a field which may contain only integer values.
A permission which affects a specific object, rather than the system as a
whole.
Specific types of object-level permissions.
A set of permissions which affect arbitrary objects, where each object has
an associated unique identifier.
Represents a field which contains sensitive text information related to
authenticating a user.
A permission which affects a specific type of operation, where all available
operation types are defined by an enumeration.
An object which may be granted permissions to access/manipulate various
other objects or aspects of the system.
An arbitrary set of permissions.
GuacamoleProperties implementation which reads all properties from a
Properties
object.Describes a protocol and all parameters associated with it, as required by
a protocol plugin for guacd.
An object which is associated with a set of arbitrary attributes, defined
as name/value pairs.
A Guacamole field that redirects a user to another page.
An arbitrary set of existing objects sharing some common relation.
A copy of the details of an HTTP request.
An object which can be shared with others via specially-generated sets of
credentials.
Represents the semantics which apply to an existing connection when shared,
along with a human-readable name and unique identifier.
An immutable and empty ActivityRecordSet.
Provides means of retrieving a set of named GuacamoleConfigurations for a
given Credentials object.
A Connection implementation which establishes the underlying connection to
guacd using the configuration information provided in guacamole.properties.
Deprecated.
Use
SimpleDirectory
instead.An extremely simple read-only implementation of a ConnectionGroup which
returns the connection and connection group identifiers it was constructed
with.
Deprecated.
Use
SimpleDirectory
instead.Deprecated.
Use
SimpleActivityRecordSet
<ConnectionRecord
>
instead.An extremely simple read-only implementation of a Directory which provides
access to a pre-defined Map of arbitrary objects.
A read-only implementation of ObjectPermissionSet which uses a backing Set
of Permissions to determine which permissions are present.
A read-only implementation of RelatedObjectSet which uses a backing Set
of identifiers to determine which objects are present.
A read-only implementation of SystemPermissionSet which uses a backing Set
of Permissions to determine which permissions are present.
A read-only User implementation which has no permissions.
An extremely simple UserContext implementation which provides access to
a defined and restricted set of GuacamoleConfigurations.
Deprecated.
Use
SimpleDirectory
instead.A read-only UserGroup implementation which has no members and no
permissions.
Deprecated.
Standard tokens are now supplied by default to the connect()
functions of connections and connection groups.
A GuacamoleProperty whose value is a simple string.
Deprecated.
This class is now deprecated in favor of using the StringGuacamoleProperty
class with the parseValueCollection method.
A permission which affects the system as a whole, rather than an individual
object.
Specific types of system-level permissions.
A set of permissions which affects the system as a whole.
A simple element-level event handler for events triggered by the
SAX-driven DocumentHandler parser.
Represents a terminal color scheme field.
Represents a basic text field.
Represents a time field.
Represents a time zone field.
A GuacamoleProperty whose value is a TimeZone.
Filtering object which replaces tokens of the form "${TOKEN_NAME}" with
their corresponding values.
Connection implementation which overrides the connect() function of an
underlying Connection, adding a given set of parameter tokens to the tokens
already supplied.
ConnectionGroup implementation which overrides the connect() function of an
underlying ConnectionGroup, adding a given set of parameter tokens to the
tokens already supplied.
UserContext implementation which decorates a given UserContext,
automatically applying additional parameter tokens during the connection
process of any retrieved Connections and ConnectionGroups.
Utility class for generating parameter token names.
An object which is associated with a translatable message that can be passed
through an arbitrary translation service, producing a human-readable message
in the user's native language.
A
GuacamoleClientBadTypeException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleClientException
whose associated message is translatable
and can be passed through an arbitrary translation service, producing a
human-readable message in the user's native language.A
GuacamoleClientOverrunException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleClientTimeoutException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleClientTooManyException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleConnectionClosedException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleCredentialsException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleInsufficientCredentialsException
whose associated message
is translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleInvalidCredentialsException
whose associated message
is translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleResourceClosedException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleResourceConflictException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleResourceNotFoundException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleSecurityException
whose associated message is translatable
and can be passed through an arbitrary translation service, producing a
human-readable message in the user's native language.A
GuacamoleServerBusyException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleServerException
whose associated message is translatable
and can be passed through an arbitrary translation service, producing a
human-readable message in the user's native language.A
GuacamoleSessionClosedException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleSessionConflictException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleSessionTimeoutException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleUnauthorizedException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleUnsupportedException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleUpstreamException
whose associated message is translatable
and can be passed through an arbitrary translation service, producing a
human-readable message in the user's native language.A
GuacamoleUpstreamNotFoundException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleUpstreamTimeoutException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A
GuacamoleUpstreamUnavailableException
whose associated message is
translatable and can be passed through an arbitrary translation service,
producing a human-readable message in the user's native language.A message which can be translated using a translation service, providing a
translation key and optional set of values to be substituted into the
translation string associated with that key.
An event which is triggered whenever a tunnel is being closed.
Deprecated.
Listeners should instead implement the
Listener
interface.An event which is triggered whenever a tunnel is being connected.
Deprecated.
Listeners should instead implement the
Listener
interface.Abstract basis for events associated with tunnels.
A GuacamoleProperty whose value is a URI.
A user of the Guacamole web application.
All standard attribute names with semantics defined by the Guacamole web
application.
The context of an active user.
A fully-valid set of credentials and associated values.
Abstract basis for events which may have an associated AuthenticatedUser when
triggered.
A user group of the Guacamole web application.
Represents a text field which will contain the uniquely-identifying name of
a user.
Event that is dispatched when a user has logged out or their session has
expired.
Listener
interface.