com.vmware.vapi.protocol

Class HttpConfiguration.Builder

java.lang.Object

com.vmware.vapi.protocol.HttpConfiguration.Builder

Enclosing class:

HttpConfiguration

public static final class HttpConfiguration.Builder
extends Object

Builder class for the HttpConfiguration

Constructor Summary

Constructors

Constructor and Description
HttpConfiguration.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
HttpConfiguration	getConfig()
HttpConfiguration.Builder	setIoThreadCount(int ioThreadCount) Defines the number of I/O dispatch threads to be used by the I/O reactor of the third-party HTTP library.
HttpConfiguration.Builder	setKeepAlivePeriod(long keepAlivePeriod) Sets the maximum time a connection is allowed to be kept alive.
HttpConfiguration.Builder	setLibraryType(HttpConfiguration.LibType libraryType) Sets the type of the HTTP library.
HttpConfiguration.Builder	setMaxConnections(int maxConnections) Sets the maximum number of outstanding TCP connections.
HttpConfiguration.Builder	setSoTimeout(int soTimeout) Sets the amount of time the client should wait for a response before timing out.
HttpConfiguration.Builder	setSslConfiguration(HttpConfiguration.SslConfiguration sslConfig) Sets the SSL configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpConfiguration.Builder

public HttpConfiguration.Builder()

Method Detail

setLibraryType

public HttpConfiguration.Builder setLibraryType(HttpConfiguration.LibType libraryType)

Sets the type of the HTTP library.

Parameters:

libraryType - HTTP library flavor; default is HttpConfiguration.LibType.APACHE_HTTP_CLIENT; must not be null

Returns:

this instance

setSslConfiguration

public HttpConfiguration.Builder setSslConfiguration(HttpConfiguration.SslConfiguration sslConfig)

Sets the SSL configuration

Parameters:

sslConfig -

Returns:

this instance

setIoThreadCount

public HttpConfiguration.Builder setIoThreadCount(int ioThreadCount)

Defines the number of I/O dispatch threads to be used by the I/O reactor of the third-party HTTP library. Applies only to the following libraries: HttpConfiguration.LibType.APACHE_HTTP_ASYNC_CLIENT.

Parameters:

ioThreadCount - number of I/O threads; defaults to the count of the processors on the machine; must be larger than zero

Returns:

this instance

setSoTimeout

public HttpConfiguration.Builder setSoTimeout(int soTimeout)

Sets the amount of time the client should wait for a response before timing out.

Parameters:

soTimeout - time in milliseconds; zero timeout means wait forever; default is zero; must not be negative

Returns:

this instance

setMaxConnections

public HttpConfiguration.Builder setMaxConnections(int maxConnections)

Sets the maximum number of outstanding TCP connections.

Parameters:

maxConnections - maximum number of connections; must be positive; default is 20

Returns:

this instance

setKeepAlivePeriod

public HttpConfiguration.Builder setKeepAlivePeriod(long keepAlivePeriod)

Sets the maximum time a connection is allowed to be kept alive. A pooled (kept alive after finished reading a HTTP response) connection that was idle for more than the specified period will be discarded and closed (not reused anymore).

Non-positive value for this setting means that the connection can be kept alive indefinitely.

This value MUST be lower than max idle time in the server.

Default value is 45 seconds.

Parameters:

keepAlivePeriod - the time period in milliseconds.

Returns:

getConfig

public HttpConfiguration getConfig()

Returns:

immutable HttpConfiguration

Throws:

IllegalStateException - if the combination of settings is invalid