com.vmware.vapi.metadata.cli

Class CommandStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vapi.metadata.cli.CommandStub

All Implemented Interfaces:

Service, Command, CommandTypes

public class CommandStub
extends com.vmware.vapi.internal.bindings.Stub
implements Command

Remote stub implementation of the Command API service.

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

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 class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

Constructor and Description
CommandStub(ApiProvider apiProvider, StubConfigurationBase config)
CommandStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

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.

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

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandStub

public CommandStub(ApiProvider apiProvider,
           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
           StubConfigurationBase config)

CommandStub

public CommandStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Command

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.

Specified by:

list in interface Command

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.

list

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

Description copied from interface: Command

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.

Specified by:

list in interface Command

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.

list

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

Description copied from interface: Command

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.

Operation Result:
Identifiers of the requested commands.

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

Specified by:

list in interface Command

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

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

Description copied from interface: Command

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.

Operation Result:
Identifiers of the requested commands.

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

Specified by:

list in interface Command

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

public CommandTypes.Info get(CommandTypes.Identity identity)

Description copied from interface: Command

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.

Specified by:

get in interface Command

Parameters:

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

Returns:

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

get

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

Description copied from interface: Command

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.

Specified by:

get in interface Command

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.

get

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

Description copied from interface: Command

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.

Operation 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.

Specified by:

get in interface Command

Parameters:

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

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

get

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

Description copied from interface: Command

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.

Operation 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.

Specified by:

get in interface Command

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

public java.lang.String fingerprint()

Description copied from interface: Command

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.

Specified by:

fingerprint in interface Command

Returns:

Fingerprint of all the command metadata present on the server.

fingerprint

public java.lang.String fingerprint(InvocationConfig invocationConfig)

Description copied from interface: Command

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.

Specified by:

fingerprint in interface Command

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Fingerprint of all the command metadata present on the server.

fingerprint

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

Description copied from interface: Command

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.

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

Specified by:

fingerprint in interface Command

Parameters:

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

fingerprint

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

Description copied from interface: Command

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.

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

Specified by:

fingerprint in interface Command

Parameters:

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

invocationConfig - Configuration for the method invocation.