com.embotics.vlm.rest.v30.client

Class WorkflowsClient

java.lang.Object

com.embotics.vlm.rest.v30.client.WorkflowsClient

public class WorkflowsClient
extends Object

vCommander REST API Java client - for workflows

Author:

btarczali

Constructor Summary

Constructors

Constructor and Description
WorkflowsClient(com.sun.jersey.api.client.WebResource webResource)

Method Summary

Modifier and Type	Method and Description
Long	getWorkflowDefinition(String workflowName) Retrieve the command workflow definition with the given name.
String	getWorkflowDefinitionTargetType(Long workflowDefinitionId) Retrieve the command workflow target type for the specified workflow definition ID.
String	runCommandWorkflow(Long workflowId, String targetType, String targetName) Run a Command Workflow in vCommander.
Long	waitForWorkflowToBeCompleted(String taskId, long timeout, long polling, PrintStream logger) Waits until the workflow is completed or failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowsClient

public WorkflowsClient(com.sun.jersey.api.client.WebResource webResource)

Method Detail

getWorkflowDefinition

public Long getWorkflowDefinition(String workflowName)
                           throws org.codehaus.jettison.json.JSONException,
                                  VCommanderException

Retrieve the command workflow definition with the given name. If the command workflow definition is not found exception will occur.

Parameters:

workflowName - The name of the workflow definition

Returns:

workflowDefinitionID

Throws:

org.codehaus.jettison.json.JSONException - If there is a syntax error

VCommanderException - If something goes wrong

getWorkflowDefinitionTargetType

public String getWorkflowDefinitionTargetType(Long workflowDefinitionId)
                                       throws org.codehaus.jettison.json.JSONException,
                                              VCommanderException

Retrieve the command workflow target type for the specified workflow definition ID. If the command workflow definition is not found exception will occur.

Parameters:

workflowDefinitionId - The ID of the workflow definition

Returns:

targetType

Throws:

org.codehaus.jettison.json.JSONException - If there is a syntax error

VCommanderException - If something goes wrong

runCommandWorkflow

public String runCommandWorkflow(Long workflowId,
                                 String targetType,
                                 String targetName)
                          throws org.codehaus.jettison.json.JSONException,
                                 VCommanderException

Run a Command Workflow in vCommander. This call will create a task in vCommander, which will be scheduled based on the queue. A task ID is returned, and user should query the task for updates.

Parameters:

workflowId - The ID of the workflow definition

targetType - The type of the target

targetName - The name of the target

Returns:

String Task ID

Throws:

org.codehaus.jettison.json.JSONException - If there is a syntax error

VCommanderException - If something goes wrong

waitForWorkflowToBeCompleted

public Long waitForWorkflowToBeCompleted(String taskId,
                                         long timeout,
                                         long polling,
                                         PrintStream logger)
                                  throws org.codehaus.jettison.json.JSONException,
                                         InterruptedException,
                                         VCommanderException

Waits until the workflow is completed or failed. If the workflow will not finish in the given timeout, an exception will be thrown When logger is not null, lookup messages will be printed

Parameters:

taskId - The response received when the workflow was submitted

timeout - Timeout in minutes

polling - Polling interval in seconds

logger - A PrintStream, used for logging

Returns:

The workflow ID

Throws:

org.codehaus.jettison.json.JSONException - If there is a syntax error

InterruptedException - If the wait is interrupted

VCommanderException - If something goes wrong