com.vmware.vapi.metadata.cli

Interface Command

All Superinterfaces:

CommandTypes, Service

All Known Implementing Classes:

CommandStub

public interface Command
extends Service, CommandTypes

The Command interface provides methods to get information about command line interface (CLI) commands.

Nested Class Summary

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

CommandTypes.FormatterType, CommandTypes.GenericType, CommandTypes.Identity, CommandTypes.Info, CommandTypes.OptionInfo, CommandTypes.OutputFieldInfo, CommandTypes.OutputInfo

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.cli.CommandTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	fingerprint() Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
void	fingerprint(AsyncCallback<java.lang.String> asyncCallback) Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
void	fingerprint(AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
java.lang.String	fingerprint(InvocationConfig invocationConfig) Returns the aggregate fingerprint of all the command metadata from all the metadata sources.
CommandTypes.Info	get(CommandTypes.Identity identity) Retrieves information about a command including information about how to execute that command.
void	get(CommandTypes.Identity identity, AsyncCallback<CommandTypes.Info> asyncCallback) Retrieves information about a command including information about how to execute that command.
void	get(CommandTypes.Identity identity, AsyncCallback<CommandTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves information about a command including information about how to execute that command.
CommandTypes.Info	get(CommandTypes.Identity identity, InvocationConfig invocationConfig) Retrieves information about a command including information about how to execute that command.
java.util.List<CommandTypes.Identity>	list(java.lang.String path) Returns the identifiers of all commands, or commands in a specific namespace.
void	list(java.lang.String path, AsyncCallback<java.util.List<CommandTypes.Identity>> asyncCallback) Returns the identifiers of all commands, or commands in a specific namespace.
void	list(java.lang.String path, AsyncCallback<java.util.List<CommandTypes.Identity>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all commands, or commands in a specific namespace.
java.util.List<CommandTypes.Identity>	list(java.lang.String path, InvocationConfig invocationConfig) Returns the identifiers of all commands, or commands in a specific namespace.

Method Detail

list

java.util.List<CommandTypes.Identity> list(java.lang.String path)

Returns the identifiers of all commands, or commands in a specific namespace.

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

Parameters:

path - The dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.

Returns:

Identifiers of the requested commands.

Throws:

NotFound - if a namespace corresponding to path doesn't exist.

list

java.util.List<CommandTypes.Identity> list(java.lang.String path,
                                           InvocationConfig invocationConfig)

Returns the identifiers of all commands, or commands in a specific namespace.

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:

path - The dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

Identifiers of the requested commands.

Throws:

NotFound - if a namespace corresponding to path doesn't exist.

list

void list(java.lang.String path,
          AsyncCallback<java.util.List<CommandTypes.Identity>> asyncCallback)

Returns the identifiers of all commands, or commands in a specific namespace.

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

Invocation Result:
Identifiers of the requested commands.

Operation Errors:
NotFound - if a namespace corresponding to path doesn't exist.

Parameters:

path - The dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.

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

list

void list(java.lang.String path,
          AsyncCallback<java.util.List<CommandTypes.Identity>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the identifiers of all commands, or commands in a specific namespace.

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

Invocation Result:
Identifiers of the requested commands.

Operation Errors:
NotFound - if a namespace corresponding to path doesn't exist.

Parameters:

path - The dot-separated path of the namespace for which command identifiers should be returned. If null identifiers of all commands registered with the infrastructure will be returned.

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

invocationConfig - Configuration for the method invocation.

get

CommandTypes.Info get(CommandTypes.Identity identity)

Retrieves information about a command including information about how to execute that command.

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

Parameters:

identity - Identifier of the command for which to retreive information.

Returns:

Information about the command including information about how to execute that command.

Throws:

NotFound - if a command corresponding to identity doesn't exist.

get

CommandTypes.Info get(CommandTypes.Identity identity,
                      InvocationConfig invocationConfig)

Retrieves information about a command including information about how to execute that command.

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:

identity - Identifier of the command for which to retreive information.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the command including information about how to execute that command.

Throws:

NotFound - if a command corresponding to identity doesn't exist.

get

void get(CommandTypes.Identity identity,
         AsyncCallback<CommandTypes.Info> asyncCallback)

Retrieves information about a command including information about how to execute that command.

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

Invocation Result:
Information about the command including information about how to execute that command.

Operation Errors:
NotFound - if a command corresponding to identity doesn't exist.

Parameters:

identity - Identifier of the command for which to retreive information.

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

get

void get(CommandTypes.Identity identity,
         AsyncCallback<CommandTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves information about a command including information about how to execute that command.

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

Invocation Result:
Information about the command including information about how to execute that command.

Operation Errors:
NotFound - if a command corresponding to identity doesn't exist.

Parameters:

identity - Identifier of the command for which to retreive information.

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

invocationConfig - Configuration for the method invocation.

fingerprint

java.lang.String fingerprint()

Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

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

Returns:

Fingerprint of all the command metadata present on the server.

fingerprint

java.lang.String fingerprint(InvocationConfig invocationConfig)

Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

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:

Fingerprint of all the command metadata present on the server.

fingerprint

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

Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

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

Invocation Result:
Fingerprint of all the command metadata present on the server.

Parameters:

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

fingerprint

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

Returns the aggregate fingerprint of all the command metadata from all the metadata sources.

The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.

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

Invocation Result:
Fingerprint of all the command metadata present on the server.

Parameters:

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

invocationConfig - Configuration for the method invocation.