com.vmware.vapi.metadata.authentication

Interface Component

All Superinterfaces:

ComponentTypes, Service

All Known Implementing Classes:

ComponentStub

public interface Component
extends Service, ComponentTypes

The Component interface provides methods to retrieve authentication information of a component element.

A component element is said to contain authentication information if any one of package elements contained in it has authentication information.

Field Summary

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

RESOURCE_TYPE

Method Summary

Methods

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

Method Detail

list

java.util.List<java.lang.String> list()

Returns the identifiers for the component elements that have authentication information.

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 have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

list

java.util.List<java.lang.String> list(InvocationConfig invocationConfig)

Returns the identifiers for the component elements that have authentication information.

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 have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.component.

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Returns the identifiers for the component elements that have authentication information.

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 have authentication information. 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<java.util.List<java.lang.String>> asyncCallback,
        InvocationConfig invocationConfig)

Returns the identifiers for the component elements that have authentication information.

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 have authentication information. 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(java.lang.String componentId)

Retrieves authentication information about the component element corresponding to componentId.

The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to 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 does not have any authentication information.

get

ComponentData get(java.lang.String componentId,
                InvocationConfig invocationConfig)

Retrieves authentication information about the component element corresponding to componentId.

The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to 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 does not have any authentication information.

get

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

Retrieves authentication information about the component element corresponding to componentId.

The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to 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 does not have any authentication information.

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(java.lang.String componentId,
       AsyncCallback<ComponentData> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves authentication information about the component element corresponding to componentId.

The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to 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 does not have any authentication information.

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

java.lang.String fingerprint(java.lang.String componentId)

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

The fingerprint provides clients an efficient way to check if the metadata for a particular component 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 authentication metadata of the component.

Throws:

NotFound - if the component element associated with componentId does not have any authentication information.

fingerprint

java.lang.String fingerprint(java.lang.String componentId,
                           InvocationConfig invocationConfig)

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

The fingerprint provides clients an efficient way to check if the metadata for a particular component 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 authentication metadata of the component.

Throws:

NotFound - if the component element associated with componentId does not have any authentication information.

fingerprint

void fingerprint(java.lang.String componentId,
               AsyncCallback<java.lang.String> asyncCallback)

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

The fingerprint provides clients an efficient way to check if the metadata for a particular component 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 authentication metadata of the component.

Operation Errors:
NotFound - if the component element associated with componentId does not have any authentication information.

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(java.lang.String componentId,
               AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

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

The fingerprint provides clients an efficient way to check if the metadata for a particular component 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 authentication metadata of the component.

Operation Errors:
NotFound - if the component element associated with componentId does not have any authentication information.

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.