com.vmware.vapi.provider

Interface ApiMethod

public interface ApiMethod

The ApiMethod interface provides introspection and invocation APIs for a vAPI method; it is implemented by API providers.

Method Summary

Methods

Modifier and Type	Method and Description
MethodDefinition	getDefinition() Returns the definition for this method.
MethodIdentifier	getIdentifier() Returns the identifier for this method.
DataDefinition	getInputDefinition() Returns the data definition for the input of this method.
DataDefinition	getOutputDefinition() Returns the data definition for the output of this method.
void	invoke(ExecutionContext ctx, DataValue input, AsyncHandle<MethodResult> asyncHandle) Invokes a method and returns the result of that method invocation.

Method Detail

getIdentifier

MethodIdentifier getIdentifier()

Returns the identifier for this method.

Returns:

method identifier for this method

getDefinition

MethodDefinition getDefinition()

Returns the definition for this method.

Returns:

the definition of this method

getInputDefinition

DataDefinition getInputDefinition()

Returns the data definition for the input of this method.

Returns:

data definition for the method input

getOutputDefinition

DataDefinition getOutputDefinition()

Returns the data definition for the output of this method.

Returns:

data definition for the method output

invoke

void invoke(ExecutionContext ctx,
          DataValue input,
          AsyncHandle<MethodResult> asyncHandle)

Invokes a method and returns the result of that method invocation.

Parameters:

ctx - execution context for method invocation

input - input data value

asyncHandle - handle used to return result or error