com.vmware.vapi.protocol

Class ClientConfiguration.Builder

java.lang.Object

com.vmware.vapi.protocol.ClientConfiguration.Builder

Enclosing class:

ClientConfiguration

public static final class ClientConfiguration.Builder
extends java.lang.Object

This is a builder for ClientConfiguration

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(ClientConfiguration config) Create a builder that is preconfigured with the given ClientConfiguration

Method Summary

Modifier and Type	Method and Description
ClientConfiguration	getConfig()
java.util.List<RequestProcessor>	getRequestProcessors()
ClientConfiguration.Builder	setExecutor(java.util.concurrent.Executor executor) Sets the executor the client must use to process requests.
ClientConfiguration.Builder	setRequestProcessors(java.util.List<RequestProcessor> processors)
ClientConfiguration.Builder	setStreamingEnabled(boolean enabled) Sets if streaming (pseudo-push) responses will be requested by the API client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(ClientConfiguration config)

Create a builder that is preconfigured with the given ClientConfiguration

Parameters:

config - can be null

Method Detail

setRequestProcessors

public ClientConfiguration.Builder setRequestProcessors(java.util.List<RequestProcessor> processors)

Parameters:

processors - the request processors that will be used by the client. overrides the previous value. if set no default authentication processors will be automatically added. if set to null or not set at all the default authentication processors will be automatically added.

Returns:

ClientConfiguration.Builder

getRequestProcessors

public java.util.List<RequestProcessor> getRequestProcessors()

Returns:

the current request processor list

setExecutor

public ClientConfiguration.Builder setExecutor(java.util.concurrent.Executor executor)

Sets the executor the client must use to process requests.

Parameters:

executor - executor to be used by the client to process requests.

Returns:

ClientConfiguration.Builder

setStreamingEnabled

public ClientConfiguration.Builder setStreamingEnabled(boolean enabled)

Sets if streaming (pseudo-push) responses will be requested by the API client.

The default value is true to allow generated binding code and newly written code using ApiProvider to consume stream APIs.

If there is client code making direct use of ApiProvider that is not handling MethodResult.getNext() streaming can be disabled to provide backwards compatibility. Turning off streaming will not allow consumption of stream data. The client will receive only the first chunk of stream data or error in such case.

When using generated bindings streaming should be enabled to assure compatibility with new APIs.

Bindings generated with prior versions of the system cannot work with streaming. There may also be other caveats and it is strongly recommended to regenerate the bindings with the latest version instead of switching this compatibility mode.

Parameters:

if - true the client will advertise stream support in HTTP Accept header otherwise the client will not advertise stream support.

Returns:

the current ClientConfiguration.Builder instance.

getConfig

public ClientConfiguration getConfig()

Returns:

immutable ClientConfiguration