Package org.apache.guacamole.net.auth

Provides classes which can be used to extend or replace the authentication functionality of the Guacamole web application.

Interface Summary

Interface	Description
ActiveConnection	A pairing of username and GuacamoleTunnel representing an active usage of a particular connection.
ActivityLog	An arbitrary log of an activity whose content may be exposed to a user with sufficient privileges.
ActivityRecord	A logging record describing when a user started and ended a particular activity.
ActivityRecordSet<RecordType extends ActivityRecord>	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.
Attributes	An object which is associated with a set of arbitrary attributes that may be modifiable, defined as name/value pairs.
AuthenticatedUser	A user of the Guacamole web application who has been authenticated by an AuthenticationProvider.
AuthenticationProvider	Provides means of authorizing users and for accessing and managing data associated with those users.
Connectable	An object which Guacamole can connect to.
Connection	Represents a pairing of a GuacamoleConfiguration with a unique, human-readable identifier, and abstracts the connection process.
ConnectionGroup	Represents a connection group, which can contain both other connection groups as well as connections.
ConnectionRecord	A logging record describing when a user started and ended usage of a particular connection.
ConnectionRecordSet	Deprecated. Use ActivityRecordSet<ConnectionRecord> instead.
Directory<ObjectType extends Identifiable>	Provides access to a collection of all objects with associated identifiers, and allows user manipulation and removal.
Identifiable	An object which has a deterministic, unique identifier, which may not be null.
Permissions	An object which may be granted permissions to access/manipulate various other objects or aspects of the system.
ReadableAttributes	An object which is associated with a set of arbitrary attributes, defined as name/value pairs.
RelatedObjectSet	An arbitrary set of existing objects sharing some common relation.
Shareable<T>	An object which can be shared with others via specially-generated sets of credentials.
SharingProfile	Represents the semantics which apply to an existing connection when shared, along with a human-readable name and unique identifier.
User	A user of the Guacamole web application.
UserContext	The context of an active user.
UserGroup	A user group of the Guacamole web application.

Class Summary

Class	Description
AbstractActiveConnection	Base implementation of an ActiveConnection, providing storage and simply getters/setters for its main properties.
AbstractActivityLog	Base implementation of an ActivityLog, providing storage and simple getters/setters for its main properties.
AbstractAuthenticatedUser	Basic implementation of an AuthenticatedUser which uses the username to determine equality.
AbstractAuthenticationProvider	Base implementation of AuthenticationProvider which provides default implementations of most functions.
AbstractConnection	Basic implementation of a Guacamole connection.
AbstractConnectionGroup	Basic implementation of a Guacamole connection group.
AbstractIdentifiable	Abstract implementation of Identifiable which provides equals() and hashCode() implementations which use the identifier to determine equality.
AbstractSharingProfile	Base implementation of a sharing profile which can be used to share a Guacamole connection.
AbstractUser	Base implementation of User which provides default implementations of most functions.
AbstractUserContext	Base implementation of UserContext which provides default implementations of most functions.
AbstractUserGroup	Base implementation of UserGroup which provides default implementations of most functions.
Credentials	Simple arbitrary set of credentials, including a username/password pair, the HttpServletRequest associated with the request for authorization (if any) and the HttpSession associated with that request.
DecoratingActivityRecordSet<RecordType extends ActivityRecord>	ActivityRecordSet implementation which simplifies decorating the records within an underlying ActivityRecordSet.
DecoratingDirectory<ObjectType extends Identifiable>	Directory implementation which simplifies decorating the objects within an underlying Directory.
DelegatingActivityRecord	ActivityRecord implementation which simply delegates all function calls to an underlying ActivityRecord.
DelegatingActivityRecordSet<RecordType extends ActivityRecord>	ActivityRecordSet implementation which simply delegates all function calls to an underlying ActivityRecordSet.
DelegatingConnection	Connection implementation which simply delegates all function calls to an underlying Connection.
DelegatingConnectionGroup	ConnectionGroup implementation which simply delegates all function calls to an underlying ConnectionGroup.
DelegatingConnectionRecord	ConnectionRecord implementation which simply delegates all function calls to an underlying ConnectionRecord.
DelegatingDirectory<ObjectType extends Identifiable>	Directory implementation which simply delegates all function calls to an underlying Directory.
DelegatingSharingProfile	SharingProfile implementation which simply delegates all function calls to an underlying SharingProfile.
DelegatingUser	User implementation which simply delegates all function calls to an underlying User.
DelegatingUserContext	UserContext implementation which simply delegates all function calls to an underlying UserContext.
DelegatingUserGroup	UserGroup implementation which simply delegates all function calls to an underlying UserGroup.
FileActivityLog	ActivityLog implementation that exposes the content of a local file.
GuacamoleProxyConfiguration	Information which describes how the connection to guacd should be established.
TokenInjectingConnection	Connection implementation which overrides the connect() function of an underlying Connection, adding a given set of parameter tokens to the tokens already supplied.
TokenInjectingConnectionGroup	ConnectionGroup implementation which overrides the connect() function of an underlying ConnectionGroup, adding a given set of parameter tokens to the tokens already supplied.
TokenInjectingUserContext	UserContext implementation which decorates a given UserContext, automatically applying additional parameter tokens during the connection process of any retrieved Connections and ConnectionGroups.
User.Attribute	All standard attribute names with semantics defined by the Guacamole web application.

Enum Summary

Enum	Description
ActivityLog.Type	All possible types of ActivityLog.
ActivityRecordSet.SortableProperty	All properties of activity records which can be used as sorting criteria.
ConnectionGroup.Type	All legal types of connection group.
GuacamoleProxyConfiguration.EncryptionMethod	All possible types of encryption used by guacd.