com.embotics.vlm.rest.v30.client

Class ServiceRequestsClient

java.lang.Object

com.embotics.vlm.rest.v30.client.ServiceRequestsClient

public class ServiceRequestsClient
extends Object

vCommander REST API Java client - for service requests

Author:

btarczali

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Long	getPublishedService(String serviceName) Retrieve the Published service with the given name.
String	getPublishedServiceNameByPayload(String payload) Retrieve the Published service name for the given payload
String	getServiceRequestPayload(Long serviceID) Retrieve the form required for a published service
Long	requestService(String payload) Request a new Service Request from vCommander passing in the payload.
List<DeployedComponentInfo>	waitForServiceRequestToBeCompleted(Long requestId, long timeout, long polling, PrintStream logger) Waits until the service request is successfully deployed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceRequestsClient

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

Method Detail

getPublishedService

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

Retrieve the Published service with the given name. If service not found or if multiple are found with the same name, exception will occur.

Parameters:

serviceName - The name of the published service

Returns:

publishedServiceID

Throws:

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

VCommanderException - If something goes wrong

getPublishedServiceNameByPayload

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

Retrieve the Published service name for the given payload

Parameters:

payload - The service request payload

Returns:

publishedServiceName

Throws:

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

VCommanderException - If something goes wrong

getServiceRequestPayload

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

Retrieve the form required for a published service

Parameters:

serviceID - The published service ID

Returns:

The service request form in JSON format

Throws:

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

VCommanderException - If something goes wrong

requestService

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

Request a new Service Request from vCommander passing in the payload. The payload must contain the "service_id" element.

Parameters:

payload - The service request payload

Returns:

serviceRequestID

Throws:

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

VCommanderException - If something goes wrong

waitForServiceRequestToBeCompleted

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

Waits until the service request is successfully deployed. If an error occurs or if the request is rejected, an exception will be thrown. If the request will not finish in the given timeout, an exception will be thrown. When logger is not null, lookup messages will be printed.

Parameters:

requestId - The service request id

timeout - Timeout in minutes

polling - Polling interval in seconds

logger - A PrintStream, used for logging

Returns:

Information about the deployed components

Throws:

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

InterruptedException - If the wait is interrupted

VCommanderException - If something goes wrong