com.vmware.appliance.networking

Class ProxyStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.networking.ProxyStub

All Implemented Interfaces:

Proxy, ProxyTypes, Service

public class ProxyStub
extends com.vmware.vapi.internal.bindings.Stub
implements Proxy

Remote stub implementation of the Proxy API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.networking.ProxyTypes

ProxyTypes.Config, ProxyTypes.Protocol, ProxyTypes.ServerStatus, ProxyTypes.TestResult

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.appliance.networking.ProxyTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String protocol) Deletes a proxy configuration for a specific protocol.
void	delete(java.lang.String protocol, AsyncCallback<java.lang.Void> asyncCallback) Deletes a proxy configuration for a specific protocol.
void	delete(java.lang.String protocol, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a proxy configuration for a specific protocol.
void	delete(java.lang.String protocol, InvocationConfig invocationConfig) Deletes a proxy configuration for a specific protocol.
ProxyTypes.Config	get(java.lang.String protocol) Gets the proxy configuration for a specific protocol.
void	get(java.lang.String protocol, AsyncCallback<ProxyTypes.Config> asyncCallback) Gets the proxy configuration for a specific protocol.
void	get(java.lang.String protocol, AsyncCallback<ProxyTypes.Config> asyncCallback, InvocationConfig invocationConfig) Gets the proxy configuration for a specific protocol.
ProxyTypes.Config	get(java.lang.String protocol, InvocationConfig invocationConfig) Gets the proxy configuration for a specific protocol.
java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>	list() Gets proxy configuration for all configured protocols.
void	list(AsyncCallback<java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>> asyncCallback) Gets proxy configuration for all configured protocols.
void	list(AsyncCallback<java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>> asyncCallback, InvocationConfig invocationConfig) Gets proxy configuration for all configured protocols.
java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>	list(InvocationConfig invocationConfig) Gets proxy configuration for all configured protocols.
void	set(java.lang.String protocol, ProxyTypes.Config config) Configures which proxy server to use for the specified protocol.
void	set(java.lang.String protocol, ProxyTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback) Configures which proxy server to use for the specified protocol.
void	set(java.lang.String protocol, ProxyTypes.Config config, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Configures which proxy server to use for the specified protocol.
void	set(java.lang.String protocol, ProxyTypes.Config config, InvocationConfig invocationConfig) Configures which proxy server to use for the specified protocol.
ProxyTypes.TestResult	test(java.lang.String host, java.lang.String protocol, ProxyTypes.Config config) Tests a proxy configuration by testing the connection to the proxy server and test host.
void	test(java.lang.String host, java.lang.String protocol, ProxyTypes.Config config, AsyncCallback<ProxyTypes.TestResult> asyncCallback) Tests a proxy configuration by testing the connection to the proxy server and test host.
void	test(java.lang.String host, java.lang.String protocol, ProxyTypes.Config config, AsyncCallback<ProxyTypes.TestResult> asyncCallback, InvocationConfig invocationConfig) Tests a proxy configuration by testing the connection to the proxy server and test host.
ProxyTypes.TestResult	test(java.lang.String host, java.lang.String protocol, ProxyTypes.Config config, InvocationConfig invocationConfig) Tests a proxy configuration by testing the connection to the proxy server and test host.

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

ProxyStub

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

ProxyStub

public ProxyStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

test

public ProxyTypes.TestResult test(java.lang.String host,
                                  java.lang.String protocol,
                                  ProxyTypes.Config config)

Description copied from interface: Proxy

Tests a proxy configuration by testing the connection to the proxy server and test host. This method was added in vSphere API 6.7.

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

Specified by:

test in interface Proxy

Parameters:

host - A hostname, IPv4 or Ipv6 address.

protocol - Protocol whose proxy is to be tested.

config - Proxy configuration to test.

Returns:

Status of proxy settings.

test

public ProxyTypes.TestResult test(java.lang.String host,
                                  java.lang.String protocol,
                                  ProxyTypes.Config config,
                                  InvocationConfig invocationConfig)

Description copied from interface: Proxy

Tests a proxy configuration by testing the connection to the proxy server and test host. This method was added in vSphere API 6.7.

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:

test in interface Proxy

Parameters:

host - A hostname, IPv4 or Ipv6 address.

protocol - Protocol whose proxy is to be tested.

config - Proxy configuration to test.

invocationConfig - Configuration for the method invocation.

Returns:

Status of proxy settings.

test

public void test(java.lang.String host,
                 java.lang.String protocol,
                 ProxyTypes.Config config,
                 AsyncCallback<ProxyTypes.TestResult> asyncCallback)

Description copied from interface: Proxy

Tests a proxy configuration by testing the connection to the proxy server and test host. This method was added in vSphere API 6.7.

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

Invocation Result:
Status of proxy settings.

Operation Errors:
Error - Generic error.

Specified by:

test in interface Proxy

Parameters:

host - A hostname, IPv4 or Ipv6 address.

protocol - Protocol whose proxy is to be tested.

config - Proxy configuration to test.

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

test

public void test(java.lang.String host,
                 java.lang.String protocol,
                 ProxyTypes.Config config,
                 AsyncCallback<ProxyTypes.TestResult> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Proxy

Tests a proxy configuration by testing the connection to the proxy server and test host. This method was added in vSphere API 6.7.

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:
Status of proxy settings.

Operation Errors:
Error - Generic error.

Specified by:

test in interface Proxy

Parameters:

host - A hostname, IPv4 or Ipv6 address.

protocol - Protocol whose proxy is to be tested.

config - Proxy configuration to test.

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

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String protocol,
                ProxyTypes.Config config)

Description copied from interface: Proxy

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

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

Specified by:

set in interface Proxy

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

set

public void set(java.lang.String protocol,
                ProxyTypes.Config config,
                InvocationConfig invocationConfig)

Description copied from interface: Proxy

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

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 Proxy

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String protocol,
                ProxyTypes.Config config,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Proxy

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error.

Specified by:

set in interface Proxy

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

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

set

public void set(java.lang.String protocol,
                ProxyTypes.Config config,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Proxy

Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This method was added in vSphere API 6.7.

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 Proxy

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String protocol)

Description copied from interface: Proxy

Deletes a proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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

Specified by:

delete in interface Proxy

Parameters:

protocol - ID whose proxy is to be deleted.

delete

public void delete(java.lang.String protocol,
                   InvocationConfig invocationConfig)

Description copied from interface: Proxy

Deletes a proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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:

delete in interface Proxy

Parameters:

protocol - ID whose proxy is to be deleted.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String protocol,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Proxy

Deletes a proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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

Operation Errors:
Error - Generic error.

Specified by:

delete in interface Proxy

Parameters:

protocol - ID whose proxy is to be deleted.

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

delete

public void delete(java.lang.String protocol,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Proxy

Deletes a proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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:

delete in interface Proxy

Parameters:

protocol - ID whose proxy is to be deleted.

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

invocationConfig - Configuration for the method invocation.

list

public java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config> list()

Description copied from interface: Proxy

Gets proxy configuration for all configured protocols. This method was added in vSphere API 6.7.

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

Specified by:

list in interface Proxy

Returns:

Proxy configuration for all configured protocols.

list

public java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config> list(InvocationConfig invocationConfig)

Description copied from interface: Proxy

Gets proxy configuration for all configured protocols. This method was added in vSphere API 6.7.

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 Proxy

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Proxy configuration for all configured protocols.

list

public void list(AsyncCallback<java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>> asyncCallback)

Description copied from interface: Proxy

Gets proxy configuration for all configured protocols. This method was added in vSphere API 6.7.

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

Invocation Result:
Proxy configuration for all configured protocols.

Operation Errors:
Error - Generic error.

Specified by:

list in interface Proxy

Parameters:

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

list

public void list(AsyncCallback<java.util.Map<ProxyTypes.Protocol,ProxyTypes.Config>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Proxy

Gets proxy configuration for all configured protocols. This method was added in vSphere API 6.7.

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:
Proxy configuration for all configured protocols.

Operation Errors:
Error - Generic error.

Specified by:

list in interface Proxy

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public ProxyTypes.Config get(java.lang.String protocol)

Description copied from interface: Proxy

Gets the proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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

Specified by:

get in interface Proxy

Parameters:

protocol - The protocol whose proxy configuration is requested.

Returns:

Proxy configuration for a specific protocol.

get

public ProxyTypes.Config get(java.lang.String protocol,
                             InvocationConfig invocationConfig)

Description copied from interface: Proxy

Gets the proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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 Proxy

Parameters:

protocol - The protocol whose proxy configuration is requested.

invocationConfig - Configuration for the method invocation.

Returns:

Proxy configuration for a specific protocol.

get

public void get(java.lang.String protocol,
                AsyncCallback<ProxyTypes.Config> asyncCallback)

Description copied from interface: Proxy

Gets the proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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

Invocation Result:
Proxy configuration for a specific protocol.

Operation Errors:
Error - Generic error.

Specified by:

get in interface Proxy

Parameters:

protocol - The protocol whose proxy configuration is requested.

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

get

public void get(java.lang.String protocol,
                AsyncCallback<ProxyTypes.Config> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Proxy

Gets the proxy configuration for a specific protocol. This method was added in vSphere API 6.7.

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:
Proxy configuration for a specific protocol.

Operation Errors:
Error - Generic error.

Specified by:

get in interface Proxy

Parameters:

protocol - The protocol whose proxy configuration is requested.

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

invocationConfig - Configuration for the method invocation.