com.vmware.vapi.provider

Interface ApiInterface

All Known Implementing Classes:

ActivationManagerApiInterface, ActivationManagerSyncApiInterface, com.vmware.vapi.internal.bindings.ApiInterfaceSkeleton, ApiMethodBasedApiInterface, OperationApiInterface, OperationSyncApiInterface, ProviderApiInterface, ProviderSyncApiInterface, ServiceApiInterface, ServiceSyncApiInterface

public interface ApiInterface

The ApiInterface interface provides introspection APIs for a vAPI interface; it is implemented by API providers.

Method Summary

Methods

Modifier and Type	Method and Description
InterfaceDefinition	getDefinition() Returns the details for this interface.
InterfaceIdentifier	getIdentifier() Returns the identifier for this interface.
MethodDefinition	getMethodDefinition(MethodIdentifier methodId) Returns method definition for the specified method identifier.
void	invoke(ExecutionContext ctx, MethodIdentifier methodId, DataValue input, AsyncHandle<MethodResult> asyncHandle) Invokes a method and returns the result of that method invocation.

Method Detail

getIdentifier

InterfaceIdentifier getIdentifier()

Returns the identifier for this interface.

Returns:

interface identifier for this interface

getDefinition

InterfaceDefinition getDefinition()

Returns the details for this interface.

Returns:

interface details for this interface

getMethodDefinition

MethodDefinition getMethodDefinition(MethodIdentifier methodId)

Returns method definition for the specified method identifier.

Parameters:

methodId - identifier of the method

Returns:

MethodDefinition representing details for the requested method; or null method is not available

invoke

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

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

Parameters:

ctx - execution context for method invocation

methodId - identifier of the method to invoke; if there is no such method, an error will be returned

input - input data value

asyncHandle - handle used to return result or error