public class ConnectionGroupRESTService extends Object
Constructor and Description |
---|
ConnectionGroupRESTService() |
Modifier and Type | Method and Description |
---|---|
String |
createConnectionGroup(String authToken,
String authProviderIdentifier,
APIConnectionGroup connectionGroup)
Creates a new connection group and returns the identifier of the new connection group.
|
void |
deleteConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID)
Deletes an individual connection group.
|
APIConnectionGroup |
getConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID)
Gets an individual connection group.
|
APIConnectionGroup |
getConnectionGroupTree(String authToken,
String authProviderIdentifier,
String connectionGroupID,
List<ObjectPermission.Type> permissions)
Gets an individual connection group and all children.
|
void |
updateConnectionGroup(String authToken,
String authProviderIdentifier,
String connectionGroupID,
APIConnectionGroup connectionGroup)
Updates a connection group.
|
public APIConnectionGroup getConnectionGroup(String authToken, String authProviderIdentifier, String connectionGroupID) throws GuacamoleException
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 connection group to be retrieved.connectionGroupID
- The ID of the connection group to retrieve.GuacamoleException
- If a problem is encountered while retrieving the connection group.public APIConnectionGroup getConnectionGroupTree(String authToken, String authProviderIdentifier, String connectionGroupID, List<ObjectPermission.Type> permissions) throws GuacamoleException
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 connection group to be retrieved.connectionGroupID
- The ID of the connection group to retrieve.permissions
- If specified and non-empty, limit the returned list to only those
connections for which the current user has any of the given
permissions. Otherwise, all visible connections are returned.
Connection groups are unaffected by this parameter.GuacamoleException
- If a problem is encountered while retrieving the connection group or
its descendants.public void deleteConnectionGroup(String authToken, String authProviderIdentifier, String connectionGroupID) throws GuacamoleException
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 connection group to be deleted.connectionGroupID
- The identifier of the connection group to delete.GuacamoleException
- If an error occurs while deleting the connection group.public String createConnectionGroup(String authToken, String authProviderIdentifier, APIConnectionGroup connectionGroup) throws GuacamoleException
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 in which the connection group is to be created.connectionGroup
- The connection group to create.GuacamoleException
- If an error occurs while creating the connection group.public void updateConnectionGroup(String authToken, String authProviderIdentifier, String connectionGroupID, APIConnectionGroup connectionGroup) throws GuacamoleException
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 connection group to be updated.connectionGroupID
- The identifier of the existing connection group to update.connectionGroup
- The data to update the existing connection group with.GuacamoleException
- If an error occurs while updating the connection group.Copyright © 2015. All rights reserved.