com.vmware.appliance.access

Class ShellStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.access.ShellStub

All Implemented Interfaces:

Shell, ShellTypes, Service

public class ShellStub
extends com.vmware.vapi.internal.bindings.Stub
implements Shell

Remote stub implementation of the Shell API service.

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

Nested Class Summary

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

ShellTypes.ShellConfig

Field Summary

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

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

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

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.

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

ShellStub

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

ShellStub

public ShellStub(ApiProvider apiProvider,
         StubConfigurationBase config)

Method Detail

set

public void set(ShellTypes.ShellConfig config)

Description copied from interface: Shell

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.

Specified by:

set in interface Shell

Parameters:

config - Shell configuration

set

public void set(ShellTypes.ShellConfig config,
       InvocationConfig invocationConfig)

Description copied from interface: Shell

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.

Specified by:

set in interface Shell

Parameters:

config - Shell configuration

invocationConfig - Configuration for the method invocation.

set

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

Description copied from interface: Shell

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

Specified by:

set in interface Shell

Parameters:

config - Shell configuration

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

set

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

Description copied from interface: Shell

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

Specified by:

set in interface Shell

Parameters:

config - Shell configuration

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

invocationConfig - Configuration for the method invocation.

get

public ShellTypes.ShellConfig get()

Description copied from interface: Shell

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.

Specified by:

get in interface Shell

Returns:

Current shell configuration.

get

public ShellTypes.ShellConfig get(InvocationConfig invocationConfig)

Description copied from interface: Shell

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.

Specified by:

get in interface Shell

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Current shell configuration.

get

public void get(AsyncCallback<ShellTypes.ShellConfig> asyncCallback)

Description copied from interface: Shell

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

Specified by:

get in interface Shell

Parameters:

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

get

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

Description copied from interface: Shell

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

Specified by:

get in interface Shell

Parameters:

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

invocationConfig - Configuration for the method invocation.