Skip navigation links
A B C D E F G H I L M N O P Q R S T U V 

A

AbstractActiveConnection - Class in org.apache.guacamole.net.auth
Base implementation of an ActiveConnection, providing storage and simply getters/setters for its main properties.
AbstractActiveConnection() - Constructor for class org.apache.guacamole.net.auth.AbstractActiveConnection
 
AbstractAuthenticatedUser - Class in org.apache.guacamole.net.auth
Basic implementation of an AuthenticatedUser which uses the username to determine equality.
AbstractAuthenticatedUser() - Constructor for class org.apache.guacamole.net.auth.AbstractAuthenticatedUser
 
AbstractConnection - Class in org.apache.guacamole.net.auth
Basic implementation of a Guacamole connection.
AbstractConnection() - Constructor for class org.apache.guacamole.net.auth.AbstractConnection
 
AbstractConnectionGroup - Class in org.apache.guacamole.net.auth
Basic implementation of a Guacamole connection group.
AbstractConnectionGroup() - Constructor for class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
AbstractIdentifiable - Class in org.apache.guacamole.net.auth
Abstract implementation of Identifiable which provides equals() and hashCode() implementations which use the identifier to determine equality.
AbstractIdentifiable() - Constructor for class org.apache.guacamole.net.auth.AbstractIdentifiable
 
AbstractSharingProfile - Class in org.apache.guacamole.net.auth
Base implementation of a sharing profile which can be used to share a Guacamole connection.
AbstractSharingProfile() - Constructor for class org.apache.guacamole.net.auth.AbstractSharingProfile
 
AbstractUser - Class in org.apache.guacamole.net.auth
Basic implementation of a Guacamole user which uses the username to determine equality.
AbstractUser() - Constructor for class org.apache.guacamole.net.auth.AbstractUser
 
ActiveConnection - Interface in org.apache.guacamole.net.auth
A pairing of username and GuacamoleTunnel representing an active usage of a particular connection.
add(ObjectType) - Method in interface org.apache.guacamole.net.auth.Directory
Adds the given object to the overall set.
add(ObjectType) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
addPermission(ObjectPermission.Type, String) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
Adds the specified permission for the object having the given identifier.
addPermission(SystemPermission.Type) - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
Adds the specified permission.
addPermission(ObjectPermission.Type, String) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
addPermission(SystemPermission.Type) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 
addPermissions(Set<ObjectPermission>) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
 
addPermissions(Set<PermissionType>) - Method in interface org.apache.guacamole.net.auth.permission.PermissionSet
Adds the specified permissions, if not already granted.
addPermissions(Set<SystemPermission>) - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
 
