com.emc.vipr.client

Class Task<R>

java.lang.Object

com.emc.vipr.client.Task<R>

Type Parameters:

R - Type of the underlying resource running the operation.

public class Task<R>
extends java.lang.Object

Representation of an asynchronous task returned from an operation.

Constructor Summary

Constructors

Constructor and Description
Task(RestClient client, TaskResourceRep task, java.lang.Class<? extends R> resourceClass)

Method Summary

Modifier and Type	Method and Description
R	get() Waits for a task to complete (go into a pending or error state).
R	get(long timeoutMillis) Waits for a task to complete (go into a pending or error state).
java.util.List<NamedRelatedResourceRep>	getAssociatedResources() Delegates to the underlying task.
java.lang.String	getDescription() Delegates to the underlying task.
java.util.Calendar	getEndTime() Delegates to the underlying task.
java.lang.String	getMessage() Delegates to the underlying task.
java.lang.String	getOpId() Delegates to the underlying task.
NamedRelatedResourceRep	getResource() Delegates to the underlying task.
java.net.URI	getResourceId()
java.util.Calendar	getStartTime() Delegates to the underlying task.
TaskResourceRep	getTaskResource() Gets the underlying task resource.
boolean	isComplete()
boolean	isError()
Task<R>	refresh() Queries the task and updates information on this task.
Task<R>	waitFor() Waits for a task to complete (go into a pending or error state).
Task<R>	waitFor(long timeoutMillis) Waits for a task to complete (go into a pending or error state).

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(RestClient client,
            TaskResourceRep task,
            java.lang.Class<? extends R> resourceClass)

Method Detail

getTaskResource

public TaskResourceRep getTaskResource()

Gets the underlying task resource.

Returns:

TaskResourceRep for this task.

getResourceId

public java.net.URI getResourceId()

isComplete

public boolean isComplete()

isError

public boolean isError()

getResource

public NamedRelatedResourceRep getResource()

Delegates to the underlying task.

Returns:

Reference to the task resource.

getAssociatedResources

public java.util.List<NamedRelatedResourceRep> getAssociatedResources()

Delegates to the underlying task.

getDescription

public java.lang.String getDescription()

Delegates to the underlying task.

getEndTime

public java.util.Calendar getEndTime()

Delegates to the underlying task.

getMessage

public java.lang.String getMessage()

Delegates to the underlying task.

getOpId

public java.lang.String getOpId()

Delegates to the underlying task.

getStartTime

public java.util.Calendar getStartTime()

Delegates to the underlying task.

refresh

public Task<R> refresh()

Queries the task and updates information on this task.

Returns:

This task.

waitFor

public Task<R> waitFor()
                throws ViPRException

Waits for a task to complete (go into a pending or error state). If an error occurs it will be thrown as an exception.

Returns:

This task.

Throws:

ViPRException - Thrown if the task is in an error state.

waitFor

public Task<R> waitFor(long timeoutMillis)
                throws ViPRException

Waits for a task to complete (go into a pending or error state). If an error occurs it will be thrown as an exception.

Parameters:

timeoutMillis - Timeout after a number of milliseconds

Returns:

This task.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if the task is in an error state.

get

public R get()

Waits for a task to complete (go into a pending or error state). If an error occurs it will be thrown as an exception. If the task was successful this returns the actual object for the underlying resource.

Returns:

Resource object.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if the task is in an error state.

get

public R get(long timeoutMillis)

Waits for a task to complete (go into a pending or error state). If an error occurs it will be thrown as an exception. If the task was successful this returns the actual object for the underlying resource.

Parameters:

timeoutMillis - Timeout after a number of milliseconds

Returns:

Resource object.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if the task is in an error state.