com.vmware.vapi.provider

Class ApiMethodBasedApiInterface

java.lang.Object

com.vmware.vapi.provider.ApiMethodBasedApiInterface

All Implemented Interfaces:

ApiInterface

Direct Known Subclasses:

com.vmware.vapi.internal.bindings.ApiInterfaceSkeleton

public class ApiMethodBasedApiInterface
extends Object
implements ApiInterface

Base ApiInterface implementation that uses ApiMethod

Constructor Summary

Constructors

Constructor and Description
ApiMethodBasedApiInterface(InterfaceIdentifier iface) Constructor.
ApiMethodBasedApiInterface(String iface) Constructor.

Method Summary

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.
protected void	registerMethod(ApiMethod method) Registers an ApiMethod with this ApiInterface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiMethodBasedApiInterface

public ApiMethodBasedApiInterface(InterfaceIdentifier iface)

Constructor.

Parameters:

iface - interface identifier

ApiMethodBasedApiInterface

public ApiMethodBasedApiInterface(String iface)

Constructor.

Parameters:

iface - interface name

Method Detail

getIdentifier

public InterfaceIdentifier getIdentifier()

Description copied from interface: ApiInterface

Returns the identifier for this interface.

Specified by:

getIdentifier in interface ApiInterface

Returns:

interface identifier for this interface

getDefinition

public InterfaceDefinition getDefinition()

Description copied from interface: ApiInterface

Returns the details for this interface.

Specified by:

getDefinition in interface ApiInterface

Returns:

interface details for this interface

getMethodDefinition

public MethodDefinition getMethodDefinition(MethodIdentifier methodId)

Description copied from interface: ApiInterface

Returns method definition for the specified method identifier.

Specified by:

getMethodDefinition in interface ApiInterface

Parameters:

methodId - identifier of the method

Returns:

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

invoke

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

Description copied from interface: ApiInterface

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

Specified by:

invoke in interface ApiInterface

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

registerMethod

protected void registerMethod(ApiMethod method)

Registers an ApiMethod with this ApiInterface.

Parameters:

method - the API method to register