com.vmware.appliance.networking

Interface Proxy

All Superinterfaces:

ProxyTypes, Service

All Known Implementing Classes:

ProxyStub

public interface Proxy
extends Service, ProxyTypes

The Proxy interface provides methods Proxy configuration. This interface was added in vSphere API 6.7.

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 interface com.vmware.appliance.networking.ProxyTypes

_VAPI_SERVICE_ID

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.

Method Detail

test

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. This method was added in vSphere API 6.7.

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

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.

Throws:

Error - Generic error.

test

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

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.

Throws:

Error - Generic error.

test

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

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

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

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

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

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.

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

Throws:

Error - Generic error.

set

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

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.

Parameters:

protocol - The protocol for which proxy should be set.

config - Proxy configuration for the specific protocol.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error.

set

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

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.

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

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

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

void delete(java.lang.String protocol)

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.

Parameters:

protocol - ID whose proxy is to be deleted.

Throws:

Error - Generic error.

delete

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

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.

Parameters:

protocol - ID whose proxy is to be deleted.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error.

delete

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

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.

Parameters:

protocol - ID whose proxy is to be deleted.

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

delete

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

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.

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

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

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.

Returns:

Proxy configuration for all configured protocols.

Throws:

Error - Generic error.

list

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Proxy configuration for all configured protocols.

Throws:

Error - Generic error.

list

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

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.

Parameters:

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

list

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

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

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

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.

Parameters:

protocol - The protocol whose proxy configuration is requested.

Returns:

Proxy configuration for a specific protocol.

Throws:

Error - Generic error.

get

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

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.

Parameters:

protocol - The protocol whose proxy configuration is requested.

invocationConfig - Configuration for the method invocation.

Returns:

Proxy configuration for a specific protocol.

Throws:

Error - Generic error.

get

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

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.

Parameters:

protocol - The protocol whose proxy configuration is requested.

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

get

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

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.

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.