public class ConnectionRESTService extends Object
Constructor and Description |
---|
ConnectionRESTService() |
Modifier and Type | Method and Description |
---|---|
String |
createConnection(String authToken,
String authProviderIdentifier,
APIConnection connection)
Creates a new connection and returns the identifier of the new
connection.
|
void |
deleteConnection(String authToken,
String authProviderIdentifier,
String connectionID)
Deletes an individual connection.
|
APIConnection |
getConnection(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves an individual connection.
|
List<APIConnectionRecord> |
getConnectionHistory(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves the usage history of a single connection.
|
Map<String,String> |
getConnectionParameters(String authToken,
String authProviderIdentifier,
String connectionID)
Retrieves the parameters associated with a single connection.
|
void |
updateConnection(String authToken,
String authProviderIdentifier,
String connectionID,
APIConnection connection)
Updates an existing connection.
|
public APIConnection getConnection(String authToken, String authProviderIdentifier, String connectionID) 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 to be retrieved.connectionID
- The identifier of the connection to retrieve.GuacamoleException
- If an error occurs while retrieving the connection.public Map<String,String> getConnectionParameters(String authToken, String authProviderIdentifier, String connectionID) 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 whose parameters are to be
retrieved.connectionID
- The identifier of the connection.GuacamoleException
- If an error occurs while retrieving the connection parameters.public List<APIConnectionRecord> getConnectionHistory(String authToken, String authProviderIdentifier, String connectionID) 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 whose history is to be
retrieved.connectionID
- The identifier of the connection.GuacamoleException
- If an error occurs while retrieving the connection history.public void deleteConnection(String authToken, String authProviderIdentifier, String connectionID) 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 to be deleted.connectionID
- The identifier of the connection to delete.GuacamoleException
- If an error occurs while deleting the connection.public String createConnection(String authToken, String authProviderIdentifier, APIConnection connection) 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 is to be created.connection
- The connection to create.GuacamoleException
- If an error occurs while creating the connection.public void updateConnection(String authToken, String authProviderIdentifier, String connectionID, APIConnection connection) 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 to be updated.connectionID
- The identifier of the connection to update.connection
- The connection data to update the specified connection with.GuacamoleException
- If an error occurs while updating the connection.Copyright © 2015. All rights reserved.