com.vmware.vapi.core

Class ApiProviderStubImpl

java.lang.Object

com.vmware.vapi.core.ApiProviderStubImpl

All Implemented Interfaces:

ApiProvider, ApiProviderStub, SyncApiProvider, ApiIntrospection, ApiIntrospectionStub, SyncApiIntrospection

public class ApiProviderStubImpl
extends Object
implements ApiProviderStub

Utility which provides synchronous method overloads on top of an ApiProvider.

Constructor Summary

Constructors

Constructor and Description
ApiProviderStubImpl(ApiProvider provider)

Method Summary

Modifier and Type	Method and Description
ProviderDefinition	getDefinition() Returns the definition for this API provider.
ProviderDefinition	getDefinition(ExecutionContext ctx) Returns the definition for this API provider.
void	getDefinition(ExecutionContext ctx, AsyncHandle<ProviderDefinition> asyncHandle) Returns the definition for this API provider.
InterfaceDefinition	getInterface(ExecutionContext ctx, InterfaceIdentifier iface) Returns interface definition for a given interface identifier.
void	getInterface(ExecutionContext ctx, InterfaceIdentifier iface, AsyncHandle<InterfaceDefinition> asyncHandle) Returns interface definition for a given interface identifier.
InterfaceDefinition	getInterface(InterfaceIdentifier iface) Returns interface definition for a given interface identifier.
Set<InterfaceIdentifier>	getInterfaceIdentifiers() Returns the set of interface identifiers supported by this provider.
Set<InterfaceIdentifier>	getInterfaceIdentifiers(ExecutionContext ctx) Returns the set of interface identifiers supported by this provider.
void	getInterfaceIdentifiers(ExecutionContext ctx, AsyncHandle<Set<InterfaceIdentifier>> asyncHandle) Returns the set of interface identifiers supported by this provider.
MethodDefinition	getMethod(ExecutionContext ctx, MethodIdentifier method) Returns method definitions for a given method identifier.
void	getMethod(ExecutionContext ctx, MethodIdentifier method, AsyncHandle<MethodDefinition> asyncHandle) Returns method definitions for a given method identifier.
MethodDefinition	getMethod(MethodIdentifier method) Returns method definitions for a given method identifier.
MethodResult	invoke(String serviceId, String operationId, DataValue input, ExecutionContext ctx) Synchronous variant of invoke(String, String, DataValue, ExecutionContext, AsyncHandle)
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

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

Constructor Detail

ApiProviderStubImpl

public ApiProviderStubImpl(ApiProvider provider)

Method Detail

getDefinition

public void getDefinition(ExecutionContext ctx,
                          AsyncHandle<ProviderDefinition> asyncHandle)

Description copied from interface: ApiIntrospection

Returns the definition for this API provider.

Specified by:

getDefinition in interface ApiIntrospection

Parameters:

ctx - execution context for the invocation

asyncHandle - handle used to return result or error

getInterfaceIdentifiers

public void getInterfaceIdentifiers(ExecutionContext ctx,
                                    AsyncHandle<Set<InterfaceIdentifier>> asyncHandle)

Description copied from interface: ApiIntrospection

Returns the set of interface identifiers supported by this provider.

Specified by:

getInterfaceIdentifiers in interface ApiIntrospection

Parameters:

ctx - execution context for the invocation

asyncHandle - handle used to return result or error

getInterface

public void getInterface(ExecutionContext ctx,
                         InterfaceIdentifier iface,
                         AsyncHandle<InterfaceDefinition> asyncHandle)

Description copied from interface: ApiIntrospection

Returns interface definition for a given interface identifier.

Specified by:

getInterface in interface ApiIntrospection

Parameters:

ctx - execution context for the invocation

iface - interface identifier

asyncHandle - handle used to return result or error

getMethod

public void getMethod(ExecutionContext ctx,
                      MethodIdentifier method,
                      AsyncHandle<MethodDefinition> asyncHandle)

Description copied from interface: ApiIntrospection

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

Specified by:

getMethod in interface ApiIntrospection

Parameters:

ctx - execution context for the invocation

method - method identifier

asyncHandle - handle used to return result or error

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

getDefinition

public ProviderDefinition getDefinition()

Description copied from interface: ApiIntrospectionStub

Returns the definition for this API provider.

Specified by:

getDefinition in interface ApiIntrospectionStub

Returns:

definition for this provider

getInterfaceIdentifiers

public Set<InterfaceIdentifier> getInterfaceIdentifiers()

Description copied from interface: ApiIntrospectionStub

Returns the set of interface identifiers supported by this provider.

Specified by:

getInterfaceIdentifiers in interface ApiIntrospectionStub

Returns:

set of identifiers

getInterface

public InterfaceDefinition getInterface(InterfaceIdentifier iface)

Description copied from interface: ApiIntrospectionStub

Returns interface definition for a given interface identifier.

Specified by:

getInterface in interface ApiIntrospectionStub

Parameters:

iface - interface identifier

Returns:

interface definition for the given interface identifier

getMethod

public MethodDefinition getMethod(MethodIdentifier method)

Description copied from interface: ApiIntrospectionStub

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

Specified by:

getMethod in interface ApiIntrospectionStub

Parameters:

method - method identifier

Returns:

MethodDefinition instance or null is not found for the specified identifier

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 method)

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

method - method identifier

Returns:

MethodDefinition instance or null is not found for the specified identifier

invoke

public MethodResult invoke(String serviceId,
                           String operationId,
                           DataValue input,
                           ExecutionContext ctx)

Synchronous variant of invoke(String, String, DataValue, ExecutionContext, AsyncHandle)

Specified by:

invoke in interface SyncApiProvider

Parameters:

serviceId - identifier of the target service

operationId - identifier of the target operation

input - operation input parameters

ctx - execution context for the invocation

Returns:

result of the method invocation