org.glyptodon.guacamole.net.basic.rest.activeconnection

Class ActiveConnectionRESTService

java.lang.Object

org.glyptodon.guacamole.net.basic.rest.activeconnection.ActiveConnectionRESTService

public class ActiveConnectionRESTService
extends Object

A REST Service for retrieving and managing the tunnels of active connections.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
ActiveConnectionRESTService()

Method Summary

Modifier and Type	Method and Description
Map<String,APIActiveConnection>	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	patchTunnels(String authToken, String authProviderIdentifier, List<APIPatch<String>> patches) Applies the given active connection patches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActiveConnectionRESTService

public ActiveConnectionRESTService()

Method Detail

getActiveConnections

public Map<String,APIActiveConnection> getActiveConnections(String authToken,
                                                            String authProviderIdentifier,
                                                            List<ObjectPermission.Type> permissions)
                                                     throws GuacamoleException

Gets a list of active connections in the system, filtering the returned list by the given permissions, if specified.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext containing the active connections to be retrieved.

permissions - The set of permissions to filter with. A user must have one or more of these permissions for a user to appear in the result. If null, no filtering will be performed.

Returns:

A list of all active connections. If a permission was specified, this list will contain only those active connections for which the current user has that permission.

Throws:

GuacamoleException - If an error is encountered while retrieving active connections.

patchTunnels

public void patchTunnels(String authToken,
                         String authProviderIdentifier,
                         List<APIPatch<String>> patches)
                  throws GuacamoleException

Applies the given active connection patches. This operation currently only supports deletion of active connections through the "remove" patch operation. Deleting an active connection effectively kills the connection. The path of each patch operation is of the form "/ID" where ID is the identifier of the active connection being modified.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext containing the active connections to be deleted.

patches - The active connection patches to apply for this request.

Throws:

GuacamoleException - If an error occurs while deleting the active connections.