com.vmware.vapi.provider.local

Class LocalProvider

java.lang.Object

com.vmware.vapi.provider.local.LocalProvider

All Implemented Interfaces:

ApiProvider, SyncApiIntrospection

public class LocalProvider
extends Object
implements ApiProvider, SyncApiIntrospection

The LocalProvider class is a local (in-process) implementation of the ApiProvider interface.

Thread-safety: This class is thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_PROVIDER_DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
LocalProvider(String name) Calls LocalProvider(String, List) with an empty list of ApiInterfaces, automatically deploying introspection services.
LocalProvider(String name, List<ApiInterface> ifaces) Calls LocalProvider(String, List, boolean) automatically deploying introspection services.
LocalProvider(String name, List<ApiInterface> ifaces, boolean deployIntrospectionServices) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterface(ApiInterface iface) Adds the specified API interface to the provider.
void	addInterfaces(List<ApiInterface> ifaces) Adds a list of API interface to the provider.
ProviderDefinition	getDefinition(ExecutionContext ctx) Returns the definition for this API provider.
InterfaceDefinition	getInterface(ExecutionContext ctx, InterfaceIdentifier iface) Returns interface definition for a given interface identifier.
Set<InterfaceIdentifier>	getInterfaceIdentifiers(ExecutionContext ctx) Returns the set of interface identifiers supported by this provider.
MethodDefinition	getMethod(ExecutionContext ctx, MethodIdentifier methodId) Returns method definitions for a given method identifier.
void	invoke(String serviceId, String operationId, DataValue input, ExecutionContext ctx, AsyncHandle<MethodResult> asyncHandle) Invokes the specified operation using the provided input and execution context.

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_PROVIDER_DEFAULT_NAME

public static final String LOCAL_PROVIDER_DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

LocalProvider

public LocalProvider(String name)

Calls LocalProvider(String, List) with an empty list of ApiInterfaces, automatically deploying introspection services.

LocalProvider

public LocalProvider(String name,
             List<ApiInterface> ifaces)

Calls LocalProvider(String, List, boolean) automatically deploying introspection services.

LocalProvider

public LocalProvider(String name,
             List<ApiInterface> ifaces,
             boolean deployIntrospectionServices)

Constructor. Optionally can deploy a set of introspection services which expose the introspection API of the provider through invoke(String, String, DataValue, ExecutionContext, AsyncHandle).

Parameters:

name - name of the provider

ifaces - list of ApiInterfaces to register with this provider

deployIntrospectionServices - whether to automatically deploy introspection services

Method Detail

addInterface

public void addInterface(ApiInterface iface)

Adds the specified API interface to the provider.

Parameters:

iface - API interface to add; must not be null

Throws:

IllegalArgumentException - if API interface with the same ID as iface is already registered

addInterfaces

public void addInterfaces(List<ApiInterface> ifaces)

Adds a list of API interface to the provider.

Parameters:

ifaces - list of ApiInterfaces to register with this provider; must not be null

Throws:

IllegalArgumentException - if an API interface with the same ID as some iface is already registered

getDefinition

public ProviderDefinition getDefinition(ExecutionContext ctx)

Description copied from interface: SyncApiIntrospection

Returns the definition for this API provider.

Specified by:

getDefinition in interface SyncApiIntrospection

Parameters:

ctx - execution context for the invocation

Returns:

definition for this provider

getInterfaceIdentifiers

public Set<InterfaceIdentifier> getInterfaceIdentifiers(ExecutionContext ctx)

Description copied from interface: SyncApiIntrospection

Returns the set of interface identifiers supported by this provider.

Specified by:

getInterfaceIdentifiers in interface SyncApiIntrospection

Parameters:

ctx - execution context for the invocation

Returns:

set of identifiers

getInterface

public InterfaceDefinition getInterface(ExecutionContext ctx,
                               InterfaceIdentifier iface)

Description copied from interface: SyncApiIntrospection

Returns interface definition for a given interface identifier.

Specified by:

getInterface in interface SyncApiIntrospection

Parameters:

ctx - execution context for the invocation

iface - interface identifier

Returns:

interface definition for the given interface identifier

getMethod

public MethodDefinition getMethod(ExecutionContext ctx,
                         MethodIdentifier methodId)

Description copied from interface: SyncApiIntrospection

Returns method definitions for a given method identifier. or null if no such method is available

Specified by:

getMethod in interface SyncApiIntrospection

Parameters:

ctx - execution context for the invocation

methodId - method identifier

Returns:

MethodDefinition instance or null is not found for the specified identifier

invoke

public void invoke(String serviceId,
          String operationId,
          DataValue input,
          ExecutionContext ctx,
          AsyncHandle<MethodResult> asyncHandle)

Description copied from interface: ApiProvider

Invokes the specified operation using the provided input and execution context.

Target method is identified by serviceId and operationId.

Specified by:

invoke in interface ApiProvider

Parameters:

serviceId - identifier of the target service

operationId - identifier of the target operation

input - operation input parameters

ctx - execution context for the invocation

asyncHandle - handle used to asynchronously "return" the result or error of the invocation