com.vmware.appliance.access

Class SshStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.access.SshStub

All Implemented Interfaces:

Ssh, SshTypes, com.vmware.vapi.bindings.Service

public class SshStub
extends com.vmware.vapi.internal.bindings.Stub
implements Ssh

Remote stub implementation of the Ssh API service.

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

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.access.SshTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	get() Get enabled state of the SSH-based controlled CLI.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Boolean> asyncCallback) Get enabled state of the SSH-based controlled CLI.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Boolean> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get enabled state of the SSH-based controlled CLI.
boolean	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get enabled state of the SSH-based controlled CLI.
void	set(boolean enabled) Set enabled state of the SSH-based controlled CLI.
void	set(boolean enabled, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Set enabled state of the SSH-based controlled CLI.
void	set(boolean enabled, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Set enabled state of the SSH-based controlled CLI.
void	set(boolean enabled, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Set enabled state of the SSH-based controlled CLI.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SshStub

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

SshStub

public SshStub(com.vmware.vapi.core.ApiProvider apiProvider,
               com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

set

public void set(boolean enabled)

Description copied from interface: Ssh

Set enabled state of the SSH-based controlled CLI.

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

Specified by:

set in interface Ssh

Parameters:

enabled - SSH-based controlled CLI is enabled.

set

public void set(boolean enabled,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Set enabled state of the SSH-based 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 Ssh

Parameters:

enabled - SSH-based controlled CLI is enabled.

invocationConfig - Configuration for the method invocation.

set

public void set(boolean enabled,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Ssh

Set enabled state of the SSH-based 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 Ssh

Parameters:

enabled - SSH-based controlled CLI is enabled.

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

set

public void set(boolean enabled,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Set enabled state of the SSH-based 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 Ssh

Parameters:

enabled - SSH-based controlled CLI is enabled.

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

invocationConfig - Configuration for the method invocation.

get

public boolean get()

Description copied from interface: Ssh

Get enabled state of the SSH-based controlled CLI.

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

Specified by:

get in interface Ssh

Returns:

SSH-based controlled CLI is enabled.

get

public boolean get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Get enabled state of the SSH-based 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 Ssh

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

SSH-based controlled CLI is enabled.

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Boolean> asyncCallback)

Description copied from interface: Ssh

Get enabled state of the SSH-based controlled CLI.

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

Invocation Result:
SSH-based controlled CLI is enabled.

Operation Errors:
Error - Generic error

Specified by:

get in interface Ssh

Parameters:

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

get

public void get(com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Boolean> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ssh

Get enabled state of the SSH-based 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.

Invocation Result:
SSH-based controlled CLI is enabled.

Operation Errors:
Error - Generic error

Specified by:

get in interface Ssh

Parameters:

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

invocationConfig - Configuration for the method invocation.