org.apache.brooklyn.rest.client

Class BrooklynApiUtil

java.lang.Object

org.apache.brooklyn.rest.client.BrooklynApiUtil

public class BrooklynApiUtil
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	attemptStop(BrooklynApi api, java.lang.String application, Duration timeout) Use the effector API to invoke the stop effector on the given application.
static TaskSummary	deployBlueprint(BrooklynApi api, java.lang.String blueprint) Deploys the blueprint and returns the task summary.
static java.lang.String	getTaskResult(BrooklynApi api, java.lang.String taskId)
static boolean	isUnhealthyResponse(javax.ws.rs.core.Response response)
static Status	waitForAppStatus(BrooklynApi api, java.lang.String application, Status desiredStatus, Duration timeout, Duration pollPeriod) Polls Brooklyn until the given application has the given status.
static void	waitForRunningAndThrowOtherwise(BrooklynApi api, java.lang.String applicationId, java.lang.String taskId) Waits for the application with the given ID to be running.
static void	waitForRunningAndThrowOtherwise(BrooklynApi api, java.lang.String applicationId, java.lang.String taskId, Duration timeout) Waits for the application with the given ID to be running.

Methods inherited from class java.lang.Object

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

Method Detail

deployBlueprint

public static TaskSummary deployBlueprint(BrooklynApi api,
                                          java.lang.String blueprint)
                                   throws java.lang.Exception

Deploys the blueprint and returns the task summary.

Throws:

java.lang.Exception - If the response from the server when deploying was unhealthy.

waitForRunningAndThrowOtherwise

public static void waitForRunningAndThrowOtherwise(BrooklynApi api,
                                                   java.lang.String applicationId,
                                                   java.lang.String taskId)
                                            throws java.lang.IllegalStateException

Waits for the application with the given ID to be running.

Throws:

java.lang.IllegalStateException - If the application was not running after DEFAULT_TIMEOUT.

waitForRunningAndThrowOtherwise

public static void waitForRunningAndThrowOtherwise(BrooklynApi api,
                                                   java.lang.String applicationId,
                                                   java.lang.String taskId,
                                                   Duration timeout)
                                            throws java.lang.IllegalStateException

Waits for the application with the given ID to be running.

Throws:

java.lang.IllegalStateException - If the application was not running after the given timeout.

waitForAppStatus

public static Status waitForAppStatus(BrooklynApi api,
                                      java.lang.String application,
                                      Status desiredStatus,
                                      Duration timeout,
                                      Duration pollPeriod)

Polls Brooklyn until the given application has the given status. Quits early if the application's status is Status.ERROR or Status.UNKNOWN and desiredStatus is something else.

Returns:

The final polled status.

attemptStop

public static void attemptStop(BrooklynApi api,
                               java.lang.String application,
                               Duration timeout)

Use the effector API to invoke the stop effector on the given application.

getTaskResult

public static java.lang.String getTaskResult(BrooklynApi api,
                                             java.lang.String taskId)

Returns:

The result of the task with the given id, or "unknown" if it could not be found.

isUnhealthyResponse

public static boolean isUnhealthyResponse(javax.ws.rs.core.Response response)

Returns:

true if response's status code is not between 200 and 299 inclusive.