com.vmware.vapi.metadata.metamodel

Interface Component

All Superinterfaces:

ComponentTypes, Service

All Known Implementing Classes:

ComponentStub

public interface Component
extends Service, ComponentTypes

The Component interface providers methods to retrieve metamodel information of a component element.

A component defines a set of functionality that is deployed together and versioned together. For example, all the interfaces that belong to VMware Content Library are part of a single component. A component element describes a component. A component element contains one or more package elements.

The methods for package elements are provided by interface Package.

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.metamodel.ComponentTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
String	fingerprint(String componentId) Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.
void	fingerprint(String componentId, AsyncCallback<String> asyncCallback) Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.
void	fingerprint(String componentId, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.
String	fingerprint(String componentId, InvocationConfig invocationConfig) Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.
ComponentData	get(String componentId) Retrieves metamodel information about the component element corresponding to componentId.
void	get(String componentId, AsyncCallback<ComponentData> asyncCallback) Retrieves metamodel information about the component element corresponding to componentId.
void	get(String componentId, AsyncCallback<ComponentData> asyncCallback, InvocationConfig invocationConfig) Retrieves metamodel information about the component element corresponding to componentId.
ComponentData	get(String componentId, InvocationConfig invocationConfig) Retrieves metamodel information about the component element corresponding to componentId.
List<String>	list() Returns the identifiers for the component elements that are registered with the infrastructure.
void	list(AsyncCallback<List<String>> asyncCallback) Returns the identifiers for the component elements that are registered with the infrastructure.
void	list(AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers for the component elements that are registered with the infrastructure.
List<String>	list(InvocationConfig invocationConfig) Returns the identifiers for the component elements that are registered with the infrastructure.

Method Detail

list

List<String> list()

Returns the identifiers for the component elements that are registered with the infrastructure.

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

Returns:

The list of identifiers for the component elements that are registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

list

List<String> list(InvocationConfig invocationConfig)

Returns the identifiers for the component elements that are 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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of identifiers for the component elements that are registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

list

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

Returns the identifiers for the component elements that are 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 the component elements that are registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

Parameters:

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

list

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

Returns the identifiers for the component elements that are 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 the component elements that are registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

ComponentData get(String componentId)

Retrieves metamodel information about the component element corresponding to componentId.

The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.

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

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

Returns:

The ComponentData instance that corresponds to componentId.

Throws:

NotFound - if the component element associated with componentId is not registered with the infrastructure.

get

ComponentData get(String componentId,
                InvocationConfig invocationConfig)

Retrieves metamodel information about the component element corresponding to componentId.

The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.

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

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

invocationConfig - Configuration for the method invocation.

Returns:

The ComponentData instance that corresponds to componentId.

Throws:

NotFound - if the component element associated with componentId is not registered with the infrastructure.

get

void get(String componentId,
       AsyncCallback<ComponentData> asyncCallback)

Retrieves metamodel information about the component element corresponding to componentId.

The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.

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

Operation Result:
The ComponentData instance that corresponds to componentId.

Operation Errors:
NotFound - if the component element associated with componentId is not registered with the infrastructure.

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

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

get

void get(String componentId,
       AsyncCallback<ComponentData> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves metamodel information about the component element corresponding to componentId.

The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.

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 ComponentData instance that corresponds to componentId.

Operation Errors:
NotFound - if the component element associated with componentId is not registered with the infrastructure.

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

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

invocationConfig - Configuration for the method invocation.

fingerprint

String fingerprint(String componentId)

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.

The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get(java.lang.String).

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

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

Returns:

The fingerprint computed from the metamodel metadata of the component element.

Throws:

NotFound - if the component element associated with componentId is not registered with the infrastructure.

fingerprint

String fingerprint(String componentId,
                 InvocationConfig invocationConfig)

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.

The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get(java.lang.String).

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

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

invocationConfig - Configuration for the method invocation.

Returns:

The fingerprint computed from the metamodel metadata of the component element.

Throws:

NotFound - if the component element associated with componentId is not registered with the infrastructure.

fingerprint

void fingerprint(String componentId,
               AsyncCallback<String> asyncCallback)

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.

The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get(java.lang.String).

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

Operation Result:
The fingerprint computed from the metamodel metadata of the component element.

Operation Errors:
NotFound - if the component element associated with componentId is not registered with the infrastructure.

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

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

fingerprint

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

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId.

The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get(java.lang.String).

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 fingerprint computed from the metamodel metadata of the component element.

Operation Errors:
NotFound - if the component element associated with componentId is not registered with the infrastructure.

Parameters:

componentId - Identifier of the component element. The parameter must be an identifier for the resource type: com.vmware.vapi.component.

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

invocationConfig - Configuration for the method invocation.