com.embotics.vlm.rest.v30.client

Class VCommanderClient

java.lang.Object

com.embotics.vlm.rest.v30.client.VCommanderClient

public class VCommanderClient
extends Object

vCommander REST API Java client - connecting to REST API V3 Only methods relevant for the plugin are implemented Authentication is based on basic-auth

Author:

btarczali

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VCommanderClient() Used for Unit Testing
	VCommanderClient(String uri, String userName, String password, String orgName)

Method Summary

Modifier and Type	Method and Description
void	close() Done with the rest client and clean-up
String	getClientInfo()
Long	getPublishedService(String serviceName) ServiceRequestsClient.getPublishedService(String)
String	getPublishedServiceNameByPayload(String payload) ServiceRequestsClient.getPublishedServiceNameByPayload(String)
String	getSecurityToken() SessionsClient.getSecurityToken()
String	getServiceRequestPayload(Long serviceID) ServiceRequestsClient.getServiceRequestPayload(Long)
Long	getWorkflowDefinition(String workflowName) WorkflowsClient.getWorkflowDefinition(String)
String	getWorkflowDefinitionTargetType(Long workflowDefinitionId) WorkflowsClient.getWorkflowDefinitionTargetType(Long)
Long	requestService(String payload) ServiceRequestsClient.requestService(String)
String	runCommandWorkflow(Long workflowId, String targetType, String targetName) WorkflowsClient.runCommandWorkflow(Long, String, String)
List<DeployedComponentInfo>	waitForServiceRequestToBeCompleted(Long requestId, long timeout, long polling, PrintStream logger) ServiceRequestsClient.waitForServiceRequestToBeCompleted(Long, long, long, PrintStream)
Long	waitForWorkflowToBeCompleted(String taskId, long timeout, long polling, PrintStream logger) WorkflowsClient.waitForWorkflowToBeCompleted(String, long, long, PrintStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

VCommanderClient

public VCommanderClient(String uri,
                        String userName,
                        String password,
                        String orgName)

VCommanderClient

protected VCommanderClient()

Used for Unit Testing

Method Detail

close

public void close()

Done with the rest client and clean-up

getClientInfo

public String getClientInfo()

Returns:

A formatted string containing the configured vCommander address and user name

getSecurityToken

public String getSecurityToken()
                        throws org.codehaus.jettison.json.JSONException,
                               VCommanderException

SessionsClient.getSecurityToken()

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

getPublishedService

public Long getPublishedService(String serviceName)
                         throws org.codehaus.jettison.json.JSONException,
                                VCommanderException

ServiceRequestsClient.getPublishedService(String)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

getPublishedServiceNameByPayload

public String getPublishedServiceNameByPayload(String payload)
                                        throws org.codehaus.jettison.json.JSONException,
                                               VCommanderException

ServiceRequestsClient.getPublishedServiceNameByPayload(String)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

getServiceRequestPayload

public String getServiceRequestPayload(Long serviceID)
                                throws org.codehaus.jettison.json.JSONException,
                                       VCommanderException

ServiceRequestsClient.getServiceRequestPayload(Long)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

requestService

public Long requestService(String payload)
                    throws org.codehaus.jettison.json.JSONException,
                           VCommanderException

ServiceRequestsClient.requestService(String)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

waitForServiceRequestToBeCompleted

public List<DeployedComponentInfo> waitForServiceRequestToBeCompleted(Long requestId,
                                                                      long timeout,
                                                                      long polling,
                                                                      PrintStream logger)
                                                               throws org.codehaus.jettison.json.JSONException,
                                                                      InterruptedException,
                                                                      VCommanderException

ServiceRequestsClient.waitForServiceRequestToBeCompleted(Long, long, long, PrintStream)

Throws:

org.codehaus.jettison.json.JSONException

InterruptedException

VCommanderException

getWorkflowDefinition

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

WorkflowsClient.getWorkflowDefinition(String)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

getWorkflowDefinitionTargetType

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

WorkflowsClient.getWorkflowDefinitionTargetType(Long)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

runCommandWorkflow

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

WorkflowsClient.runCommandWorkflow(Long, String, String)

Throws:

org.codehaus.jettison.json.JSONException

VCommanderException

waitForWorkflowToBeCompleted

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

WorkflowsClient.waitForWorkflowToBeCompleted(String, long, long, PrintStream)

Throws:

org.codehaus.jettison.json.JSONException

InterruptedException

VCommanderException