addPermissions(Set<ObjectPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
addPermissions(Set<SystemPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 
addStandardTokens(TokenFilter) - Static method in class org.apache.guacamole.token.StandardTokens
Adds tokens which are standardized by guacamole-ext to the given TokenFilter and which do not require a corresponding Credentials object.
addStandardTokens(TokenFilter, Credentials) - Static method in class org.apache.guacamole.token.StandardTokens
Adds tokens which are standardized by guacamole-ext to the given TokenFilter using the values from the given Credentials object.
ANONYMOUS_IDENTIFIER - Static variable in interface org.apache.guacamole.net.auth.AuthenticatedUser
The identifier reserved for representing a user that has authenticated anonymously.
asCollection() - Method in interface org.apache.guacamole.net.auth.ConnectionRecordSet
Returns all connection records within this set as a standard Collection.
asCollection() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionRecordSet
 
Attribute() - Constructor for class org.apache.guacamole.net.auth.User.Attribute
 
AuthenticatedUser - Interface in org.apache.guacamole.net.auth
A user of the Guacamole web application who has been authenticated by an AuthenticationProvider.
authenticateUser(Credentials) - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns an AuthenticatedUser representing the user authenticated by the given credentials, if any.
authenticateUser(Credentials) - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
authenticationFailed(AuthenticationFailureEvent) - Method in interface org.apache.guacamole.net.event.listener.AuthenticationFailureListener
Event hook which fires immediately after a user's authentication attempt fails.
AuthenticationFailureEvent - Class in org.apache.guacamole.net.event
An event which is triggered whenever a user's credentials fail to be authenticated.
AuthenticationFailureEvent(Credentials) - Constructor for class org.apache.guacamole.net.event.AuthenticationFailureEvent
Creates a new AuthenticationFailureEvent which represents the failure to authenticate the given credentials.
AuthenticationFailureListener - Interface in org.apache.guacamole.net.event.listener
A listener whose authenticationFailed() hook will fire immediately after a user's authentication attempt fails.
AuthenticationProvider - Interface in org.apache.guacamole.net.auth
Provides means of authorizing users and for accessing and managing data associated with those users.
authenticationSucceeded(AuthenticationSuccessEvent) - Method in interface org.apache.guacamole.net.event.listener.AuthenticationSuccessListener
Event hook which fires immediately after a user's authentication attempt succeeds.
AuthenticationSuccessEvent - Class in org.apache.guacamole.net.event
An event which is triggered whenever a user's credentials pass authentication.
AuthenticationSuccessEvent(UserContext, Credentials) - Constructor for class org.apache.guacamole.net.event.AuthenticationSuccessEvent
Creates a new AuthenticationSuccessEvent which represents a successful authentication attempt with the given credentials.
AuthenticationSuccessListener - Interface in org.apache.guacamole.net.event.listener
A listener whose hooks will fire immediately before and after a user's authentication attempt succeeds.

B

BOOLEAN - Static variable in class org.apache.guacamole.form.Field.Type
A boolean field, whose value is either blank or "true".
BooleanField - Class in org.apache.guacamole.form
Represents a field with strictly one possible value.
BooleanField(String, String) - Constructor for class org.apache.guacamole.form.BooleanField
Creates a new BooleanField with the given name and truth value.
BooleanGuacamoleProperty - Class in org.apache.guacamole.properties
A GuacamoleProperty whose value is an boolean.
BooleanGuacamoleProperty() - Constructor for class org.apache.guacamole.properties.BooleanGuacamoleProperty
 

C

characters(char[], int, int) - Method in class org.apache.guacamole.xml.DocumentHandler
 
childElement(String) - Method in interface org.apache.guacamole.xml.TagHandler
Called when a child element of the current element is parsed.
CLIENT_ADDRESS_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the client address token added via addStandardTokens().
CLIENT_HOSTNAME_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the client hostname token added via addStandardTokens().
complete(String) - Method in interface org.apache.guacamole.xml.TagHandler
Called when this element, and all child elements, have been fully parsed, and the entire text content of this element (if any) is available.
connect(GuacamoleClientInformation) - Method in interface org.apache.guacamole.net.auth.Connectable
Establishes a connection to guacd using the information associated with this object.
connect(GuacamoleClientInformation) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnection
 
connect(GuacamoleClientInformation) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
Connectable - Interface in org.apache.guacamole.net.auth
An object which Guacamole can connect to.
Connection - Interface in org.apache.guacamole.net.auth
Represents a pairing of a GuacamoleConfiguration with a unique, human-readable identifier, and abstracts the connection process.
ConnectionGroup - Interface in org.apache.guacamole.net.auth
Represents a connection group, which can contain both other connection groups as well as connections.
ConnectionGroup.Type - Enum in org.apache.guacamole.net.auth
All legal types of connection group.
ConnectionRecord - Interface in org.apache.guacamole.net.auth
A logging record describing when a user started and ended usage of a particular connection.
ConnectionRecordSet - Interface in org.apache.guacamole.net.auth
The set of all available connection records, or a subset of those records.
ConnectionRecordSet.SortableProperty - Enum in org.apache.guacamole.net.auth
All properties of connection records which can be used as sorting criteria.
contains(String) - Method in interface org.apache.guacamole.net.auth.ConnectionRecordSet
Returns the subset of connection records to only those where the connection name, user identifier, or any associated date field contain the given value.
contains(String) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionRecordSet
 
CredentialEvent - Interface in org.apache.guacamole.net.event
Abstract basis for events which may have associated user credentials when triggered.
Credentials - Class in org.apache.guacamole.net.auth
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.
Credentials() - Constructor for class org.apache.guacamole.net.auth.Credentials
 
CredentialsInfo - Class in org.apache.guacamole.net.auth.credentials
Information which describes a set of valid credentials.
CredentialsInfo(Collection<Field>) - Constructor for class org.apache.guacamole.net.auth.credentials.CredentialsInfo
Creates a new CredentialsInfo object which requires the given fields for any conforming credentials.

D

DATE - Static variable in class org.apache.guacamole.form.Field.Type
A date field whose legal values conform to the pattern "YYYY-MM-DD", zero-padded.
DATE_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the date token (server-local time) added via addStandardTokens().
DateField - Class in org.apache.guacamole.form
Represents a date field.
DateField(String) - Constructor for class org.apache.guacamole.form.DateField
Creates a new DateField with the given name.
Directory<ObjectType extends Identifiable> - Interface in org.apache.guacamole.net.auth
Provides access to a collection of all objects with associated identifiers, and allows user manipulation and removal.
DocumentHandler - Class in org.apache.guacamole.xml
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.
DocumentHandler(String, TagHandler) - Constructor for class org.apache.guacamole.xml.DocumentHandler
Creates a new DocumentHandler which will use the given TagHandler to handle the root element.

E

EMAIL - Static variable in class org.apache.guacamole.form.Field.Type
An email address field.
EMAIL_ADDRESS - Static variable in class org.apache.guacamole.net.auth.User.Attribute
The email address of the user.
EmailField - Class in org.apache.guacamole.form
Represents a text field which may contain an email address.
EmailField(String) - Constructor for class org.apache.guacamole.form.EmailField
Creates a new EmailField with the given name.
EMPTY - Static variable in class org.apache.guacamole.net.auth.credentials.CredentialsInfo
CredentialsInfo object which describes empty credentials.
endElement(String, String, String) - Method in class org.apache.guacamole.xml.DocumentHandler
 
ENUM - Static variable in class org.apache.guacamole.form.Field.Type
An enumerated field, whose legal values are fully enumerated by a provided, finite list.
EnumField - Class in org.apache.guacamole.form
Represents an arbitrary field with a finite, enumerated set of possible values.
EnumField(String, Collection<String>) - Constructor for class org.apache.guacamole.form.EnumField
Creates a new EnumField with the given name and possible values.
Environment - Interface in org.apache.guacamole.environment
The environment of an arbitrary Guacamole instance, describing available protocols, configuration parameters, and the GUACAMOLE_HOME directory.
equals(Object) - Method in class org.apache.guacamole.net.auth.AbstractIdentifiable
 
equals(Object) - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
equals(Object) - Method in class org.apache.guacamole.net.auth.permission.ObjectPermission
 
equals(Object) - Method in class org.apache.guacamole.net.auth.permission.SystemPermission
 

F

Field - Class in org.apache.guacamole.form
Represents an arbitrary field, such as an HTTP parameter, the parameter of a remote desktop protocol, or an input field within a form.
Field() - Constructor for class org.apache.guacamole.form.Field
Creates a new Parameter with no associated name or type.
Field(String, String) - Constructor for class org.apache.guacamole.form.Field
Creates a new Field with the given name and type.
Field(String, String, Collection<String>) - Constructor for class org.apache.guacamole.form.Field
Creates a new Field with the given name, type, and possible values.
Field.Type - Class in org.apache.guacamole.form
All types of fields which are available by default.
FieldOption - Class in org.apache.guacamole.form
Describes an available legal value for an enumerated field.
FieldOption() - Constructor for class org.apache.guacamole.form.FieldOption
Creates a new FieldOption with no associated value or title.
FieldOption(String, String) - Constructor for class org.apache.guacamole.form.FieldOption
Creates a new FieldOption having the given value and title.
FileGuacamoleProperty - Class in org.apache.guacamole.properties
A GuacamoleProperty whose value is a filename.
FileGuacamoleProperty() - Constructor for class org.apache.guacamole.properties.FileGuacamoleProperty
 
filter(String) - Method in class org.apache.guacamole.token.TokenFilter
Filters the given string, replacing any tokens with their corresponding values.
filterValues(Map<?, String>) - Method in class org.apache.guacamole.token.TokenFilter
Given an arbitrary map containing String values, replace each non-null value with the corresponding filtered value.
Form - Class in org.apache.guacamole.form
Information which describes logical set of fields.
Form() - Constructor for class org.apache.guacamole.form.Form
Creates a new Form object with no associated fields.
Form(String, Collection<Field>) - Constructor for class org.apache.guacamole.form.Form
Creates a new Form object having the given name and containing the given fields.
FORMAT - Static variable in class org.apache.guacamole.form.DateField
The date format used by date fields, compatible with SimpleDateFormat.
format(Date) - Static method in class org.apache.guacamole.form.DateField
Converts the given date into a string which follows the format used by date fields.
format(Integer) - Static method in class org.apache.guacamole.form.NumericField
Formats the given integer in the format required by a numeric field.
FORMAT - Static variable in class org.apache.guacamole.form.TimeField
The time format used by time fields, compatible with SimpleDateFormat.
format(Date) - Static method in class org.apache.guacamole.form.TimeField
Converts the given time into a string which follows the format used by time fields.
FULL_NAME - Static variable in class org.apache.guacamole.net.auth.User.Attribute
The user's full name.

G

get(String) - Method in interface org.apache.guacamole.net.auth.Directory
Returns the object having the given identifier.
get(String) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
getAccessibleObjects(Collection<ObjectPermission.Type>, Collection<String>) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
Tests whether this user has the specified permissions for the objects having the given identifiers.
getAccessibleObjects(Collection<ObjectPermission.Type>, Collection<String>) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
getActiveConnectionDirectory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getActiveConnectionDirectory() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a Directory which can be used to view and manipulate active connections, but only as allowed by the permissions given to the user.
getActiveConnectionPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getActiveConnectionPermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all permissions given to this user regarding currently-active connections.
getActiveConnections() - Method in interface org.apache.guacamole.net.auth.Connectable
Returns the number of active connections associated with this object.
getActiveConnections() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnection
 
getActiveConnections() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
getAll(Collection<String>) - Method in interface org.apache.guacamole.net.auth.Directory
Returns the objects having the given identifiers.
getAll(Collection<String>) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
getAttributes() - Method in interface org.apache.guacamole.net.auth.Connection
Returns all attributes associated with this connection.
getAttributes() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns all attributes associated with this connection group.
getAttributes() - Method in interface org.apache.guacamole.net.auth.SharingProfile
Returns all attributes associated with this sharing profile.
getAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnection
 
getAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
getAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getAttributes() - Method in interface org.apache.guacamole.net.auth.User
Returns all attributes associated with this user.
getAuthenticationProvider() - Method in interface org.apache.guacamole.net.auth.AuthenticatedUser
Returns the AuthenticationProvider that authenticated this user.
getAuthenticationProvider() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getAuthenticationProvider() - Method in interface org.apache.guacamole.net.auth.UserContext
Returns the AuthenticationProvider which created this UserContext, which may not be the same AuthenticationProvider that authenticated the user associated with this UserContext.
getAuthorizedConfigurations(Credentials) - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials.
getConfiguration() - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
getConfiguration() - Method in interface org.apache.guacamole.net.auth.Connection
Returns the GuacamoleConfiguration associated with this Connection.
getConnectionAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getConnectionAttributes() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a collection of all attributes applicable to connections.
getConnectionDirectory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getConnectionDirectory() - Method in interface org.apache.guacamole.net.auth.UserContext
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.
getConnectionForms() - Method in class org.apache.guacamole.protocols.ProtocolInfo
Returns a mutable collection of forms describing all known parameters for a connection using this protocol.
getConnectionGroupAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getConnectionGroupAttributes() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a collection of all attributes applicable to connection groups.
getConnectionGroupDirectory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getConnectionGroupDirectory() - Method in interface org.apache.guacamole.net.auth.UserContext
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.
getConnectionGroupIdentifiers() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns the identifiers of all readable connection groups that are children of this connection group.
getConnectionGroupIdentifiers() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
getConnectionGroupPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getConnectionGroupPermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all connection group permissions given to this user.
getConnectionHistory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getConnectionHistory() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves all connection records visible to current user.
getConnectionIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getConnectionIdentifier() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the identifier of the connection being actively used.
getConnectionIdentifier() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the identifier of the connection associated with this connection record.
getConnectionIdentifiers() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns the identifiers of all readable connections that are children of this connection group.
getConnectionIdentifiers() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
getConnectionName() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the name of the connection associated with this connection record.
getConnectionPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getConnectionPermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all connection permissions given to this user.
getCredentials() - Method in interface org.apache.guacamole.net.auth.AuthenticatedUser
Returns the credentials that the user provided when they successfully authenticated.
getCredentials() - Method in class org.apache.guacamole.net.event.AuthenticationFailureEvent
 
getCredentials() - Method in class org.apache.guacamole.net.event.AuthenticationSuccessEvent
 
getCredentials() - Method in interface org.apache.guacamole.net.event.CredentialEvent
Returns the current credentials of the user triggering the event, if any.
getCredentials() - Method in class org.apache.guacamole.net.event.TunnelCloseEvent
 
getCredentials() - Method in class org.apache.guacamole.net.event.TunnelConnectEvent
 
getCredentialsInfo() - Method in exception org.apache.guacamole.net.auth.credentials.GuacamoleCredentialsException
Returns information describing the form of valid credentials.
getDefaultGuacamoleProxyConfiguration() - Method in interface org.apache.guacamole.environment.Environment
Returns the connection information which should be used, by default, to connect to guacd when establishing a remote desktop connection.
getDefaultGuacamoleProxyConfiguration() - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getDirectory() - Static method in class org.apache.guacamole.properties.GuacamoleHome
Deprecated.
Returns the Guacamole home directory by checking, in order: the guacamole.home system property, the GUACAMOLE_HOME environment variable, and finally the .guacamole directory in the home directory of the user running the servlet container.
getEncryptionMethod() - Method in class org.apache.guacamole.net.auth.GuacamoleProxyConfiguration
Returns the type of encryption required by guacd.
getEndDate() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the date and time the connection ended, if applicable.
getFields() - Method in class org.apache.guacamole.form.Form
Returns a mutable collection of the fields associated with this form.
getFields() - Method in class org.apache.guacamole.net.auth.credentials.CredentialsInfo
Returns all fields required for valid credentials as described by this object.
getGuacamoleHome() - Method in interface org.apache.guacamole.environment.Environment
Returns the Guacamole home directory as determined when this Environment object was created.
getGuacamoleHome() - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getHistory() - Method in interface org.apache.guacamole.net.auth.Connection
Returns a list of ConnectionRecords representing the usage history of this Connection, including any active users.
getHistory() - Method in class org.apache.guacamole.net.auth.simple.SimpleConnection
 
getHostname() - Method in class org.apache.guacamole.net.auth.GuacamoleProxyConfiguration
Returns the hostname or address of the machine where guacd is running.
getIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractIdentifiable
 
getIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
getIdentifier() - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns the identifier which uniquely and consistently identifies this AuthenticationProvider implementation.
getIdentifier() - Method in interface org.apache.guacamole.net.auth.Identifiable
Returns the unique identifier assigned to this object.
getIdentifiers() - Method in interface org.apache.guacamole.net.auth.Directory
Returns a Set containing all identifiers for all objects within this Directory.
getIdentifiers() - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
getKey() - Method in class org.apache.guacamole.language.TranslatableMessage
Returns the arbitrary key which can be used to look up the message to be displayed in the user's native language.
getName() - Method in class org.apache.guacamole.form.Field
Returns the unique name associated with this field.
getName() - Method in class org.apache.guacamole.form.Form
Returns the name of this form.
getName() - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
getName() - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
getName() - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
getName() - Method in interface org.apache.guacamole.net.auth.Connection
Returns the name assigned to this Connection.
getName() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns the name assigned to this ConnectionGroup.
getName() - Method in interface org.apache.guacamole.net.auth.SharingProfile
Returns the human-readable name assigned to this SharingProfile.
getName() - Method in interface org.apache.guacamole.properties.GuacamoleProperty
Returns the name of the property in guacamole.properties that this GuacamoleProperty will parse.
getName() - Method in class org.apache.guacamole.protocols.ProtocolInfo
Returns the unique name of this protocol.
getObjectIdentifier() - Method in class org.apache.guacamole.net.auth.permission.ObjectPermission
Returns the identifier of the specific object affected by this permission.
getObjects() - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
Returns the Map which currently backs this SimpleDirectory.
getOptions() - Method in class org.apache.guacamole.form.Field
Returns a mutable collection of field options.
getParameters() - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
getParameters() - Method in interface org.apache.guacamole.net.auth.SharingProfile
Returns a map which contains connection parameter name/value pairs as key/value pairs.
getParentIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
getParentIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
getParentIdentifier() - Method in interface org.apache.guacamole.net.auth.Connection
Returns the unique identifier of the parent ConnectionGroup for this Connection.
getParentIdentifier() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns the unique identifier of the parent ConnectionGroup for this ConnectionGroup.
getPassword() - Method in class org.apache.guacamole.net.auth.AbstractUser
 
getPassword() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the password associated with this set of credentials.
getPassword() - Method in interface org.apache.guacamole.net.auth.User
Returns this user's password.
getPermissions() - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
 
getPermissions() - Method in interface org.apache.guacamole.net.auth.permission.PermissionSet
Returns a Set which contains all permissions granted within this permission set.
getPermissions() - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
 
getPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
getPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 
getPort() - Method in class org.apache.guacamole.net.auth.GuacamoleProxyConfiguration
Returns the port that guacd is listening on.
getPrimaryConnectionIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
getPrimaryConnectionIdentifier() - Method in interface org.apache.guacamole.net.auth.SharingProfile
Returns the identifier of the primary connection associated with this connection.
getProperty(GuacamoleProperty<Type>) - Method in interface org.apache.guacamole.environment.Environment
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
getProperty(GuacamoleProperty<Type>, Type) - Method in interface org.apache.guacamole.environment.Environment
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
getProperty(GuacamoleProperty<Type>) - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getProperty(GuacamoleProperty<Type>, Type) - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getProperty(GuacamoleProperty<Type>) - Static method in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
getProperty(GuacamoleProperty<Type>, Type) - Static method in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties, if any.
getProtocol(String) - Method in interface org.apache.guacamole.environment.Environment
Returns the protocol having the given name.
getProtocol(String) - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getProtocols() - Method in interface org.apache.guacamole.environment.Environment
Returns a map of all available protocols, where each key is the name of that protocol as would be passed to guacd during connection.
getProtocols() - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getRemoteAddress() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the address of the client end of the connection which provided these credentials, if known.
getRemoteHost() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getRemoteHost() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the hostname or IP address of the remote host that initiated the connection, if known.
getRemoteHost() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the hostname or IP address of the remote host that used the connection associated with this record, if known.
getRemoteHostname() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the hostname of the client end of the connection which provided these credentials, if known.
getRequest() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the HttpServletRequest associated with this set of credentials.
getRequiredProperty(GuacamoleProperty<Type>) - Method in interface org.apache.guacamole.environment.Environment
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties.
getRequiredProperty(GuacamoleProperty<Type>) - Method in class org.apache.guacamole.environment.LocalEnvironment
 
getRequiredProperty(GuacamoleProperty<Type>) - Static method in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that property in guacamole.properties.
getResource() - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns an arbitrary REST resource representing this AuthenticationProvider.
getResource() - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
getResource() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getResource() - Method in interface org.apache.guacamole.net.auth.UserContext
Returns an arbitrary REST resource representing this UserContext.
getRootConnectionGroup() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getRootConnectionGroup() - Method in interface org.apache.guacamole.net.auth.UserContext
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.
getSession() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the HttpSession associated with this set of credentials.
getSharingCredentials(String) - Method in interface org.apache.guacamole.net.auth.Shareable
Returns a full set of credentials which can be used to authenticate as a user with access strictly to this object.
getSharingProfileAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getSharingProfileAttributes() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a collection of all attributes applicable to sharing profiles.
getSharingProfileDirectory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getSharingProfileDirectory() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a Directory which can be used to view and manipulate sharing profiles and their configurations, but only as allowed by the permissions given to the user.
getSharingProfileForms() - Method in class org.apache.guacamole.protocols.ProtocolInfo
Returns a mutable collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.
getSharingProfileIdentifier() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getSharingProfileIdentifier() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the identifier of the sharing profile being actively used.
getSharingProfileIdentifier() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the identifier of the sharing profile that was used to access the connection associated with this connection record.
getSharingProfileIdentifiers() - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
getSharingProfileIdentifiers() - Method in interface org.apache.guacamole.net.auth.Connection
Returns identifiers of all readable sharing profiles that can be used to join this connection when it is active.
getSharingProfileName() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the name of the sharing profile that was used to access the connection associated with this connection record.
getSharingProfilePermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getSharingProfilePermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all sharing profile permissions given to this user.
getStartDate() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getStartDate() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the date and time the connection began.
getStartDate() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the date and time the connection began.
getSystemPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getSystemPermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all system-level permissions given to this user.
getTitle() - Method in class org.apache.guacamole.form.FieldOption
Returns the human-readable title describing the effect of this option.
getToken(String) - Method in class org.apache.guacamole.token.TokenFilter
Returns the value of the token with the given name, or null if no such token has been set.
getTokens() - Method in class org.apache.guacamole.token.TokenFilter
Returns a map of all tokens, with each key being a token name, and each value being the corresponding token value.
getTranslatableMessage() - Method in interface org.apache.guacamole.language.Translatable
Returns a message which can be translated using a translation service, consisting of a translation key and optional set of substitution variables.
getTunnel() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getTunnel() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the connected GuacamoleTunnel being used.
getTunnel() - Method in class org.apache.guacamole.net.event.TunnelCloseEvent
 
getTunnel() - Method in class org.apache.guacamole.net.event.TunnelConnectEvent
 
getTunnel() - Method in interface org.apache.guacamole.net.event.TunnelEvent
Returns the tunnel associated with this event, if any.
getType() - Method in class org.apache.guacamole.form.Field
Returns the type of this field.
getType() - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
getType() - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Returns the type of this connection.
getType() - Method in class org.apache.guacamole.net.auth.permission.ObjectPermission
 
getType() - Method in interface org.apache.guacamole.net.auth.permission.Permission
Returns the type of operation affected by this permission.
getType() - Method in class org.apache.guacamole.net.auth.permission.SystemPermission
 
getUserAttributes() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getUserAttributes() - Method in interface org.apache.guacamole.net.auth.UserContext
Retrieves a collection of all attributes applicable to users.
getUserContext(AuthenticatedUser) - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns the UserContext of the user authenticated by the given credentials.
getUserContext(AuthenticatedUser) - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
getUserContext() - Method in class org.apache.guacamole.net.event.AuthenticationSuccessEvent
 
getUserContext() - Method in class org.apache.guacamole.net.event.TunnelCloseEvent
 
getUserContext() - Method in class org.apache.guacamole.net.event.TunnelConnectEvent
 
getUserContext() - Method in interface org.apache.guacamole.net.event.UserEvent
Returns the current UserContext of the user triggering the event, if any.
getUserDirectory() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
getUserDirectory() - Method in interface org.apache.guacamole.net.auth.UserContext
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.
getUsername() - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
getUsername() - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Returns the name of the user who is using this connection.
getUsername() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns the name of the user who used or is using the connection at the times given by this connection record.
getUsername() - Method in class org.apache.guacamole.net.auth.Credentials
Returns the username associated with this set of credentials.
getUserPermissions() - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
getUserPermissions() - Method in interface org.apache.guacamole.net.auth.User
Returns all user permissions given to this user.
getValue() - Method in class org.apache.guacamole.form.FieldOption
Returns the value that will be assigned if this option is chosen.
getValue(String) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Returns the value defined by this UserCrendentials object for the field having the given name.
getValue(Field) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Returns the value defined by this UserCrendentials object for the given field.
getValues() - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Returns a map of field names to values which backs this UserCredentials object.
getVariables() - Method in class org.apache.guacamole.language.TranslatableMessage
Returns an arbitrary object whose properties should be substituted for the corresponding placeholders within the string associated with the key.
GuacamoleCredentialsException - Exception in org.apache.guacamole.net.auth.credentials
A security-related exception thrown when access is denied to a user because of a problem related to the provided credentials.
GuacamoleCredentialsException(String, Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given message, cause, and associated credential information.
GuacamoleCredentialsException(String, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given message and associated credential information.
GuacamoleCredentialsException(Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given cause and associated credential information.
GuacamoleHome - Class in org.apache.guacamole.properties
Deprecated. 
GuacamoleInsufficientCredentialsException - Exception in org.apache.guacamole.net.auth.credentials
A security-related exception thrown when access is denied to a user because the provided credentials are not sufficient for authentication to succeed.
GuacamoleInsufficientCredentialsException(String, Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException
Creates a new GuacamoleInsufficientCredentialsException with the given message, cause, and associated credential information.
GuacamoleInsufficientCredentialsException(String, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException
Creates a new GuacamoleInsufficientCredentialsException with the given message and associated credential information.
GuacamoleInsufficientCredentialsException(Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException
Creates a new GuacamoleInsufficientCredentialsException with the given cause and associated credential information.
GuacamoleInvalidCredentialsException - Exception in org.apache.guacamole.net.auth.credentials
A security-related exception thrown when access is denied to a user because the provided credentials are invalid.
GuacamoleInvalidCredentialsException(String, Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given message, cause, and associated credential information.
GuacamoleInvalidCredentialsException(String, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given message and associated credential information.
GuacamoleInvalidCredentialsException(Throwable, CredentialsInfo) - Constructor for exception org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException
Creates a new GuacamoleInvalidCredentialsException with the given cause and associated credential information.
GuacamoleProperties - Class in org.apache.guacamole.properties
Deprecated. 
GuacamoleProperty<Type> - Interface in org.apache.guacamole.properties
An abstract representation of a property in the guacamole.properties file, which parses into a specific type.
GuacamoleProxyConfiguration - Class in org.apache.guacamole.net.auth
Information which describes how the connection to guacd should be established.
GuacamoleProxyConfiguration(String, int, GuacamoleProxyConfiguration.EncryptionMethod) - Constructor for class org.apache.guacamole.net.auth.GuacamoleProxyConfiguration
Creates a new GuacamoleProxyConfiguration having the given hostname, port, and encryption method.
GuacamoleProxyConfiguration(String, int, boolean) - Constructor for class org.apache.guacamole.net.auth.GuacamoleProxyConfiguration
Creates a new GuacamoleProxyConfiguration having the given hostname and port, with encryption method being restricted to either NONE or SSL.
GuacamoleProxyConfiguration.EncryptionMethod - Enum in org.apache.guacamole.net.auth
All possible types of encryption used by guacd.
GUACD_HOSTNAME - Static variable in interface org.apache.guacamole.environment.Environment
The hostname of the server where guacd (the Guacamole proxy server) is running.
GUACD_HOSTNAME - Static variable in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
The hostname of the server where guacd (the Guacamole proxy server) is running.
GUACD_PORT - Static variable in interface org.apache.guacamole.environment.Environment
The port that guacd (the Guacamole proxy server) is listening on.
GUACD_PORT - Static variable in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
The port that guacd (the Guacamole proxy server) is listening on.
GUACD_SSL - Static variable in interface org.apache.guacamole.environment.Environment
Whether guacd requires SSL/TLS on connections.
GUACD_SSL - Static variable in class org.apache.guacamole.properties.GuacamoleProperties
Deprecated.
Whether guacd requires SSL/TLS on connections.

H

hashCode() - Method in class org.apache.guacamole.net.auth.AbstractIdentifiable
 
hashCode() - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
hashCode() - Method in class org.apache.guacamole.net.auth.permission.ObjectPermission
 
hashCode() - Method in class org.apache.guacamole.net.auth.permission.SystemPermission
 
hasPermission(ObjectPermission.Type, String) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
Tests whether the permission of the given type is granted for the object having the given identifier.
hasPermission(SystemPermission.Type) - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
Tests whether the permission of the given type is granted.
hasPermission(ObjectPermission.Type, String) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
hasPermission(SystemPermission.Type) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 

I

Identifiable - Interface in org.apache.guacamole.net.auth
An object which has a deterministic, unique identifier, which may not be null.
init(Attributes) - Method in interface org.apache.guacamole.xml.TagHandler
Called when the element corresponding to this TagHandler is first seen, just after an instance is created.
IntegerGuacamoleProperty - Class in org.apache.guacamole.properties
A GuacamoleProperty whose value is an integer.
IntegerGuacamoleProperty() - Constructor for class org.apache.guacamole.properties.IntegerGuacamoleProperty
 
isActive() - Method in interface org.apache.guacamole.net.auth.ConnectionRecord
Returns whether the connection associated with this record is still active.

L

limit(int) - Method in interface org.apache.guacamole.net.auth.ConnectionRecordSet
Returns the subset of connection history records containing only the first limit records.
limit(int) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionRecordSet
 
LocalEnvironment - Class in org.apache.guacamole.environment
The environment of the locally-running Guacamole instance, describing available protocols, configuration parameters, and the GUACAMOLE_HOME directory.
LocalEnvironment() - Constructor for class org.apache.guacamole.environment.LocalEnvironment
Creates a new Environment, initializing that environment based on the location of GUACAMOLE_HOME and the contents of guacamole.properties.
LongGuacamoleProperty - Class in org.apache.guacamole.properties
A GuacamoleProperty whose value is an long.
LongGuacamoleProperty() - Constructor for class org.apache.guacamole.properties.LongGuacamoleProperty
 

M

MULTILINE - Static variable in class org.apache.guacamole.form.Field.Type
A text field that can span more than one line.
MultilineField - Class in org.apache.guacamole.form
Represents a field which can contain multiple lines of text.
MultilineField(String) - Constructor for class org.apache.guacamole.form.MultilineField
Creates a new MultilineField with the given name.

N

NUMERIC - Static variable in class org.apache.guacamole.form.Field.Type
A numeric field, whose value must contain only digits.
NumericField - Class in org.apache.guacamole.form
Represents a field which may contain only integer values.
NumericField(String) - Constructor for class org.apache.guacamole.form.NumericField
Creates a new NumericField with the given name.

O

ObjectPermission - Class in org.apache.guacamole.net.auth.permission
A permission which affects a specific object, rather than the system as a whole.
ObjectPermission(ObjectPermission.Type, String) - Constructor for class org.apache.guacamole.net.auth.permission.ObjectPermission
Creates a new ObjectPermission having the given type and identifier.
ObjectPermission.Type - Enum in org.apache.guacamole.net.auth.permission
Specific types of object-level permissions.
ObjectPermissionSet - Interface in org.apache.guacamole.net.auth.permission
A set of permissions which affect arbitrary objects, where each object has an associated unique identifier.
org.apache.guacamole.environment - package org.apache.guacamole.environment
 
org.apache.guacamole.form - package org.apache.guacamole.form
Provides classes which describe the contents and semantics of forms which may be presented to the user.
org.apache.guacamole.language - package org.apache.guacamole.language
 
org.apache.guacamole.net.auth - package org.apache.guacamole.net.auth
Provides classes which can be used to extend or replace the authentication functionality of the Guacamole web application.
org.apache.guacamole.net.auth.credentials - package org.apache.guacamole.net.auth.credentials
 
org.apache.guacamole.net.auth.permission - package org.apache.guacamole.net.auth.permission
Provides classes which describe the various permissions a Guacamole user can be granted.
org.apache.guacamole.net.auth.simple - package org.apache.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.apache.guacamole.net.event - package org.apache.guacamole.net.event
Provides classes for storing information about events that are triggered when users log into and use the Guacamole web application.
org.apache.guacamole.net.event.listener - package org.apache.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.apache.guacamole.properties - package org.apache.guacamole.properties
Provides classes for reading properties from the web-application-wide guacamole.properties file.
org.apache.guacamole.protocols - package org.apache.guacamole.protocols
 
org.apache.guacamole.token - package org.apache.guacamole.token
 
org.apache.guacamole.xml - package org.apache.guacamole.xml
Classes driving the SAX-based XML parser used by the Guacamole web application.
ORGANIZATION - Static variable in class org.apache.guacamole.net.auth.User.Attribute
The organization, company, group, etc.
ORGANIZATIONAL_ROLE - Static variable in class org.apache.guacamole.net.auth.User.Attribute
The role that the user has at the organization, company, group, etc.

P

parse(String) - Static method in class org.apache.guacamole.form.DateField
Parses the given string into a corresponding date.
parse(String) - Static method in class org.apache.guacamole.form.NumericField
Parses the given string as an integer, where the given string is in the format required by a numeric field.
parse(String) - Static method in class org.apache.guacamole.form.TextField
Parses the given string, interpreting empty strings as equivalent to null.
parse(String) - Static method in class org.apache.guacamole.form.TimeField
Parses the given string into a corresponding time.
parse(String) - Static method in class org.apache.guacamole.form.TimeZoneField
Parses the given string into a time zone ID string.
parseValue(String) - Method in class org.apache.guacamole.properties.BooleanGuacamoleProperty
 
parseValue(String) - Method in class org.apache.guacamole.properties.FileGuacamoleProperty
 
parseValue(String) - Method in interface org.apache.guacamole.properties.GuacamoleProperty
Parses the given string value into the type associated with this GuacamoleProperty.
parseValue(String) - Method in class org.apache.guacamole.properties.IntegerGuacamoleProperty
 
parseValue(String) - Method in class org.apache.guacamole.properties.LongGuacamoleProperty
 
parseValue(String) - Method in class org.apache.guacamole.properties.StringGuacamoleProperty
 
PASSWORD - Static variable in class org.apache.guacamole.form.Field.Type
A password field, whose value is sensitive and must be hidden.
PASSWORD - Static variable in class org.apache.guacamole.net.auth.credentials.CredentialsInfo
A field describing the password HTTP parameter expected by Guacamole during login, if passwords are being used.
PASSWORD_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the password token added via addStandardTokens().
PasswordField - Class in org.apache.guacamole.form
Represents a field which contains sensitive text information related to authenticating a user.
PasswordField(String) - Constructor for class org.apache.guacamole.form.PasswordField
Creates a new PasswordField with the given name.
Permission<Type extends Enum> - Interface in org.apache.guacamole.net.auth.permission
A permission which affects a specific type of operation, where all available operation types are defined by an enumeration.
PermissionSet<PermissionType extends Permission> - Interface in org.apache.guacamole.net.auth.permission
An arbitrary set of permissions.
ProtocolInfo - Class in org.apache.guacamole.protocols
Describes a protocol and all parameters associated with it, as required by a protocol plugin for guacd.
ProtocolInfo(String, Collection<Form>, Collection<Form>) - Constructor for class org.apache.guacamole.protocols.ProtocolInfo
Creates a new ProtocolInfo having the given name and forms.
ProtocolInfo() - Constructor for class org.apache.guacamole.protocols.ProtocolInfo
Creates a new ProtocolInfo with no associated name or forms.
ProtocolInfo(String) - Constructor for class org.apache.guacamole.protocols.ProtocolInfo
Creates a new ProtocolInfo having the given name, but without any forms.
ProtocolInfo(String, Collection<Form>) - Constructor for class org.apache.guacamole.protocols.ProtocolInfo
Creates a new ProtocolInfo having the given name and forms.
putConnection(Connection) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionDirectory
An internal method for modifying the Connections in this Directory.
putConnectionGroup(ConnectionGroup) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroupDirectory
An internal method for modifying the ConnectionGroups in this Directory.

Q

QUERY_PARAMETER - Static variable in class org.apache.guacamole.form.Field.Type
An HTTP query parameter which is expected to be embedded in the URL given to a user.

R

remove(String) - Method in interface org.apache.guacamole.net.auth.Directory
Removes the object with the given identifier from the overall set.
remove(String) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
removeConnection(String) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionDirectory
An internal method for removing a Connection from this Directory.
removeConnectionGroup(String) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroupDirectory
An internal method for removing a ConnectionGroup from this Directory.
removePermission(ObjectPermission.Type, String) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
Removes the specified permission for the object having the given identifier.
removePermission(SystemPermission.Type) - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
Removes the specified permission.
removePermission(ObjectPermission.Type, String) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
removePermission(SystemPermission.Type) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 
removePermissions(Set<ObjectPermission>) - Method in interface org.apache.guacamole.net.auth.permission.ObjectPermissionSet
 
removePermissions(Set<PermissionType>) - Method in interface org.apache.guacamole.net.auth.permission.PermissionSet
Removes each of the specified permissions, if granted.
removePermissions(Set<SystemPermission>) - Method in interface org.apache.guacamole.net.auth.permission.SystemPermissionSet
 
removePermissions(Set<ObjectPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
 
removePermissions(Set<SystemPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
 
removeValue(String) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Removes (undefines) the value of the field having the given name, returning its previous value.
removeValue(Field) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Removes (undefines) the value of the given field returning its previous value.

S

self() - Method in class org.apache.guacamole.net.auth.simple.SimpleUserContext
 
self() - Method in interface org.apache.guacamole.net.auth.UserContext
Returns the User whose access rights control the operations of this UserContext.
setAttributes(Map<String, String>) - Method in interface org.apache.guacamole.net.auth.Connection
Sets the given attributes.
setAttributes(Map<String, String>) - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Sets the given attributes.
setAttributes(Map<String, String>) - Method in interface org.apache.guacamole.net.auth.SharingProfile
Sets the given attributes.
setAttributes(Map<String, String>) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnection
 
setAttributes(Map<String, String>) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
 
setAttributes(Map<String, String>) - Method in class org.apache.guacamole.net.auth.simple.SimpleUser
 
setAttributes(Map<String, String>) - Method in interface org.apache.guacamole.net.auth.User
Sets the given attributes.
setConfiguration(GuacamoleConfiguration) - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
setConfiguration(GuacamoleConfiguration) - Method in interface org.apache.guacamole.net.auth.Connection
Sets the GuacamoleConfiguration associated with this Connection.
setConnectionForms(Collection<Form>) - Method in class org.apache.guacamole.protocols.ProtocolInfo
Sets the collection of forms describing all known parameters for a connection using this protocol.
setConnectionIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setConnectionIdentifier(String) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the identifier of the connection being actively used.
setFields(Collection<Field>) - Method in class org.apache.guacamole.form.Form
Sets the collection of fields associated with this form.
setIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractIdentifiable
 
setIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
setIdentifier(String) - Method in interface org.apache.guacamole.net.auth.Identifiable
Sets the identifier assigned to this object.
setName(String) - Method in class org.apache.guacamole.form.Field
Sets the unique name associated with this field.
setName(String) - Method in class org.apache.guacamole.form.Form
Sets the name of this form.
setName(String) - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
setName(String) - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
setName(String) - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
setName(String) - Method in interface org.apache.guacamole.net.auth.Connection
Sets the name assigned to this Connection.
setName(String) - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Sets the name assigned to this ConnectionGroup.
setName(String) - Method in interface org.apache.guacamole.net.auth.SharingProfile
Sets the human-readable name assigned to this SharingProfile.
setName(String) - Method in class org.apache.guacamole.protocols.ProtocolInfo
Sets the unique name of this protocol.
setObjects(Map<String, ObjectType>) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
Sets the Map which backs this SimpleDirectory.
setOptions(Collection<String>) - Method in class org.apache.guacamole.form.Field
Sets the options available as possible values of this field.
setParameters(Map<String, String>) - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
setParameters(Map<String, String>) - Method in interface org.apache.guacamole.net.auth.SharingProfile
Replaces all current parameters with the parameters defined within the given map.
setParentIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractConnection
 
setParentIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
setParentIdentifier(String) - Method in interface org.apache.guacamole.net.auth.Connection
Sets the unique identifier of the parent ConnectionGroup for this Connection.
setParentIdentifier(String) - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Sets the unique identifier of the parent ConnectionGroup for this ConnectionGroup.
setPassword(String) - Method in class org.apache.guacamole.net.auth.AbstractUser
 
setPassword(String) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the password associated with this set of credentials.
setPassword(String) - Method in interface org.apache.guacamole.net.auth.User
Sets this user's password.
setPermissions(Set<ObjectPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
Sets the Set which backs this SimpleObjectPermissionSet.
setPermissions(Set<SystemPermission>) - Method in class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
Sets the Set which backs this SimpleSystemPermissionSet.
setPrimaryConnectionIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractSharingProfile
 
setPrimaryConnectionIdentifier(String) - Method in interface org.apache.guacamole.net.auth.SharingProfile
Sets the identifier of the primary connection associated with this connection.
setRemoteAddress(String) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the address of the client end of the connection which provided these credentials.
setRemoteHost(String) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setRemoteHost(String) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the hostname or IP address of the remote host that initiated the connection.
setRemoteHostname(String) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the hostname of the client end of the connection which provided these credentials, if known.
setRequest(HttpServletRequest) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the HttpServletRequest associated with this set of credentials.
setSession(HttpSession) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the HttpSession associated with this set of credentials.
setSharingProfileForms(Collection<Form>) - Method in class org.apache.guacamole.protocols.ProtocolInfo
Sets the collection of forms describing all known parameters relevant to a sharing profile whose primary connection uses this protocol.
setSharingProfileIdentifier(String) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setSharingProfileIdentifier(String) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the identifier of the sharing profile being actively used.
setStartDate(Date) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setStartDate(Date) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the date and time the connection began.
setTitle(String) - Method in class org.apache.guacamole.form.FieldOption
Sets the human-readable title describing the effect of this option.
setToken(String, String) - Method in class org.apache.guacamole.token.TokenFilter
Sets the token having the given name to the given value.
setTokens(Map<String, String>) - Method in class org.apache.guacamole.token.TokenFilter
Replaces all current token values with the contents of the given map, where each map key represents a token name, and each map value represents a token value.
setTunnel(GuacamoleTunnel) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setTunnel(GuacamoleTunnel) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the connected GuacamoleTunnel being used.
setType(String) - Method in class org.apache.guacamole.form.Field
Sets the type of this field.
setType(ConnectionGroup.Type) - Method in class org.apache.guacamole.net.auth.AbstractConnectionGroup
 
setType(ConnectionGroup.Type) - Method in interface org.apache.guacamole.net.auth.ConnectionGroup
Set the type of this ConnectionGroup.
setUsername(String) - Method in class org.apache.guacamole.net.auth.AbstractActiveConnection
 
setUsername(String) - Method in interface org.apache.guacamole.net.auth.ActiveConnection
Sets the name of the user who is using this connection.
setUsername(String) - Method in class org.apache.guacamole.net.auth.Credentials
Sets the username associated with this set of credentials.
setValue(String) - Method in class org.apache.guacamole.form.FieldOption
Sets the value that will be assigned if this option is chosen.
setValue(String, String) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Sets the value of the field having the given name.
setValue(Field, String) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Sets the value of the given field.
setValues(Map<String, String>) - Method in class org.apache.guacamole.net.auth.credentials.UserCredentials
Replaces the map backing this UserCredentials object with the given map.
Shareable<T> - Interface in org.apache.guacamole.net.auth
An object which can be shared with others via specially-generated sets of credentials.
SharingProfile - Interface in org.apache.guacamole.net.auth
Represents the semantics which apply to an existing connection when shared, along with a human-readable name and unique identifier.
SimpleAuthenticationProvider - Class in org.apache.guacamole.net.auth.simple
Provides means of retrieving a set of named GuacamoleConfigurations for a given Credentials object.
SimpleAuthenticationProvider() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
SimpleConnection - Class in org.apache.guacamole.net.auth.simple
An extremely basic Connection implementation.
SimpleConnection() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnection
Creates a completely uninitialized SimpleConnection.
SimpleConnection(String, String, GuacamoleConfiguration) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnection
Creates a new SimpleConnection having the given identifier and GuacamoleConfiguration.
SimpleConnectionDirectory - Class in org.apache.guacamole.net.auth.simple
An extremely simple read-only implementation of a Directory of GuacamoleConfigurations which provides access to a pre-defined Map of GuacamoleConfigurations.
SimpleConnectionDirectory(Collection<Connection>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnectionDirectory
Creates a new SimpleConnectionDirectory which provides access to the connections contained within the given Map.
SimpleConnectionGroup - Class in org.apache.guacamole.net.auth.simple
An extremely simple read-only implementation of a ConnectionGroup which returns the connection and connection group identifiers it was constructed with.
SimpleConnectionGroup(String, String, Collection<String>, Collection<String>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnectionGroup
Creates a new SimpleConnectionGroup having the given name and identifier which will expose the given contents.
SimpleConnectionGroupDirectory - Class in org.apache.guacamole.net.auth.simple
An extremely simple read-only implementation of a Directory of ConnectionGroup which provides which provides access to a pre-defined Collection of ConnectionGroups.
SimpleConnectionGroupDirectory(Collection<ConnectionGroup>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnectionGroupDirectory
Creates a new SimpleConnectionGroupDirectory which contains the given groups.
SimpleConnectionRecordSet - Class in org.apache.guacamole.net.auth.simple
An immutable and empty ConnectionRecordSet.
SimpleConnectionRecordSet() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleConnectionRecordSet
 
SimpleDirectory<ObjectType extends Identifiable> - Class in org.apache.guacamole.net.auth.simple
An extremely simple read-only implementation of a Directory which provides access to a pre-defined Map of arbitrary objects.
SimpleDirectory() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleDirectory
Creates a new empty SimpleDirectory which does not provide access to any objects.
SimpleDirectory(Map<String, ObjectType>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleDirectory
Creates a new SimpleDirectory which provides access to the objects contained within the given Map.
SimpleObjectPermissionSet - Class in org.apache.guacamole.net.auth.simple
A read-only implementation of ObjectPermissionSet which uses a backing Set of Permissions to determine which permissions are present.
SimpleObjectPermissionSet() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
Creates a new empty SimpleObjectPermissionSet.
SimpleObjectPermissionSet(Set<ObjectPermission>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet
Creates a new SimpleObjectPermissionSet which contains the permissions within the given Set.
SimpleSystemPermissionSet - Class in org.apache.guacamole.net.auth.simple
A read-only implementation of SystemPermissionSet which uses a backing Set of Permissions to determine which permissions are present.
SimpleSystemPermissionSet() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
Creates a new empty SimpleSystemPermissionSet.
SimpleSystemPermissionSet(Set<SystemPermission>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleSystemPermissionSet
Creates a new SimpleSystemPermissionSet which contains the permissions within the given Set.
SimpleUser - Class in org.apache.guacamole.net.auth.simple
An extremely basic User implementation.
SimpleUser() - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUser
Creates a completely uninitialized SimpleUser.
SimpleUser(String) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUser
Creates a new SimpleUser having the given username and no permissions.
SimpleUser(String, Collection<String>, Collection<String>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUser
Creates a new SimpleUser having the given username and READ access to the connections and groups having the given identifiers.
SimpleUser(String, Collection<String>, Collection<String>, Collection<String>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUser
Creates a new SimpleUser having the given username and READ access to the users, connections, and groups having the given identifiers.
SimpleUserContext - Class in org.apache.guacamole.net.auth.simple
An extremely simple UserContext implementation which provides access to a defined and restricted set of GuacamoleConfigurations.
SimpleUserContext(AuthenticationProvider, Map<String, GuacamoleConfiguration>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUserContext
Creates a new SimpleUserContext which provides access to only those configurations within the given Map.
SimpleUserContext(AuthenticationProvider, String, Map<String, GuacamoleConfiguration>) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUserContext
Creates a new SimpleUserContext for the user with the given username which provides access to only those configurations within the given Map.
SimpleUserDirectory - Class in org.apache.guacamole.net.auth.simple
An extremely simple read-only implementation of a Directory of Users which provides access to a single pre-defined User.
SimpleUserDirectory(User) - Constructor for class org.apache.guacamole.net.auth.simple.SimpleUserDirectory
Creates a new SimpleUserDirectory which provides access to the single user provided.
sort(ConnectionRecordSet.SortableProperty, boolean) - Method in interface org.apache.guacamole.net.auth.ConnectionRecordSet
Returns a ConnectionRecordSet containing identically the records within this set, sorted according to the specified criteria.
sort(ConnectionRecordSet.SortableProperty, boolean) - Method in class org.apache.guacamole.net.auth.simple.SimpleConnectionRecordSet
 
StandardTokens - Class in org.apache.guacamole.token
Utility class which provides access to standardized token names, as well as facilities for generating those tokens from common objects.
startElement(String, String, String, Attributes) - Method in class org.apache.guacamole.xml.DocumentHandler
 
StringGuacamoleProperty - Class in org.apache.guacamole.properties
A GuacamoleProperty whose value is a simple string.
StringGuacamoleProperty() - Constructor for class org.apache.guacamole.properties.StringGuacamoleProperty
 
SystemPermission - Class in org.apache.guacamole.net.auth.permission
A permission which affects the system as a whole, rather than an individual object.
SystemPermission(SystemPermission.Type) - Constructor for class org.apache.guacamole.net.auth.permission.SystemPermission
Creates a new SystemPermission with the given type.
SystemPermission.Type - Enum in org.apache.guacamole.net.auth.permission
Specific types of system-level permissions.
SystemPermissionSet - Interface in org.apache.guacamole.net.auth.permission
A set of permissions which affects the system as a whole.

T

TagHandler - Interface in org.apache.guacamole.xml
A simple element-level event handler for events triggered by the SAX-driven DocumentHandler parser.
TEXT - Static variable in class org.apache.guacamole.form.Field.Type
A text field, accepting arbitrary values.
TextField - Class in org.apache.guacamole.form
Represents a basic text field.
TextField(String) - Constructor for class org.apache.guacamole.form.TextField
Creates a new TextField with the given name.
TIME - Static variable in class org.apache.guacamole.form.Field.Type
A time field whose legal values conform to the pattern "HH:MM:SS", zero-padded, 24-hour.
TIME_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the time token (server-local time) added via addStandardTokens().
TimeField - Class in org.apache.guacamole.form
Represents a time field.
TimeField(String) - Constructor for class org.apache.guacamole.form.TimeField
Creates a new TimeField with the given name.
TIMEZONE - Static variable in class org.apache.guacamole.form.Field.Type
A time zone field whose legal values are only valid time zone IDs, as dictated by Java within TimeZone.getAvailableIDs().
TimeZoneField - Class in org.apache.guacamole.form
Represents a time zone field.
TimeZoneField(String) - Constructor for class org.apache.guacamole.form.TimeZoneField
Creates a new TimeZoneField with the given name.
TokenFilter - Class in org.apache.guacamole.token
Filtering object which replaces tokens of the form "${TOKEN_NAME}" with their corresponding values.
TokenFilter() - Constructor for class org.apache.guacamole.token.TokenFilter
 
Translatable - Interface in org.apache.guacamole.language
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.
TranslatableMessage - Class in org.apache.guacamole.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.
TranslatableMessage(String) - Constructor for class org.apache.guacamole.language.TranslatableMessage
Creates a new TranslatableMessage associated with the given translation key, without any associated variables.
TranslatableMessage(String, Object) - Constructor for class org.apache.guacamole.language.TranslatableMessage
Creates a new TranslatableMessage associated with the given translation key and associated variables.
tunnelClosed(TunnelCloseEvent) - Method in interface org.apache.guacamole.net.event.listener.TunnelCloseListener
Event hook which fires immediately after an existing tunnel is closed.
TunnelCloseEvent - Class in org.apache.guacamole.net.event
An event which is triggered whenever a tunnel is being closed.
TunnelCloseEvent(UserContext, Credentials, GuacamoleTunnel) - Constructor for class org.apache.guacamole.net.event.TunnelCloseEvent
Creates a new TunnelCloseEvent which represents the closing of the given tunnel via a request associated with the given credentials.
TunnelCloseListener - Interface in org.apache.guacamole.net.event.listener
A listener whose tunnelClosed() hook will fire immediately after an existing tunnel is closed.
tunnelConnected(TunnelConnectEvent) - Method in interface org.apache.guacamole.net.event.listener.TunnelConnectListener
Event hook which fires immediately after a new tunnel is connected.
TunnelConnectEvent - Class in org.apache.guacamole.net.event
An event which is triggered whenever a tunnel is being connected.
TunnelConnectEvent(UserContext, Credentials, GuacamoleTunnel) - Constructor for class org.apache.guacamole.net.event.TunnelConnectEvent
Creates a new TunnelConnectEvent which represents the connecting of the given tunnel via a request associated with the given credentials.
TunnelConnectListener - Interface in org.apache.guacamole.net.event.listener
A listener whose tunnelConnected() hook will fire immediately after a new tunnel is connected.
TunnelEvent - Interface in org.apache.guacamole.net.event
Abstract basis for events associated with tunnels.
Type() - Constructor for class org.apache.guacamole.form.Field.Type
 

U

unsetToken(String) - Method in class org.apache.guacamole.token.TokenFilter
Removes the value of the token with the given name.
update(ObjectType) - Method in interface org.apache.guacamole.net.auth.Directory
Updates the stored object with the data contained in the given object.
update(ObjectType) - Method in class org.apache.guacamole.net.auth.simple.SimpleDirectory
 
updateAuthenticatedUser(AuthenticatedUser, Credentials) - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns a new or updated AuthenticatedUser for the given credentials already having produced the given AuthenticatedUser.
updateAuthenticatedUser(AuthenticatedUser, Credentials) - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
updateUserContext(UserContext, AuthenticatedUser, Credentials) - Method in interface org.apache.guacamole.net.auth.AuthenticationProvider
Returns a new or updated UserContext for the given AuthenticatedUser already having the given UserContext.
updateUserContext(UserContext, AuthenticatedUser, Credentials) - Method in class org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider
 
User - Interface in org.apache.guacamole.net.auth
A user of the Guacamole web application.
User.Attribute - Class in org.apache.guacamole.net.auth
All standard attribute names with semantics defined by the Guacamole web application.
UserContext - Interface in org.apache.guacamole.net.auth
The context of an active user.
UserCredentials - Class in org.apache.guacamole.net.auth.credentials
A fully-valid set of credentials and associated values.
UserCredentials(Collection<Field>, Map<String, String>) - Constructor for class org.apache.guacamole.net.auth.credentials.UserCredentials
Creates a new UserCredentials object which requires the given fields and values.
UserCredentials(CredentialsInfo, Map<String, String>) - Constructor for class org.apache.guacamole.net.auth.credentials.UserCredentials
Creates a new UserCredentials object which requires fields described by the given CredentialsInfo.
UserCredentials(CredentialsInfo) - Constructor for class org.apache.guacamole.net.auth.credentials.UserCredentials
Creates a new UserCredentials object which requires fields described by the given CredentialsInfo but does not yet have any defined values.
UserCredentials(Collection<Field>) - Constructor for class org.apache.guacamole.net.auth.credentials.UserCredentials
Creates a new UserCredentials object which requires the given fields but does not yet have any defined values.
UserEvent - Interface in org.apache.guacamole.net.event
Abstract basis for events which may have an associated UserContext when triggered.
USERNAME - Static variable in class org.apache.guacamole.form.Field.Type
A username field.
USERNAME - Static variable in class org.apache.guacamole.net.auth.credentials.CredentialsInfo
A field describing the username HTTP parameter expected by Guacamole during login, if usernames are being used.
USERNAME_PASSWORD - Static variable in class org.apache.guacamole.net.auth.credentials.CredentialsInfo
CredentialsInfo object which describes standard username/password credentials.
USERNAME_TOKEN - Static variable in class org.apache.guacamole.token.StandardTokens
The name of the username token added via addStandardTokens().
UsernameField - Class in org.apache.guacamole.form
Represents a text field which will contain the uniquely-identifying name of a user.
UsernameField(String) - Constructor for class org.apache.guacamole.form.UsernameField
Creates a new UsernameField with the given name.

V

valueOf(String) - Static method in enum org.apache.guacamole.net.auth.ConnectionGroup.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.guacamole.net.auth.ConnectionRecordSet.SortableProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.guacamole.net.auth.GuacamoleProxyConfiguration.EncryptionMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.guacamole.net.auth.permission.ObjectPermission.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.guacamole.net.auth.permission.SystemPermission.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.guacamole.net.auth.ConnectionGroup.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.guacamole.net.auth.ConnectionRecordSet.SortableProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.guacamole.net.auth.GuacamoleProxyConfiguration.EncryptionMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.guacamole.net.auth.permission.ObjectPermission.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.guacamole.net.auth.permission.SystemPermission.Type
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I L M N O P Q R S T U V 
Skip navigation links

Copyright © 2017. All rights reserved.