com.vmware.vapi.metadata.authentication

Interface Source

All Superinterfaces:

Service, SourceTypes

All Known Implementing Classes:

SourceStub

public interface Source
extends Service, SourceTypes

The Source interface provides methods to manage the sources of authentication metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains authentication information. The generated file can be registered as a source of metadata.

The authentication file contains all the data present in the interface definition files. Each authentication file contains data about one component element. When a authentication file is added as a source, each source contributes only one component element's metadata.

Authentication metadata can also be discovered from a remote server that supports the authentication metadata interfaces (see com.vmware.vapi.metadata.authentication). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Nested Class Summary

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

SourceTypes.CreateSpec, SourceTypes.Info

Field Summary

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

RESOURCE_TYPE

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 authentication metadata source from the infrastructure.
void	delete(String sourceId, AsyncCallback<Void> asyncCallback) Deletes an existing authentication metadata source from the infrastructure.
void	delete(String sourceId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing authentication metadata source from the infrastructure.
void	delete(String sourceId, InvocationConfig invocationConfig) Deletes an existing authentication 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 authentication 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 authentication 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 authentication metadata from all the metadata sources or of a particular metadata source if sourceId is specified.
void	reload(String sourceId, InvocationConfig invocationConfig) Reloads the authentication metadata from all the metadata sources or of a particular metadata source if sourceId is specified.

Method Detail

create

void create(String sourceId,
          SourceTypes.CreateSpec spec)

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

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

Parameters:

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

spec - create specification.

Throws:

AlreadyExists - if the metadata source identifier is already registered with the infrastructure.

InvalidArgument - if the 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 authentication 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.authentication package.

NotFound - if the file specified in CreateSpec#filepath does not exist.

create

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

Creates a new metadata source. Once the server validates the registration information of the metadata source, the authentication metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.authentication 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.

Parameters:

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

spec - create specification.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the metadata source identifier is already registered with the infrastructure.

InvalidArgument - if the 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 authentication 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.authentication package.

NotFound - if the file specified in CreateSpec#filepath does not exist.

create

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

Creates a new metadata source. Once the server validates the registration information of the metadata source, the authentication metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.authentication 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 the 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 authentication 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.authentication package.
NotFound - if the file specified in CreateSpec#filepath does not exist.

Parameters:

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

spec - create specification.

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

create

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

Creates a new metadata source. Once the server validates the registration information of the metadata source, the authentication metadata is retrieved from the source. This populates elements in all the interfaces defined in com.vmware.vapi.metadata.authentication 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 the 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 authentication 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.authentication package.
NotFound - if the file specified in CreateSpec#filepath does not exist.

Parameters:

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

spec - create specification.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(String sourceId)

Deletes an existing authentication metadata source from the infrastructure.

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

Parameters:

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

Throws:

NotFound - if the metadata source identifier is not found.

delete

void delete(String sourceId,
          InvocationConfig invocationConfig)

Deletes an existing authentication 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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the metadata source identifier is not found.

delete

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

Deletes an existing authentication 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.

Parameters:

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

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

delete

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

Deletes an existing authentication 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.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.

get

SourceTypes.Info get(String sourceId)

Retrieves information about the metadata source corresponding to sourceId.

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

Parameters:

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

Returns:

The SourceTypes.Info instance that corresponds to sourceId

Throws:

NotFound - if the metadata source associated with sourceId is not found.

get

SourceTypes.Info get(String sourceId,
                   InvocationConfig invocationConfig)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

The SourceTypes.Info instance that corresponds to sourceId

Throws:

NotFound - if the metadata source associated with sourceId is not found.

get

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

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 associated with sourceId is not found.

Parameters:

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

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

get

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

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 associated with sourceId is not found.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.

list

List<String> list()

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.

Returns:

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

list

List<String> list(InvocationConfig invocationConfig)

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.

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.authentication.source.

list

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

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.authentication.source.

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 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.authentication.source.

Parameters:

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

invocationConfig - Configuration for the method invocation.

reload

void reload(String sourceId)

Reloads the authentication 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.

Parameters:

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

Throws:

NotFound - if the metadata source associated with sourceId is not found.

reload

void reload(String sourceId,
          InvocationConfig invocationConfig)

Reloads the authentication 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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the metadata source associated with sourceId is not found.

reload

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

Reloads the authentication 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 associated with sourceId is not found.

Parameters:

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

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

reload

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

Reloads the authentication 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 associated with sourceId is not found.

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.authentication.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

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.

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

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.authentication.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.

Throws:

NotFound - if the metadata source associated with sourceId is not found.

fingerprint

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.

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:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.authentication.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.

Throws:

NotFound - if the metadata source associated with sourceId is not found.

fingerprint

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.

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 associated with sourceId is not found.

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.authentication.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

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.

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 associated with sourceId is not found.

Parameters:

sourceId - Identifier of the metadata source. The parameter must be an identifier for the resource type: com.vmware.vapi.metadata.authentication.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.