com.vmware.vapi.metadata.cli

Class SourceStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vapi.metadata.cli.SourceStub

All Implemented Interfaces:

Service, Source, SourceTypes

public class SourceStub
extends com.vmware.vapi.internal.bindings.Stub
implements Source

Remote stub implementation of the Source API service.

WARNING: Internal API, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.metadata.cli.SourceTypes

SourceTypes.CreateSpec, SourceTypes.Info

Constructor Summary

Constructors

Constructor and Description
SourceStub(ApiProvider apiProvider, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
void	create(String sourceId, SourceTypes.CreateSpec spec) Creates a new metadata source.
void	create(String sourceId, SourceTypes.CreateSpec spec, AsyncCallback<Void> asyncCallback) Creates a new metadata source.
void	create(String sourceId, SourceTypes.CreateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Creates a new metadata source.
void	create(String sourceId, SourceTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a new metadata source.
void	delete(String sourceId) Deletes an existing CLI metadata source from the infrastructure.
void	delete(String sourceId, AsyncCallback<Void> asyncCallback) Deletes an existing CLI metadata source from the infrastructure.
void	delete(String sourceId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing CLI metadata source from the infrastructure.
void	delete(String sourceId, InvocationConfig invocationConfig) Deletes an existing CLI metadata source from the infrastructure.
String	fingerprint(String sourceId) Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.
void	fingerprint(String sourceId, AsyncCallback<String> asyncCallback) Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.
void	fingerprint(String sourceId, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.
String	fingerprint(String sourceId, InvocationConfig invocationConfig) Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.
SourceTypes.Info	get(String sourceId) Retrieves information about the metadata source corresponding to sourceId.
void	get(String sourceId, AsyncCallback<SourceTypes.Info> asyncCallback) Retrieves information about the metadata source corresponding to sourceId.
void	get(String sourceId, AsyncCallback<SourceTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the metadata source corresponding to sourceId.
SourceTypes.Info	get(String sourceId, InvocationConfig invocationConfig) Retrieves information about the metadata source corresponding to sourceId.
List<String>	list() Returns the identifiers of the metadata sources currently registered with the infrastructure.
void	list(AsyncCallback<List<String>> asyncCallback) Returns the identifiers of the metadata sources currently registered with the infrastructure.
void	list(AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of the metadata sources currently registered with the infrastructure.
List<String>	list(InvocationConfig invocationConfig) Returns the identifiers of the metadata sources currently registered with the infrastructure.
void	reload(String sourceId) Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.
void	reload(String sourceId, AsyncCallback<Void> asyncCallback) Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.
void	reload(String sourceId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.
void	reload(String sourceId, InvocationConfig invocationConfig) Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceStub

public SourceStub(ApiProvider apiProvider,
          StubConfigurationBase config)

Method Detail

create

public void create(String sourceId,
          SourceTypes.CreateSpec spec)

Description copied from interface: Source

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.cli package.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

create in interface Source

Parameters:

sourceId - metadata source identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

spec - create specification.

create

public void create(String sourceId,
          SourceTypes.CreateSpec spec,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.cli package.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

create in interface Source

Parameters:

sourceId - metadata source identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

spec - create specification.

invocationConfig - Configuration for the method invocation.

create

public void create(String sourceId,
          SourceTypes.CreateSpec spec,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Source

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.cli package.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
AlreadyExists - If the metadata source identifier is already registered with the infrastructure.
InvalidArgument - If type of the source specified in CreateSpec#type is invalid.
InvalidArgument - If the file specified in CreateSpec#filepath is not a valid JSON file or if the format of the CLI metadata in the JSON file is invalid.
InvalidArgument - If the URI specified in CreateSpec#address is unreachable or if there is a transport protocol or message protocol mismatch between the client and the server or if the remote server do not have interfaces present in com.vmware.vapi.metadata.cli package.
NotFound - If the file specified in CreateSpec#filepath does not exist.

Specified by:

create in interface Source

Parameters:

sourceId - metadata source identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

spec - create specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

public void create(String sourceId,
          SourceTypes.CreateSpec spec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.cli package.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
AlreadyExists - If the metadata source identifier is already registered with the infrastructure.
InvalidArgument - If type of the source specified in CreateSpec#type is invalid.
InvalidArgument - If the file specified in CreateSpec#filepath is not a valid JSON file or if the format of the CLI metadata in the JSON file is invalid.
InvalidArgument - If the URI specified in CreateSpec#address is unreachable or if there is a transport protocol or message protocol mismatch between the client and the server or if the remote server do not have interfaces present in com.vmware.vapi.metadata.cli package.
NotFound - If the file specified in CreateSpec#filepath does not exist.

Specified by:

create in interface Source

Parameters:

sourceId - metadata source identifier. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

spec - create specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

public void delete(String sourceId)

Description copied from interface: Source

Deletes an existing CLI metadata source from the infrastructure.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

delete in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

delete

public void delete(String sourceId,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Deletes an existing CLI metadata source from the infrastructure.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

invocationConfig - Configuration for the method invocation.

delete

public void delete(String sourceId,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Source

Deletes an existing CLI metadata source from the infrastructure.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

delete in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

public void delete(String sourceId,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Deletes an existing CLI metadata source from the infrastructure.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

delete in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

public SourceTypes.Info get(String sourceId)

Description copied from interface: Source

Retrieves information about the metadata source corresponding to sourceId.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

Returns:

The SourceTypes.Info instance that corresponds to sourceId

get

public SourceTypes.Info get(String sourceId,
                   InvocationConfig invocationConfig)

Description copied from interface: Source

Retrieves information about the metadata source corresponding to sourceId.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

invocationConfig - Configuration for the method invocation.

Returns:

The SourceTypes.Info instance that corresponds to sourceId

get

public void get(String sourceId,
       AsyncCallback<SourceTypes.Info> asyncCallback)

Description copied from interface: Source

Retrieves information about the metadata source corresponding to sourceId.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
The SourceTypes.Info instance that corresponds to sourceId

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

get in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(String sourceId,
       AsyncCallback<SourceTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Source

Retrieves information about the metadata source corresponding to sourceId.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The SourceTypes.Info instance that corresponds to sourceId

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

get in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

public List<String> list()

Description copied from interface: Source

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

list in interface Source

Returns:

The list of identifiers for metadata sources currently registered. The return value will contain identifiers for the resource type: com.vmware.vapi.metadata.source.

list

public List<String> list(InvocationConfig invocationConfig)

Description copied from interface: Source

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Source

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of identifiers for metadata sources currently registered. The return value will contain identifiers for the resource type: com.vmware.vapi.metadata.source.

list

public void list(AsyncCallback<List<String>> asyncCallback)

Description copied from interface: Source

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
The list of identifiers for metadata sources currently registered. The return value will contain identifiers for the resource type: com.vmware.vapi.metadata.source.

Specified by:

list in interface Source

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

public void list(AsyncCallback<List<String>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Source

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The list of identifiers for metadata sources currently registered. The return value will contain identifiers for the resource type: com.vmware.vapi.metadata.source.

Specified by:

list in interface Source

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

reload

public void reload(String sourceId)

Description copied from interface: Source

Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

reload in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, all the metadata sources are reloaded.

reload

public void reload(String sourceId,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

reload in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, all the metadata sources are reloaded.

invocationConfig - Configuration for the method invocation.

reload

public void reload(String sourceId,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Source

Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

reload in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, all the metadata sources are reloaded.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

reload

public void reload(String sourceId,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Source

Reloads the CLI metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

reload in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, all the metadata sources are reloaded.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

fingerprint

public String fingerprint(String sourceId)

Description copied from interface: Source

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

fingerprint in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, the fingerprint of all the metadata sources is returned.

Returns:

Aggregate fingerprint of all the metadata sources or of a particular metadata source.

fingerprint

public String fingerprint(String sourceId,
                 InvocationConfig invocationConfig)

Description copied from interface: Source

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

fingerprint in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, the fingerprint of all the metadata sources is returned.

invocationConfig - Configuration for the method invocation.

Returns:

Aggregate fingerprint of all the metadata sources or of a particular metadata source.

fingerprint

public void fingerprint(String sourceId,
               AsyncCallback<String> asyncCallback)

Description copied from interface: Source

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Aggregate fingerprint of all the metadata sources or of a particular metadata source.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

fingerprint in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, the fingerprint of all the metadata sources is returned.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

fingerprint

public void fingerprint(String sourceId,
               AsyncCallback<String> asyncCallback,
               InvocationConfig invocationConfig)

Description copied from interface: Source

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if sourceId is specified.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Aggregate fingerprint of all the metadata sources or of a particular metadata source.

Operation Errors:
NotFound - If the metadata source identifier is not found.

Specified by:

fingerprint in interface Source

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.source. If unspecified, the fingerprint of all the metadata sources is returned.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.