com.vmware.vapi.bindings.server

Class AsyncContext<T>

java.lang.Object

com.vmware.vapi.bindings.server.AsyncContext<T>

public abstract class AsyncContext<T>
extends Object

Context of an asynchronous operation. Combines useful information about the operation (see getInvocationContext()) with means to complete the operation (with a result or an error) or report progress.

This context is the only legal way to complete an operation invocation (with a result object or an error) or report progress. The invocation will hang until either setResult(Object) or setError(RuntimeException) marks the operation as complete. Completing the operation more than once is forbidden. Reporting progress after the operation is complete is forbidden.

Constructor Summary

Constructors

Constructor and Description
AsyncContext()

Method Summary

Methods

Modifier and Type	Method and Description
abstract InvocationContext	getInvocationContext() Returns context information about the method invocation.
abstract void	setError(RuntimeException error) Completes the invocation with an error.
abstract void	setResult(T result) Completes the invocation with a result object.
abstract void	updateProgress(Progress progress) Reports progress for the operation invocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncContext

public AsyncContext()

Method Detail

getInvocationContext

public abstract InvocationContext getInvocationContext()

Returns context information about the method invocation.

Returns:

context of the method invocation

updateProgress

public abstract void updateProgress(Progress progress)

Reports progress for the operation invocation. May be invoked multiple times. Must not be invoked after setResult(Object) or setError(RuntimeException) is called.

Parameters:

progress - progress status of the operation invocation; must not be null

setResult

public abstract void setResult(T result)

Completes the invocation with a result object. Must not be called after the operation is already completed (with either a result object or an error).

Parameters:

result - operation result

setError

public abstract void setError(RuntimeException error)

Completes the invocation with an error. Must not be called after the operation is already completed (with either a result object or an error).

Parameters:

error - operation error