org.overlord.dtgov.taskclient

Class TaskApiClient

java.lang.Object

org.overlord.dtgov.taskclient.TaskApiClient

public class TaskApiClient
extends Object

Class used to communicate with the S-RAMP server via the S-RAMP Atom API.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
TaskApiClient(String endpoint) Constructor.
TaskApiClient(String endpoint, AuthenticationProvider authenticationProvider) Constructor.
TaskApiClient(String endpoint, String username, String password) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TaskType	claimTask(String taskId) Claims a task and returns the latest (updated) task instance.
TaskType	completeTask(String taskId, Map<String,String> taskData) Completes a task and returns the latest (updated) task instance.
protected ClientRequest	createClientRequest(String atomUrl) Creates the RESTEasy client request object, configured appropriately.
TaskType	failTask(String taskId, Map<String,String> taskData) Fails a task and returns the latest (updated) task instance.
FindTasksResponse	findTasks(FindTasksRequest findTasksRequest) Finds a list of tasks based on criteria provided in FindTasksRequest.
String	getEndpoint()
TaskType	getTask(String taskId) Gets a task by its unique id.
TaskType	releaseTask(String taskId) Releases a task and returns the latest (updated) task instance.
TaskType	startTask(String taskId) Starts a task and returns the latest (updated) task instance.
TaskType	stopTask(String taskId) Stops a task and returns the latest (updated) task instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskApiClient

public TaskApiClient(String endpoint)

Constructor.

Parameters:

endpoint -

TaskApiClient

public TaskApiClient(String endpoint,
             String username,
             String password)
              throws TaskApiClientException

Constructor.

Parameters:

endpoint -

username -

password -

Throws:

TaskApiClientException

SrampAtomException

TaskApiClient

public TaskApiClient(String endpoint,
             AuthenticationProvider authenticationProvider)
              throws TaskApiClientException

Constructor.

Parameters:

endpoint -

authenticationProvider -

Throws:

TaskApiClientException

SrampAtomException

Method Detail

getEndpoint

public String getEndpoint()

Returns:

the s-ramp endpoint

findTasks

public FindTasksResponse findTasks(FindTasksRequest findTasksRequest)
                            throws TaskApiClientException

Finds a list of tasks based on criteria provided in FindTasksRequest.

Parameters:

findTasksRequest -

Throws:

TaskApiClientException

getTask

public TaskType getTask(String taskId)
                 throws TaskApiClientException

Gets a task by its unique id.

Throws:

TaskApiClientException

SrampAtomException

claimTask

public TaskType claimTask(String taskId)
                   throws TaskApiClientException

Claims a task and returns the latest (updated) task instance.

Parameters:

taskId -

Throws:

TaskApiClientException

releaseTask

public TaskType releaseTask(String taskId)
                     throws TaskApiClientException

Releases a task and returns the latest (updated) task instance.

Parameters:

taskid -

Throws:

TaskApiClientException

startTask

public TaskType startTask(String taskId)
                   throws TaskApiClientException

Starts a task and returns the latest (updated) task instance.

Parameters:

taskid -

Throws:

TaskApiClientException

stopTask

public TaskType stopTask(String taskId)
                  throws TaskApiClientException

Stops a task and returns the latest (updated) task instance.

Parameters:

taskid -

Throws:

TaskApiClientException

completeTask

public TaskType completeTask(String taskId,
                    Map<String,String> taskData)
                      throws TaskApiClientException

Completes a task and returns the latest (updated) task instance.

Parameters:

taskid -

Throws:

TaskApiClientException

failTask

public TaskType failTask(String taskId,
                Map<String,String> taskData)
                  throws TaskApiClientException

Fails a task and returns the latest (updated) task instance.

Parameters:

taskid -

Throws:

TaskApiClientException

createClientRequest

protected ClientRequest createClientRequest(String atomUrl)

Creates the RESTEasy client request object, configured appropriately.

Parameters:

atomUrl -