Package | Description |
---|---|
net.sourceforge.guacamole.net.auth.noauth | |
net.sourceforge.guacamole.net.basic | |
org.glyptodon.guacamole |
All classes which apply generally across the Guacamole web application
and all other web applications which use the API provided by the
Guacamole project.
|
org.glyptodon.guacamole.environment | |
org.glyptodon.guacamole.io |
All classes relating directly to data input or output.
|
org.glyptodon.guacamole.net |
Classes which apply to network-specific concepts, such as low-level sockets
and tunnels.
|
org.glyptodon.guacamole.net.auth |
Provides classes which can be used to extend or replace the authentication
functionality of the Guacamole web application.
|
org.glyptodon.guacamole.net.auth.credentials | |
org.glyptodon.guacamole.net.auth.permission |
Provides classes which describe the various permissions a Guacamole user
can be granted.
|
org.glyptodon.guacamole.net.auth.simple |
Provides a basic AuthenticationProvider base class that can be used to create
simple AuthenticationProviders in the same way allowed by the old
authentication API.
|
org.glyptodon.guacamole.net.basic |
Classes specific to the general-purpose web application implemented by
the Guacamole project using the Guacamole APIs.
|
org.glyptodon.guacamole.net.basic.extension |
Classes which represent and facilitate the loading of extensions to the
Guacamole web application.
|
org.glyptodon.guacamole.net.basic.properties |
Classes related to the properties which the Guacamole web application
(and stock parts of it) read from guacamole.properties.
|
org.glyptodon.guacamole.net.basic.rest |
Classes related to the basic Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.rest.activeconnection | |
org.glyptodon.guacamole.net.basic.rest.auth |
Classes related to the authentication aspect of the Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.rest.connection |
Classes related to the connection manipulation aspect of the Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.rest.connectiongroup |
Classes related to the connection group manipulation aspect
of the Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.rest.permission |
Classes related to the permission manipulation aspect of the Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.rest.schema |
Classes related to the self-description of the Guacamole REST API, such as
the attributes or parameters applicable to specific objects.
|
org.glyptodon.guacamole.net.basic.rest.user |
Classes related to the user manipulation aspect of the Guacamole REST API.
|
org.glyptodon.guacamole.net.basic.websocket |
Standard WebSocket tunnel implementation.
|
org.glyptodon.guacamole.net.basic.websocket.jetty8 |
Jetty 8 WebSocket tunnel implementation.
|
org.glyptodon.guacamole.net.event.listener |
Provides classes for hooking into various events that take place as
users log into and use the Guacamole web application.
|
org.glyptodon.guacamole.properties |
Provides classes for reading properties from the web-application-wide
guacamole.properties file.
|
org.glyptodon.guacamole.protocol |
Classes relating directly to the Guacamole protocol.
|
org.glyptodon.guacamole.servlet |
Classes which build upon the Java Servlet API, providing an HTTP-based
tunnel and session management.
|
org.glyptodon.guacamole.websocket |
Modifier and Type | Method and Description |
---|---|
Map<String,GuacamoleConfiguration> |
NoAuthenticationProvider.getAuthorizedConfigurations(Credentials credentials) |
void |
NoAuthenticationProvider.init() |
Constructor and Description |
---|
NoAuthenticationProvider()
Creates a new NoAuthenticationProvider that does not perform any
authentication at all.
|
Modifier and Type | Method and Description |
---|---|
Map<String,GuacamoleConfiguration> |
BasicFileAuthenticationProvider.getAuthorizedConfigurations(Credentials credentials) |
Constructor and Description |
---|
BasicFileAuthenticationProvider()
Creates a new BasicFileAuthenticationProvider that authenticates users
against simple, monolithic XML file.
|
Modifier and Type | Class and Description |
---|---|
class |
GuacamoleClientBadTypeException
An exception which is thrown when data has been submitted with an unsupported
mimetype.
|
class |
GuacamoleClientException
A generic exception thrown when part of the Guacamole API encounters
an error in the client's request.
|
class |
GuacamoleClientOverrunException
An exception which is thrown when the client has sent too much data.
|
class |
GuacamoleClientTimeoutException
An exception which is thrown when the client is taking too long to respond.
|
class |
GuacamoleClientTooManyException
An exception which is thrown when too many requests have been received
by the current client, and further requests are being rejected, either
temporarily or permanently.
|
class |
GuacamoleConnectionClosedException
An exception which is thrown when an operation cannot be performed because
its corresponding connection is closed.
|
class |
GuacamoleResourceConflictException
An exception which is thrown when a resource has been requested, but that
resource is locked or currently in use, and cannot be accessed by the
current user.
|
class |
GuacamoleResourceNotFoundException
A generic exception thrown when part of the Guacamole API fails to find
a requested resource, such as a configuration or tunnel.
|
class |
GuacamoleSecurityException
A security-related exception thrown when parts of the Guacamole API is
denying access to a resource.
|
class |
GuacamoleServerBusyException
An exception which is thrown when the server is too busy to service the
request.
|
class |
GuacamoleServerException
A generic exception thrown when part of the Guacamole API encounters
an unexpected, internal error.
|
class |
GuacamoleUnauthorizedException
A security-related exception thrown when parts of the Guacamole API is
denying access to a resource, but access MAY be granted were the user
authorized (logged in).
|
class |
GuacamoleUnsupportedException
An exception which is thrown when the requested operation is unsupported
or unimplemented.
|
class |
GuacamoleUpstreamException
An exception which indicates than an upstream server (such as the remote
desktop) is returning an error or is otherwise unreachable.
|
class |
GuacamoleUpstreamTimeoutException
An exception which indicates than an upstream server (such as the remote
desktop) is taking too long to respond.
|
Modifier and Type | Method and Description |
---|---|
<Type> Type |
LocalEnvironment.getProperty(GuacamoleProperty<Type> property) |
<Type> Type |
Environment.getProperty(GuacamoleProperty<Type> property)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
<Type> Type |
LocalEnvironment.getProperty(GuacamoleProperty<Type> property,
Type defaultValue) |
<Type> Type |
Environment.getProperty(GuacamoleProperty<Type> property,
Type defaultValue)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
<Type> Type |
LocalEnvironment.getRequiredProperty(GuacamoleProperty<Type> property) |
<Type> Type |
Environment.getRequiredProperty(GuacamoleProperty<Type> property)
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties.
|
Constructor and Description |
---|
LocalEnvironment()
Creates a new Environment, initializing that environment based on the
location of GUACAMOLE_HOME and the contents of guacamole.properties.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ReaderGuacamoleReader.available() |
boolean |
GuacamoleReader.available()
Returns whether instruction data is available for reading.
|
char[] |
ReaderGuacamoleReader.read() |
char[] |
GuacamoleReader.read()
Reads at least one complete Guacamole instruction, returning a buffer
containing one or more complete Guacamole instructions and no
incomplete Guacamole instructions.
|
GuacamoleInstruction |
ReaderGuacamoleReader.readInstruction() |
GuacamoleInstruction |
GuacamoleReader.readInstruction()
Reads exactly one complete Guacamole instruction and returns the fully
parsed instruction.
|
void |
WriterGuacamoleWriter.write(char[] chunk) |
void |
GuacamoleWriter.write(char[] chunk)
Writes the entire given array of characters to the Guacamole instruction
stream.
|
void |
WriterGuacamoleWriter.write(char[] chunk,
int off,
int len) |
void |
GuacamoleWriter.write(char[] chunk,
int off,
int len)
Writes a portion of the given array of characters to the Guacamole
instruction stream.
|
void |
WriterGuacamoleWriter.writeInstruction(GuacamoleInstruction instruction) |
void |
GuacamoleWriter.writeInstruction(GuacamoleInstruction instruction)
Writes the given fully parsed instruction to the Guacamole instruction
stream.
|
Modifier and Type | Method and Description |
---|---|
void |
InetGuacamoleSocket.close() |
void |
DelegatingGuacamoleTunnel.close() |
void |
AbstractGuacamoleTunnel.close() |
void |
SSLGuacamoleSocket.close() |
void |
GuacamoleTunnel.close()
Release all resources allocated to this GuacamoleTunnel.
|
void |
GuacamoleSocket.close()
Releases all resources in use by the connection represented by this
GuacamoleSocket.
|
Constructor and Description |
---|
InetGuacamoleSocket(String hostname,
int port)
Creates a new InetGuacamoleSocket which reads and writes instructions
to the Guacamole instruction stream of the Guacamole proxy server
running at the given hostname and port.
|
SSLGuacamoleSocket(String hostname,
int port)
Creates a new SSLGuacamoleSocket which reads and writes instructions
to the Guacamole instruction stream of the Guacamole proxy server
running at the given hostname and port using SSL.
|
Modifier and Type | Method and Description |
---|---|
void |
Directory.add(ObjectType object)
Adds the given object to the overall set.
|
AuthenticatedUser |
AuthenticationProvider.authenticateUser(Credentials credentials)
Returns an AuthenticatedUser representing the user authenticated by the
given credentials, if any.
|
GuacamoleTunnel |
Connectable.connect(GuacamoleClientInformation info)
Establishes a connection to guacd using the information associated with
this object.
|
ObjectType |
Directory.get(String identifier)
Returns the object having the given identifier.
|
Directory<ActiveConnection> |
UserContext.getActiveConnectionDirectory()
Retrieves a Directory which can be used to view and manipulate
active connections, but only as allowed by the permissions given to the
user.
|
ObjectPermissionSet |
User.getActiveConnectionPermissions()
Returns all permissions given to this user regarding currently-active
connections.
|
Collection<ObjectType> |
Directory.getAll(Collection<String> identifiers)
Returns the objects having the given identifiers.
|
Directory<Connection> |
UserContext.getConnectionDirectory()
Retrieves a Directory which can be used to view and manipulate
connections and their configurations, but only as allowed by the
permissions given to the user.
|
Directory<ConnectionGroup> |
UserContext.getConnectionGroupDirectory()
Retrieves a Directory which can be used to view and manipulate
connection groups and their members, but only as allowed by the
permissions given to the user.
|
Set<String> |
ConnectionGroup.getConnectionGroupIdentifiers()
Returns the identifiers of all readable connection groups that are
children of this connection group.
|
ObjectPermissionSet |
User.getConnectionGroupPermissions()
Returns all connection group permissions given to this user.
|
Set<String> |
ConnectionGroup.getConnectionIdentifiers()
Returns the identifiers of all readable connections that are children
of this connection group.
|
ObjectPermissionSet |
User.getConnectionPermissions()
Returns all connection permissions given to this user.
|
List<? extends ConnectionRecord> |
Connection.getHistory()
Returns a list of ConnectionRecords representing the usage history
of this Connection, including any active users.
|
Set<String> |
Directory.getIdentifiers()
Returns a Set containing all identifiers for all objects within this
Directory.
|
ConnectionGroup |
UserContext.getRootConnectionGroup()
Retrieves a connection group which can be used to view and manipulate
connections, but only as allowed by the permissions given to the user of
this UserContext.
|
SystemPermissionSet |
User.getSystemPermissions()
Returns all system-level permissions given to this user.
|
UserContext |
AuthenticationProvider.getUserContext(AuthenticatedUser authenticatedUser)
Returns the UserContext of the user authenticated by the given
credentials.
|
Directory<User> |
UserContext.getUserDirectory()
Retrieves a Directory which can be used to view and manipulate other
users, but only as allowed by the permissions given to the user of this
UserContext.
|
ObjectPermissionSet |
User.getUserPermissions()
Returns all user permissions given to this user.
|
void |
Directory.remove(String identifier)
Removes the object with the given identifier from the overall set.
|
void |
Directory.update(ObjectType object)
Updates the stored object with the data contained in the given object.
|
AuthenticatedUser |
AuthenticationProvider.updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
Credentials credentials)
Returns a new or updated AuthenticatedUser for the given credentials
already having produced the given AuthenticatedUser.
|
UserContext |
AuthenticationProvider.updateUserContext(UserContext context,
AuthenticatedUser authenticatedUser)
Returns a new or updated UserContext for the given AuthenticatedUser
already having the given UserContext.
|
Modifier and Type | Class and Description |
---|---|
class |
GuacamoleCredentialsException
A security-related exception thrown when access is denied to a user because
of a problem related to the provided credentials.
|
class |
GuacamoleInsufficientCredentialsException
A security-related exception thrown when access is denied to a user because
the provided credentials are not sufficient for authentication to succeed.
|
class |
GuacamoleInvalidCredentialsException
A security-related exception thrown when access is denied to a user because
the provided credentials are invalid.
|
Modifier and Type | Method and Description |
---|---|
void |
ObjectPermissionSet.addPermission(ObjectPermission.Type permission,
String identifier)
Adds the specified permission for the object having the given
identifier.
|
void |
SystemPermissionSet.addPermission(SystemPermission.Type permission)
Adds the specified permission.
|
void |
ObjectPermissionSet.addPermissions(Set<ObjectPermission> permissions) |
void |
PermissionSet.addPermissions(Set<PermissionType> permissions)
Adds the specified permissions, if not already granted.
|
void |
SystemPermissionSet.addPermissions(Set<SystemPermission> permissions) |
Collection<String> |
ObjectPermissionSet.getAccessibleObjects(Collection<ObjectPermission.Type> permissions,
Collection<String> identifiers)
Tests whether this user has the specified permissions for the objects
having the given identifiers.
|
Set<ObjectPermission> |
ObjectPermissionSet.getPermissions() |
Set<SystemPermission> |
SystemPermissionSet.getPermissions() |
Set<PermissionType> |
PermissionSet.getPermissions()
Returns a Set which contains all permissions granted within this
permission set.
|
boolean |
ObjectPermissionSet.hasPermission(ObjectPermission.Type permission,
String identifier)
Tests whether the permission of the given type is granted for the
object having the given identifier.
|
boolean |
SystemPermissionSet.hasPermission(SystemPermission.Type permission)
Tests whether the permission of the given type is granted.
|
void |
ObjectPermissionSet.removePermission(ObjectPermission.Type permission,
String identifier)
Removes the specified permission for the object having the given
identifier.
|
void |
SystemPermissionSet.removePermission(SystemPermission.Type permission)
Removes the specified permission.
|
void |
ObjectPermissionSet.removePermissions(Set<ObjectPermission> permissions) |
void |
PermissionSet.removePermissions(Set<PermissionType> permissions)
Removes each of the specified permissions, if granted.
|
void |
SystemPermissionSet.removePermissions(Set<SystemPermission> permissions) |
Modifier and Type | Method and Description |
---|---|
void |
SimpleDirectory.add(ObjectType connection) |
void |
SimpleObjectPermissionSet.addPermission(ObjectPermission.Type permission,
String identifier) |
void |
SimpleSystemPermissionSet.addPermission(SystemPermission.Type permission) |
void |
SimpleObjectPermissionSet.addPermissions(Set<ObjectPermission> permissions) |
void |
SimpleSystemPermissionSet.addPermissions(Set<SystemPermission> permissions) |
AuthenticatedUser |
SimpleAuthenticationProvider.authenticateUser(Credentials credentials) |
GuacamoleTunnel |
SimpleConnectionGroup.connect(GuacamoleClientInformation info) |
GuacamoleTunnel |
SimpleConnection.connect(GuacamoleClientInformation info) |
ObjectType |
SimpleDirectory.get(String identifier) |
Collection<String> |
SimpleObjectPermissionSet.getAccessibleObjects(Collection<ObjectPermission.Type> permissionTypes,
Collection<String> identifiers) |
Directory<ActiveConnection> |
SimpleUserContext.getActiveConnectionDirectory() |
ObjectPermissionSet |
SimpleUser.getActiveConnectionPermissions() |
Collection<ObjectType> |
SimpleDirectory.getAll(Collection<String> identifiers) |
abstract Map<String,GuacamoleConfiguration> |
SimpleAuthenticationProvider.getAuthorizedConfigurations(Credentials credentials)
Given an arbitrary credentials object, returns a Map containing all
configurations authorized by those credentials.
|
Directory<Connection> |
SimpleUserContext.getConnectionDirectory() |
Directory<ConnectionGroup> |
SimpleUserContext.getConnectionGroupDirectory() |
ObjectPermissionSet |
SimpleUser.getConnectionGroupPermissions() |
ObjectPermissionSet |
SimpleUser.getConnectionPermissions() |
List<ConnectionRecord> |
SimpleConnection.getHistory() |
Set<String> |
SimpleDirectory.getIdentifiers() |
ConnectionGroup |
SimpleUserContext.getRootConnectionGroup() |
SystemPermissionSet |
SimpleUser.getSystemPermissions() |
UserContext |
SimpleAuthenticationProvider.getUserContext(AuthenticatedUser authenticatedUser) |
Directory<User> |
SimpleUserContext.getUserDirectory() |
ObjectPermissionSet |
SimpleUser.getUserPermissions() |
boolean |
SimpleObjectPermissionSet.hasPermission(ObjectPermission.Type permission,
String identifier) |
boolean |
SimpleSystemPermissionSet.hasPermission(SystemPermission.Type permission) |
void |
SimpleDirectory.remove(String identifier) |
void |
SimpleObjectPermissionSet.removePermission(ObjectPermission.Type permission,
String identifier) |
void |
SimpleSystemPermissionSet.removePermission(SystemPermission.Type permission) |
void |
SimpleObjectPermissionSet.removePermissions(Set<ObjectPermission> permissions) |
void |
SimpleSystemPermissionSet.removePermissions(Set<SystemPermission> permissions) |
void |
SimpleDirectory.update(ObjectType connection) |
AuthenticatedUser |
SimpleAuthenticationProvider.updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
Credentials credentials) |
UserContext |
SimpleAuthenticationProvider.updateUserContext(UserContext context,
AuthenticatedUser authorizedUser) |
Modifier and Type | Method and Description |
---|---|
protected GuacamoleTunnel |
TunnelRequestService.createAssociatedTunnel(GuacamoleSession session,
GuacamoleTunnel tunnel,
TunnelRequest.Type type,
String id)
Associates the given tunnel with the given session, returning a wrapped
version of the same tunnel which automatically handles closure and
removal from the session.
|
protected GuacamoleTunnel |
TunnelRequestService.createConnectedTunnel(UserContext context,
TunnelRequest.Type type,
String id,
GuacamoleClientInformation info)
Creates a new tunnel using which is connected to the connection or
connection group identifier by the given ID.
|
GuacamoleTunnel |
TunnelRequestService.createTunnel(TunnelRequest request)
Creates a new tunnel using the parameters and credentials present in
the given request.
|
protected GuacamoleTunnel |
BasicGuacamoleTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request) |
String |
TunnelRequest.getAuthenticationProviderIdentifier()
Returns the identifier of the AuthenticationProvider associated with the
UserContext from which the connection or connection group is to be
retrieved when the tunnel is created.
|
protected GuacamoleClientInformation |
TunnelRequestService.getClientInformation(TunnelRequest request)
Reads and returns the client information provided within the given
request.
|
Integer |
TunnelRequest.getDPI()
Returns the display resolution desired for the Guacamole session over
the tunnel being requested, in DPI.
|
Integer |
TunnelRequest.getHeight()
Returns the display height desired for the Guacamole session over the
tunnel being requested.
|
String |
TunnelRequest.getIdentifier()
Returns the identifier of the destination of the tunnel being requested.
|
static GuacamoleClassLoader |
GuacamoleClassLoader.getInstance()
Deprecated.
Returns an instance of a GuacamoleClassLoader which finds classes
within the directory configured in guacamole.properties.
|
Integer |
TunnelRequest.getIntegerParameter(String name)
Returns the integer value of the parameter having the given name,
throwing an exception if the parameter cannot be parsed.
|
String |
TunnelRequest.getRequiredParameter(String name)
Returns the value of the parameter having the given name, throwing an
exception if the parameter is missing.
|
TunnelRequest.Type |
TunnelRequest.getType()
Returns the type of object for which the tunnel is being requested.
|
Integer |
TunnelRequest.getWidth()
Returns the display width desired for the Guacamole session over the
tunnel being requested.
|
Constructor and Description |
---|
GuacamoleSession(Environment environment,
AuthenticatedUser authenticatedUser,
List<UserContext> userContexts)
Creates a new Guacamole session associated with the given
AuthenticatedUser and UserContexts.
|
Modifier and Type | Method and Description |
---|---|
AuthenticatedUser |
AuthenticationProviderFacade.authenticateUser(Credentials credentials) |
static DirectoryClassLoader |
DirectoryClassLoader.getInstance(File dir)
Returns an instance of DirectoryClassLoader configured to load .jar
files from the given directory.
|
UserContext |
AuthenticationProviderFacade.getUserContext(AuthenticatedUser authenticatedUser) |
AuthenticatedUser |
AuthenticationProviderFacade.updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
Credentials credentials) |
UserContext |
AuthenticationProviderFacade.updateUserContext(UserContext context,
AuthenticatedUser authenticatedUser) |
Constructor and Description |
---|
Extension(ClassLoader parent,
File file)
Loads the given file as an extension, which must be a .jar containing
a guac-manifest.json file describing its contents.
|
Modifier and Type | Method and Description |
---|---|
Class<AuthenticationProvider> |
AuthenticationProviderProperty.parseValue(String authProviderClassName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Connection |
ObjectRetrievalService.retrieveConnection(GuacamoleSession session,
String authProviderIdentifier,
String identifier)
Retrieves a single connection from the given GuacamoleSession.
|
Connection |
ObjectRetrievalService.retrieveConnection(UserContext userContext,
String identifier)
Retrieves a single connection from the given user context.
|
ConnectionGroup |
ObjectRetrievalService.retrieveConnectionGroup(GuacamoleSession session,
String authProviderIdentifier,
String identifier)
Retrieves a single connection group from the given GuacamoleSession.
|
ConnectionGroup |
ObjectRetrievalService.retrieveConnectionGroup(UserContext userContext,
String identifier)
Retrieves a single connection group from the given user context.
|
User |
ObjectRetrievalService.retrieveUser(GuacamoleSession session,
String authProviderIdentifier,
String identifier)
Retrieves a single user from the given GuacamoleSession.
|
User |
ObjectRetrievalService.retrieveUser(UserContext userContext,
String identifier)
Retrieves a single user from the given user context.
|
UserContext |
ObjectRetrievalService.retrieveUserContext(GuacamoleSession session,
String authProviderIdentifier)
Retrieves a single UserContext from the given GuacamoleSession, which
may contain multiple UserContexts.
|
Modifier and Type | Method and Description |
---|---|
Map<String,APIActiveConnection> |
ActiveConnectionRESTService.getActiveConnections(String authToken,
String authProviderIdentifier,
List<ObjectPermission.Type> permissions)
Gets a list of active connections in the system, filtering the returned
list by the given permissions, if specified.
|
void |
ActiveConnectionRESTService.patchTunnels(String authToken,
String authProviderIdentifier,
List<APIPatch<String>> patches)
Applies the given active connection patches.
|
Modifier and Type | Method and Description |
---|---|
APIAuthenticationResult |
TokenRESTService.createToken(String username,
String password,
String token,
javax.servlet.http.HttpServletRequest consumedRequest,
javax.ws.rs.core.MultivaluedMap<String,String> parameters)
Authenticates a user, generates an auth token, associates that auth token
with the user's UserContext for use by further requests.
|
GuacamoleSession |
AuthenticationService.getGuacamoleSession(String authToken)
Finds the Guacamole session for a given auth token, if the auth token
represents a currently logged in user.
|
List<UserContext> |
AuthenticationService.getUserContexts(String authToken)
Returns all UserContexts associated with a given auth token, if the auth
token represents a currently logged in user.
|
Modifier and Type | Method and Description |
---|---|
GuacamoleTunnel |
APIConnectionWrapper.connect(GuacamoleClientInformation info) |
String |
ConnectionRESTService.createConnection(String authToken,
String authProviderIdentifier,
APIConnection connection)
Creates a new connection and returns the identifier of the new
connection.
|
void |
ConnectionRESTService.deleteConnection(String authToken,
String authProviderIdentifier,
String connectionID)
Deletes an individual connection.
|
APIConnection |
ConnectionRESTService.getConnection(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves an individual connection.
|
List<APIConnectionRecord> |
ConnectionRESTService.getConnectionHistory(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves the usage history of a single connection.
|
Map<String,String> |
ConnectionRESTService.getConnectionParameters(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves the parameters associated with a single connection.
|
List<? extends ConnectionRecord> |
APIConnectionWrapper.getHistory() |
void |
ConnectionRESTService.updateConnection(String authToken,
String authProviderIdentifier,
String connectionID,
APIConnection connection)
Updates an existing connection.
|
Constructor and Description |
---|
APIConnection(Connection connection)
Create an APIConnection from a Connection record.
|
Modifier and Type | Method and Description |
---|---|
GuacamoleTunnel |
APIConnectionGroupWrapper.connect(GuacamoleClientInformation info) |
String |
ConnectionGroupRESTService.createConnectionGroup(String authToken,
String authProviderIdentifier,
APIConnectionGroup connectionGroup)
Creates a new connection group and returns the identifier of the new connection group.
|
void |
ConnectionGroupRESTService.deleteConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID)
Deletes an individual connection group.
|
APIConnectionGroup |
ConnectionGroupRESTService.getConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID)
Gets an individual connection group.
|
APIConnectionGroup |
ConnectionGroupRESTService.getConnectionGroupTree(String authToken,
String authProviderIdentifier,
String connectionGroupID,
List<ObjectPermission.Type> permissions)
Gets an individual connection group and all children.
|
void |
ConnectionGroupRESTService.updateConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID,
APIConnectionGroup connectionGroup)
Updates a connection group.
|
Constructor and Description |
---|
ConnectionGroupTree(UserContext userContext,
ConnectionGroup root,
List<ObjectPermission.Type> permissions)
Creates a new connection group tree using the given connection group as
the tree root.
|
Constructor and Description |
---|
APIPermissionSet(User user)
Creates a new permission set containing all permissions currently
granted to the given user.
|
Modifier and Type | Method and Description |
---|---|
Collection<Form> |
SchemaRESTService.getConnectionAttributes(String authToken,
String authProviderIdentifier)
Retrieves the possible attributes of a connection object.
|
Collection<Form> |
SchemaRESTService.getConnectionGroupAttributes(String authToken,
String authProviderIdentifier)
Retrieves the possible attributes of a connection group object.
|
Map<String,ProtocolInfo> |
SchemaRESTService.getProtocols(String authToken,
String authProviderIdentifier)
Gets a map of protocols defined in the system - protocol name to protocol.
|
Collection<Form> |
SchemaRESTService.getUserAttributes(String authToken,
String authProviderIdentifier)
Retrieves the possible attributes of a user object.
|
Modifier and Type | Method and Description |
---|---|
void |
PermissionSetPatch.apply(PermissionSet<PermissionType> permissionSet)
Applies all queued changes to the given permission set.
|
String |
UserRESTService.createUser(String authToken,
String authProviderIdentifier,
APIUser user)
Creates a new user and returns the username.
|
void |
UserRESTService.deleteUser(String authToken,
String authProviderIdentifier,
String username)
Deletes an individual existing user.
|
ObjectPermissionSet |
APIUserWrapper.getActiveConnectionPermissions() |
ObjectPermissionSet |
APIUserWrapper.getConnectionGroupPermissions() |
ObjectPermissionSet |
APIUserWrapper.getConnectionPermissions() |
APIPermissionSet |
UserRESTService.getPermissions(String authToken,
String authProviderIdentifier,
String username)
Gets a list of permissions for the user with the given username.
|
SystemPermissionSet |
APIUserWrapper.getSystemPermissions() |
APIUser |
UserRESTService.getUser(String authToken,
String authProviderIdentifier,
String username)
Retrieves an individual user.
|
ObjectPermissionSet |
APIUserWrapper.getUserPermissions() |
List<APIUser> |
UserRESTService.getUsers(String authToken,
String authProviderIdentifier,
List<ObjectPermission.Type> permissions)
Gets a list of users in the given data source (UserContext), filtering
the returned list by the given permission, if specified.
|
void |
UserRESTService.patchPermissions(String authToken,
String authProviderIdentifier,
String username,
List<APIPatch<String>> patches)
Applies a given list of permission patches.
|
void |
UserRESTService.updatePassword(String authToken,
String authProviderIdentifier,
String username,
APIUserPasswordUpdate userPasswordUpdate,
javax.servlet.http.HttpServletRequest request)
Updates the password for an individual existing user.
|
void |
UserRESTService.updateUser(String authToken,
String authProviderIdentifier,
String username,
APIUser user)
Updates an individual existing user.
|
Modifier and Type | Method and Description |
---|---|
protected GuacamoleTunnel |
BasicGuacamoleWebSocketTunnelEndpoint.createTunnel(javax.websocket.Session session,
javax.websocket.EndpointConfig config) |
Modifier and Type | Method and Description |
---|---|
protected GuacamoleTunnel |
BasicGuacamoleWebSocketTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request) |
protected abstract GuacamoleTunnel |
GuacamoleWebSocketTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request)
Called whenever the JavaScript Guacamole client makes a connection
request.
|
Modifier and Type | Method and Description |
---|---|
void |
AuthenticationFailureListener.authenticationFailed(AuthenticationFailureEvent e)
Event hook which fires immediately after a user's authentication attempt
fails.
|
boolean |
AuthenticationSuccessListener.authenticationSucceeded(AuthenticationSuccessEvent e)
Event hook which fires immediately after a user's authentication attempt
succeeds.
|
boolean |
TunnelCloseListener.tunnelClosed(TunnelCloseEvent e)
Event hook which fires immediately after an existing tunnel is closed.
|
boolean |
TunnelConnectListener.tunnelConnected(TunnelConnectEvent e)
Event hook which fires immediately after a new tunnel is connected.
|
Modifier and Type | Method and Description |
---|---|
static <Type> Type |
GuacamoleProperties.getProperty(GuacamoleProperty<Type> property)
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
static <Type> Type |
GuacamoleProperties.getProperty(GuacamoleProperty<Type> property,
Type defaultValue)
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties, if any.
|
static <Type> Type |
GuacamoleProperties.getRequiredProperty(GuacamoleProperty<Type> property)
Deprecated.
Given a GuacamoleProperty, parses and returns the value set for that
property in guacamole.properties.
|
File |
FileGuacamoleProperty.parseValue(String value) |
Boolean |
BooleanGuacamoleProperty.parseValue(String value) |
String |
StringGuacamoleProperty.parseValue(String value) |
Integer |
IntegerGuacamoleProperty.parseValue(String value) |
Type |
GuacamoleProperty.parseValue(String value)
Parses the given string value into the type associated with this
GuacamoleProperty.
|
Long |
LongGuacamoleProperty.parseValue(String value) |
Modifier and Type | Method and Description |
---|---|
int |
GuacamoleParser.append(char[] chunk)
Appends data from the given buffer to the current instruction.
|
int |
GuacamoleParser.append(char[] chunk,
int offset,
int length)
Appends data from the given buffer to the current instruction.
|
boolean |
FilteredGuacamoleReader.available() |
void |
ConfiguredGuacamoleSocket.close() |
void |
FilteredGuacamoleSocket.close() |
GuacamoleInstruction |
GuacamoleFilter.filter(GuacamoleInstruction instruction)
Applies the filter to the given instruction, returning the original
instruction, a modified version of the original, or null, depending
on the implementation.
|
char[] |
FilteredGuacamoleReader.read() |
GuacamoleInstruction |
FilteredGuacamoleReader.readInstruction() |
void |
FilteredGuacamoleWriter.write(char[] chunk) |
void |
FilteredGuacamoleWriter.write(char[] chunk,
int offset,
int length) |
void |
FilteredGuacamoleWriter.writeInstruction(GuacamoleInstruction instruction) |
Constructor and Description |
---|
ConfiguredGuacamoleSocket(GuacamoleSocket socket,
GuacamoleConfiguration config)
Creates a new ConfiguredGuacamoleSocket which uses the given
GuacamoleConfiguration to complete the initial protocol handshake over
the given GuacamoleSocket.
|
ConfiguredGuacamoleSocket(GuacamoleSocket socket,
GuacamoleConfiguration config,
GuacamoleClientInformation info)
Creates a new ConfiguredGuacamoleSocket which uses the given
GuacamoleConfiguration and GuacamoleClientInformation to complete the
initial protocol handshake over the given GuacamoleSocket.
|
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleHTTPTunnelServlet.doConnect(javax.servlet.http.HttpServletRequest request)
Called whenever the JavaScript Guacamole client makes a connection
request.
|
protected void |
GuacamoleHTTPTunnelServlet.doRead(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String tunnelUUID)
Called whenever the JavaScript Guacamole client makes a read request.
|
protected void |
GuacamoleHTTPTunnelServlet.doWrite(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String tunnelUUID)
Called whenever the JavaScript Guacamole client makes a write request.
|
Constructor and Description |
---|
GuacamoleSession(javax.servlet.http.HttpSession session)
Creates a new GuacamoleSession, storing and retrieving tunnels from the
given HttpSession.
|
Modifier and Type | Method and Description |
---|---|
protected abstract GuacamoleTunnel |
GuacamoleWebSocketTunnelEndpoint.createTunnel(javax.websocket.Session session,
javax.websocket.EndpointConfig config)
Returns a new tunnel for the given session.
|
Copyright © 2016. All rights reserved.