com.vmware.vcloud.api.rest.client

Interface TaskMonitor

All Known Subinterfaces:

VcdTaskMonitor

All Known Implementing Classes:

TaskMonitorImpl, VcdTaskMonitorImpl

public interface TaskMonitor

Monitors tasks for success or failure returned by post and put methods in JaxRsClient.

Method Summary

Modifier and Type	Method and Description
com.vmware.vcloud.api.rest.schema_v1_5.TaskType	waitForStatus(String taskHref, long timeoutInMillis, long pollFrequency, TaskStatus failOnStatus, TaskStatus... expectedTargetStatus) Waits for task to reach expected status.
com.vmware.vcloud.api.rest.schema_v1_5.TaskType	waitForStatus(com.vmware.vcloud.api.rest.schema_v1_5.TaskType task, long timeoutInMillis, long pollFrequency, TaskStatus failOnStatus, TaskStatus... expectedTargetStatus) Waits for task to reach expected status.
com.vmware.vcloud.api.rest.schema_v1_5.TaskType	waitForSuccess(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entity, long timeoutInMillis) Convenience wrapper over waitForSuccess(TaskType, long) that waits on the task that's associated with the specified EntityType.
com.vmware.vcloud.api.rest.schema_v1_5.TaskType	waitForSuccess(String taskHref, long timeoutInMillis) Waits for task to complete.
com.vmware.vcloud.api.rest.schema_v1_5.TaskType	waitForSuccess(com.vmware.vcloud.api.rest.schema_v1_5.TaskType task, long timeoutInMillis) Waits for task to complete.

Method Detail

waitForSuccess

com.vmware.vcloud.api.rest.schema_v1_5.TaskType waitForSuccess(com.vmware.vcloud.api.rest.schema_v1_5.TaskType task,
                                                               long timeoutInMillis)
                                                        throws VcdTaskException,
                                                               TimeoutException

Waits for task to complete.

Parameters:

task - task returned by post or put calls.

timeoutInMillis - time (in milliseconds) to wait for task to finish

Returns:

The completed successful task

Throws:

VcdTaskException - exception will be thrown when task completes with an error.

TimeoutException - exception thrown when task is not finished within given time.

waitForSuccess

com.vmware.vcloud.api.rest.schema_v1_5.TaskType waitForSuccess(String taskHref,
                                                               long timeoutInMillis)
                                                        throws VcdTaskException,
                                                               TimeoutException

Waits for task to complete.

Parameters:

taskHref - href of the task returned via post or put calls.

timeoutInMillis - time (in milliseconds) to wait for task to finish

Returns:

The completed successful task

Throws:

VcdTaskException - exception will be thrown when task completes with an error.

TimeoutException - exception thrown when task is not finished within given time.

waitForStatus

com.vmware.vcloud.api.rest.schema_v1_5.TaskType waitForStatus(com.vmware.vcloud.api.rest.schema_v1_5.TaskType task,
                                                              long timeoutInMillis,
                                                              long pollFrequency,
                                                              TaskStatus failOnStatus,
                                                              TaskStatus... expectedTargetStatus)
                                                       throws TimeoutException

Waits for task to reach expected status.

Parameters:

task - task returned by post or put calls.

timeoutInMillis - time (in milliseconds) to wait for task to finish.

pollFrequency - time (in milliseconds) with which task will be polled.

failOnStatus - task will fail if this TaskStatus is reached. If this parameter is null then either task will achieve expected target status or throw TimeOutException.

expectedTargetStatus - list of expected alternative target status.

Returns:

TaskType from list of expected target status.

Throws:

TimeoutException - exception thrown when task is not finished within given time.

waitForStatus

com.vmware.vcloud.api.rest.schema_v1_5.TaskType waitForStatus(String taskHref,
                                                              long timeoutInMillis,
                                                              long pollFrequency,
                                                              TaskStatus failOnStatus,
                                                              TaskStatus... expectedTargetStatus)
                                                       throws TimeoutException

Waits for task to reach expected status.

Parameters:

taskHref - href of the task returned via post or put calls.

timeoutInMillis - time (in milliseconds) to wait for task to finish.

pollFrequency - time (in milliseconds) with which task will be polled.

failOnStatus - task will fail if this TaskStatus is reached. If this parameter is null then either task will achieve expected target status or throw TimeOutException.

expectedTargetStatus - list of expected alternative target status.

Returns:

TaskType from list of expected target status.

Throws:

TimeoutException - exception thrown when task is not finished within given time.

waitForSuccess

com.vmware.vcloud.api.rest.schema_v1_5.TaskType waitForSuccess(com.vmware.vcloud.api.rest.schema_v1_5.EntityType entity,
                                                               long timeoutInMillis)
                                                        throws TimeoutException

Convenience wrapper over waitForSuccess(TaskType, long) that waits on the task that's associated with the specified EntityType.

Parameters:

entity - the entity whose task we want to wait on

timeoutInMillis - time (in milliseconds) to wait for task to finish

Returns:

The completed successful task

Throws:

VcdTaskException - exception will be thrown when task completes with an error.

TimeoutException - exception thrown when task is not finished within given time.

IllegalStateException - exception will be thrown if there's not exactly one task for the entity