| Package | Description |
|---|---|
| com.vmware.vapi.bindings | |
| com.vmware.vapi.client.util | |
| com.vmware.vapi.core | |
| com.vmware.vapi.data | |
| com.vmware.vapi.protocol | |
| com.vmware.vapi.protocol.client.http | |
| com.vmware.vapi.protocol.common.json | |
| com.vmware.vapi.provider | |
| com.vmware.vapi.provider.aggregator | |
| com.vmware.vapi.provider.introspection | |
| com.vmware.vapi.provider.local | |
| com.vmware.vapi.security | |
| com.vmware.vapi.std |
The
com.vmware.vapi.std package provides standard types that can be used
in the interface specification of any interface. |
| com.vmware.vapi.std.activation.impl | |
| com.vmware.vapi.std.errors |
The
com.vmware.vapi.std.errors package provides the standard exceptions
that can be included in the list of exceptions in the specification of methods
to indicate that the method might report those exceptions. |
| com.vmware.vapi.std.interposition |
The
com.vmware.vapi.std.interposition package provides interfaces that
TODO. |
| com.vmware.vapi.std.introspection |
The
com.vmware.vapi.std.introspection package provides interfaces that
expose basic information about the vAPI interfaces registered with a vAPI
provider. |
| com.vmware.vapi.util.async |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
StaticStructure._getDynamicField(String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which
have getters/setters).
|
| Modifier and Type | Method and Description |
|---|---|
void |
StaticStructure._setDynamicField(String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DynamicAuthnFilter.invoke(String service,
String operation,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle)
Invokes the decorated provider and in case of
Unauthenticated
error retries the request with refreshed ExecutionContext.SecurityContext. |
protected void |
DynamicAuthnFilter.invokeNext(String service,
String operation,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> handle) |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
MethodResult.getOutput()
Returns the output of the method call.
|
| Modifier and Type | Method and Description |
|---|---|
MethodResult |
SyncApiProvider.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx)
Invokes the specified operation using the provided input and
execution context.
|
MethodResult |
ApiProviderStubImpl.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx)
Synchronous variant of
ApiProviderStubImpl.invoke(String, String, DataValue, ExecutionContext, AsyncHandle) |
void |
DecoratorApiProvider.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
void |
ApiProviderStubImpl.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
void |
ApiProvider.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle)
Invokes the specified operation using the provided input and
execution context.
|
static MethodResult |
MethodResult.newResult(DataValue output)
Static factory method for creating
MethodResult instance
for normal return value (as opposed to error) |
void |
AsyncHandleSyncAdapter.updateProgress(DataValue progress) |
abstract void |
AsyncHandle.updateProgress(DataValue progress)
Reports progress for the operation invocation.
|
| Constructor and Description |
|---|
MethodResult(DataValue output,
ErrorValue error)
Constructor.
|
MethodResult(DataValue output,
ErrorValue error,
Consumer<AsyncHandle<MethodResult>> next)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BlobValue |
class |
BooleanValue |
class |
DoubleValue |
class |
ErrorValue
DataValue implementation for vAPI errors. |
class |
IntegerValue |
class |
ListValue
A list of values.
|
class |
OptionalValue |
class |
SecretValue
Value of type secret, which is intended to represent sensitive
information, like passwords.
|
class |
StringValue
Value of type string.
|
class |
StructValue
Thread-safety: Instances of this class are not thread-safe.
|
class |
VoidValue |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
DataValue.copy() |
DataValue |
ListValue.get(int index)
Returns the value at the specified position.
|
DataValue |
StructValue.getField(String field)
Gets the value for a field with given name.
|
DataValue |
OptionalValue.getValue() |
| Modifier and Type | Method and Description |
|---|---|
Map<String,DataValue> |
StructValue.getFields() |
List<DataValue> |
ListValue.getList()
Returns read-only view of the underlying data.
|
Iterator<DataValue> |
ListValue.iterator() |
| Modifier and Type | Method and Description |
|---|---|
void |
ListValue.add(DataValue value)
Appends the specified element to the end of this list.
|
void |
StructRefDefinition.completeValue(DataValue value) |
void |
StructDefinition.completeValue(DataValue value) |
void |
OptionalDefinition.completeValue(DataValue value) |
void |
ListDefinition.completeValue(DataValue value) |
void |
DataDefinition.completeValue(DataValue value)
Check the value to see if the data-definition can fill in any missing
data before validation
|
void |
StructValue.setField(String field,
DataValue value) |
List<Message> |
StructRefDefinition.validate(DataValue value) |
List<Message> |
StructDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
List<Message> |
OptionalDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
List<Message> |
OpaqueDefinition.validate(DataValue value)
Validates that the specified DataValue is an instance of this data
definition.
|
List<Message> |
ListDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
List<Message> |
DynamicStructDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
List<Message> |
DataDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
List<Message> |
AnyErrorDefinition.validate(DataValue value)
Validates that the specified
DataValue is an instance of this
data definition. |
boolean |
DataDefinition.validInstanceOf(DataValue value)
Validates that the specified
DataValue is an instance of this
data-definition. |
| Modifier and Type | Method and Description |
|---|---|
void |
ListValue.addAll(Collection<? extends DataValue> c)
Appends all of the values in the specified collection to the end of this
list, in the order that they are returned by the specified collection's
iterator.
|
| Constructor and Description |
|---|
OptionalValue(DataValue value) |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
RequestProcessor.Request.getInput() |
| Constructor and Description |
|---|
Request(String serviceId,
String operationId,
ExecutionContext ctx,
DataValue input) |
| Modifier and Type | Method and Description |
|---|---|
com.vmware.vapi.internal.protocol.client.rpc.HttpRequest |
RequestPreProcessor.handle(String serviceId,
String operationId,
com.vmware.vapi.internal.protocol.client.rpc.HttpRequest request,
DataValue params,
ExecutionContext executionContext)
Pre-process
HttpRequest before sending it to the caller. |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
JsonRpcDeserializer.deserializeDataValue(String jsonString)
Deserializes a JSON string as
DataValue. |
DataValue |
JsonConverter.toDataValue(InputStream input)
This method converts a JSON passed as an
InputStream into a concrete DataValue object. |
DataValue |
JsonConverter.toDataValue(String json)
This method converts a JSON string representation into a concrete
DataValue object. |
| Modifier and Type | Method and Description |
|---|---|
String |
JsonConverter.fromDataValue(DataValue value)
This method converts the
DataValue object to a JSON string. |
void |
JsonConverter.fromDataValue(DataValue value,
OutputStream outputStream)
This method converts the
DataValue Object to a ByteArrayOutputStream. |
String |
JsonRpcSerializer.serializeDataValue(DataValue dataValue)
Serializes the provided
DataValue as JSON. |
| Modifier and Type | Method and Description |
|---|---|
void |
ApiMethodBasedApiInterface.invoke(ExecutionContext ctx,
MethodIdentifier methodId,
DataValue input,
AsyncHandle<MethodResult> asyncHandle) |
void |
ApiInterface.invoke(ExecutionContext ctx,
MethodIdentifier methodId,
DataValue input,
AsyncHandle<MethodResult> asyncHandle)
Invokes a method and returns the result of that method invocation.
|
void |
ApiMethod.invoke(InvocationContext ctx,
DataValue input,
AsyncHandle<MethodResult> asyncHandle)
Invokes a method and returns the result of that method invocation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ApiAggregator.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
| Modifier and Type | Method and Description |
|---|---|
void |
ErrorAugmentingFilter.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
| Modifier and Type | Method and Description |
|---|---|
void |
LocalProvider.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
| Modifier and Type | Method and Description |
|---|---|
void |
AuthenticationFilter.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
NestedLocalizableMessage._getDynamicField(String fieldName) |
DataValue |
LocalizationParam._getDynamicField(String fieldName) |
DataValue |
LocalizableMessage._getDynamicField(String fieldName) |
DataValue |
DynamicID._getDynamicField(String fieldName) |
DataValue |
AuthenticationScheme._getDynamicField(String fieldName) |
| Modifier and Type | Method and Description |
|---|---|
void |
NestedLocalizableMessage._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
LocalizationParam._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
LocalizableMessage._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
DynamicID._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
AuthenticationScheme._setDynamicField(String fieldName,
DataValue fieldValue) |
| Modifier and Type | Method and Description |
|---|---|
void |
ActivationFilter.invoke(String serviceId,
String operationId,
DataValue input,
ExecutionContext ctx,
AsyncHandle<MethodResult> asyncHandle) |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
UnverifiedPeer._getDynamicField(String fieldName) |
DataValue |
Unsupported._getDynamicField(String fieldName) |
DataValue |
UnexpectedInput._getDynamicField(String fieldName) |
DataValue |
Unauthorized._getDynamicField(String fieldName) |
DataValue |
Unauthenticated._getDynamicField(String fieldName) |
DataValue |
UnableToAllocateResource._getDynamicField(String fieldName) |
DataValue |
TransientIndication._getDynamicField(String fieldName) |
DataValue |
TimedOut._getDynamicField(String fieldName) |
DataValue |
ServiceUnavailable._getDynamicField(String fieldName) |
DataValue |
ResourceInaccessible._getDynamicField(String fieldName) |
DataValue |
ResourceInUse._getDynamicField(String fieldName) |
DataValue |
ResourceBusy._getDynamicField(String fieldName) |
DataValue |
OperationNotFound._getDynamicField(String fieldName) |
DataValue |
NotFound._getDynamicField(String fieldName) |
DataValue |
NotAllowedInCurrentState._getDynamicField(String fieldName) |
DataValue |
InvalidRequest._getDynamicField(String fieldName) |
DataValue |
InvalidElementType._getDynamicField(String fieldName) |
DataValue |
InvalidElementConfiguration._getDynamicField(String fieldName) |
DataValue |
InvalidArgument._getDynamicField(String fieldName) |
DataValue |
InternalServerError._getDynamicField(String fieldName) |
DataValue |
FileLocations._getDynamicField(String fieldName) |
DataValue |
FeatureInUse._getDynamicField(String fieldName) |
DataValue |
Error._getDynamicField(String fieldName) |
DataValue |
ConcurrentChange._getDynamicField(String fieldName) |
DataValue |
Canceled._getDynamicField(String fieldName) |
DataValue |
ArgumentLocations._getDynamicField(String fieldName) |
DataValue |
AlreadyInDesiredState._getDynamicField(String fieldName) |
DataValue |
AlreadyExists._getDynamicField(String fieldName) |
| Modifier and Type | Method and Description |
|---|---|
void |
UnverifiedPeer._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
Unsupported._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
UnexpectedInput._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
Unauthorized._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
Unauthenticated._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
UnableToAllocateResource._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
TransientIndication._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
TimedOut._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ServiceUnavailable._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ResourceInaccessible._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ResourceInUse._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ResourceBusy._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
OperationNotFound._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
NotFound._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
NotAllowedInCurrentState._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvalidRequest._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvalidElementType._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvalidElementConfiguration._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvalidArgument._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InternalServerError._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
FileLocations._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
FeatureInUse._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
Error._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ConcurrentChange._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
Canceled._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ArgumentLocations._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
AlreadyInDesiredState._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
AlreadyExists._setDynamicField(String fieldName,
DataValue fieldValue) |
| Modifier and Type | Method and Description |
|---|---|
DataValue |
SecurityPrincipal._getDynamicField(String fieldName) |
DataValue |
InvocationResult._getDynamicField(String fieldName) |
DataValue |
InvocationRequest._getDynamicField(String fieldName) |
DataValue |
InvocationRequest.getOperationInput()
Input of the interposed operation.
|
DataValue |
InvocationResult.getOutput()
Normal result value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SecurityPrincipal._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvocationResult._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvocationRequest._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
InvocationRequest.setOperationInput(DataValue operationInput)
Input of the interposed operation.
|
void |
InvocationResult.setOutput(DataValue output)
Normal result value.
|
InvocationResult.Builder |
InvocationResult.Builder.setOutput(DataValue output)
Normal result value.
|
| Constructor and Description |
|---|
Builder(String serviceId,
String operationId,
DataValue operationInput,
List<SecurityPrincipal> groups)
Constructor with parameters for the required properties of
InvocationRequest. |
InvocationRequest(String serviceId,
String operationId,
DataValue operationInput,
SecurityPrincipal user,
List<SecurityPrincipal> groups)
This constructor is provided for backwards compatibility purposes only.
|
InvocationResult(InvocationResult.ResultType resultType,
DataValue output,
Structure error)
This constructor is provided for backwards compatibility purposes only.
|
| Modifier and Type | Method and Description |
|---|---|
DataValue |
ServiceTypes.Info._getDynamicField(String fieldName) |
DataValue |
ProviderTypes.Info._getDynamicField(String fieldName) |
DataValue |
OperationTypes.DataDefinition._getDynamicField(String fieldName) |
DataValue |
OperationTypes.Info._getDynamicField(String fieldName) |
| Modifier and Type | Method and Description |
|---|---|
void |
ServiceTypes.Info._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
ProviderTypes.Info._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
OperationTypes.DataDefinition._setDynamicField(String fieldName,
DataValue fieldValue) |
void |
OperationTypes.Info._setDynamicField(String fieldName,
DataValue fieldValue) |
| Modifier and Type | Method and Description |
|---|---|
void |
DecoratorAsyncHandle.updateProgress(DataValue progress) |
Copyright © 2023. All rights reserved.