uk.ac.gate.cloud.online

Class OnlineApiManager

java.lang.Object

uk.ac.gate.cloud.online.OnlineApiManager

public class OnlineApiManager
extends Object

Main entry point for the online processing API.

Author:

Ian Roberts

Constructor Summary

Constructors

Constructor and Description
OnlineApiManager(RestClient client) Construct a JobManager using the given RestClient to communicate with the API.
OnlineApiManager(String apiKeyId, String apiPassword) Construct a JobManager accessing the GATE Cloud public API with the given credentials.

Method Summary

Modifier and Type	Method and Description
ApiEndpoint	getEndpoint(String endpointUrl) Create an endpoint object that can call the given REST API URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnlineApiManager

public OnlineApiManager(RestClient client)

Construct a JobManager using the given RestClient to communicate with the API.

Parameters:

client - the client object used for communication

OnlineApiManager

public OnlineApiManager(String apiKeyId,
                        String apiPassword)

Construct a JobManager accessing the GATE Cloud public API with the given credentials.

Parameters:

apiKeyId - API key ID for authentication

apiPassword - corresponding password

Method Detail

getEndpoint

public ApiEndpoint getEndpoint(String endpointUrl)

Create an endpoint object that can call the given REST API URL.

Parameters:

endpointUrl - the endpoint URL