- 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.
- 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.
- 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
-
- 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
-
- 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.
- 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.
- 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.
- 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.