com.vmware.vcloud.api.rest.client

Interface VcdTaskMonitor.MultiTaskTracker

Enclosing interface:

VcdTaskMonitor

public static interface VcdTaskMonitor.MultiTaskTracker

A monitor for many tasks that will eventually report the final TaskStatus of each task identified by the task URN

Tasks to track can be added at any time until it is indicated to the tracker that all tasks have been added and a tracking Future is requested. At that time, the tracker will begin reconciling the results and make them available when all added tasks have completed and their final results know via the tracking Future.

Since:

8.10

Method Summary

Modifier and Type	Method and Description
Future<Map<String,TaskStatus>>	toTrackingFuture() Indicate to the tracker that all tasks desirous to be tracked have been added to the tracker.
void	track(Collection<com.vmware.vcloud.api.rest.schema_v1_5.TaskType> tasks) Add a list of tasks for the monitor to track.
void	track(com.vmware.vcloud.api.rest.schema_v1_5.TaskType... tasks) Add a list of tasks for the monitor to track.

Method Detail

track

void track(com.vmware.vcloud.api.rest.schema_v1_5.TaskType... tasks)
    throws IllegalStateException

Add a list of tasks for the monitor to track.

Tasks may be added until toTrackingFuture() is called to indicate that no more tasks will be added to this tracker.

Parameters:

tasks - List of Tasks to be tracked

Throws:

IllegalStateException - if toTrackingFuture() has been called.

track

void track(Collection<com.vmware.vcloud.api.rest.schema_v1_5.TaskType> tasks)
    throws IllegalStateException

Add a list of tasks for the monitor to track.

Tasks may be added until toTrackingFuture() is called to indicate that no more tasks will be added to this tracker.

Parameters:

tasks - List of Tasks to be tracked

Throws:

IllegalStateException - if toTrackingFuture() has been called.

toTrackingFuture

Future<Map<String,TaskStatus>> toTrackingFuture()

Indicate to the tracker that all tasks desirous to be tracked have been added to the tracker.

This will signal to the tracker to begin final reconciliation of the results.

Returns:

a Future representing the VcdTaskMonitor.MultiTaskTracker's activities. When completion state of all status's is known the Future will be updated to return a Map of task id's to TaskStatus. Canceling the Future will stop the underlying tracking.