com.vmware.appliance.access

Interface Shell

All Superinterfaces:

Service, ShellTypes

All Known Implementing Classes:

ShellStub

public interface Shell
extends Service, ShellTypes

Shell interface provides methods Get/Set enabled state of BASH.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.access.ShellTypes

ShellTypes.ShellConfig

Method Summary

Methods

Modifier and Type	Method and Description
ShellTypes.ShellConfig	get() Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	get(AsyncCallback<ShellTypes.ShellConfig> asyncCallback) Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	get(AsyncCallback<ShellTypes.ShellConfig> asyncCallback, InvocationConfig invocationConfig) Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
ShellTypes.ShellConfig	get(InvocationConfig invocationConfig) Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	set(ShellTypes.ShellConfig config) Set enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	set(ShellTypes.ShellConfig config, AsyncCallback<java.lang.Void> asyncCallback) Set enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	set(ShellTypes.ShellConfig config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set enabled state of BASH, that is, access to BASH from within the controlled CLI.
void	set(ShellTypes.ShellConfig config, InvocationConfig invocationConfig) Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Method Detail

set

void set(ShellTypes.ShellConfig config)

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

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

Parameters:

config - Shell configuration

Throws:

Error - Generic error

set

void set(ShellTypes.ShellConfig config,
       InvocationConfig invocationConfig)

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

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:

config - Shell configuration

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

set

void set(ShellTypes.ShellConfig config,
       AsyncCallback<java.lang.Void> asyncCallback)

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

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

Operation Errors:
Error - Generic error

Parameters:

config - Shell configuration

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

set

void set(ShellTypes.ShellConfig config,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

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:
Error - Generic error

Parameters:

config - Shell configuration

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

invocationConfig - Configuration for the method invocation.

get

ShellTypes.ShellConfig get()

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

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

Returns:

Current shell configuration.

Throws:

Error - Generic error

get

ShellTypes.ShellConfig get(InvocationConfig invocationConfig)

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

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:

Current shell configuration.

Throws:

Error - Generic error

get

void get(AsyncCallback<ShellTypes.ShellConfig> asyncCallback)

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

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

Operation Result:
Current shell configuration.

Operation Errors:
Error - Generic error

Parameters:

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

get

void get(AsyncCallback<ShellTypes.ShellConfig> asyncCallback,
       InvocationConfig invocationConfig)

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

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:
Current shell configuration.

Operation Errors:
Error - Generic error

Parameters:

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

invocationConfig - Configuration for the method invocation.