com.vmware.vapi.protocol

Class HttpConfiguration

java.lang.Object

com.vmware.vapi.protocol.HttpConfiguration

public final class HttpConfiguration
extends java.lang.Object

This class is used for configuring the HTTP client that is used by the runtime client. The class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpConfiguration.BasicHeader A basic implementation of HttpConfiguration.Header.
static class	HttpConfiguration.Builder Builder class for the HttpConfiguration.
static interface	HttpConfiguration.Header Represents an HTTP header field.
static interface	HttpConfiguration.HeadersProvider Callback for supplying HTTP headers per request.
static class	HttpConfiguration.KeyStoreConfig This class contains the client certificates configuration.
static class	HttpConfiguration.LibType Type of the third-party HTTP library which would be used by the transport implementation.
static class	HttpConfiguration.Protocol Enumerates the wire protocols supported by the vAPI client for invoking APIs.
static class	HttpConfiguration.ProxyConfiguration Class contains client proxy configuration.
static class	HttpConfiguration.SslConfiguration This class contains the SSL configuration.

Method Summary

Modifier and Type	Method and Description
int	getConnectTimeout()
HttpConfiguration.HeadersProvider	getHeadersProvider()
int	getIoThreadCount()
long	getKeepAlivePeriod() Maximum keep alive period for pooled/idle TCP connections.
HttpConfiguration.LibType	getLibraryType()
int	getMaxConnections()
int	getMaxResponseSize()
HttpConfiguration.Protocol	getProtocol()
HttpConfiguration.ProxyConfiguration	getProxyConfiguration()
int	getSoTimeout()
HttpConfiguration.SslConfiguration	getSslConfiguration()

Methods inherited from class java.lang.Object

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

Method Detail

getLibraryType

public HttpConfiguration.LibType getLibraryType()

Returns:

the type of the HTTP library; cannot be null

getSslConfiguration

public HttpConfiguration.SslConfiguration getSslConfiguration()

Returns:

the SSL configuration; cannot be null

getIoThreadCount

public int getIoThreadCount()

Returns:

the number of I/O dispatch threads to be used by the I/O reactor

getConnectTimeout

public int getConnectTimeout()

Returns:

the amount of time in milliseconds the client is going to wait for establishing the connection

getSoTimeout

public int getSoTimeout()

Returns:

the amount of time in milliseconds the client is going to wait for a response before timing out

getMaxConnections

public int getMaxConnections()

Returns:

the maximum number of outstanding TCP connections

getMaxResponseSize

public int getMaxResponseSize()

Returns:

The effective maximum allowed size of the response content in bytes

See Also:

Builder#setMaxResponseSize(int)}

getKeepAlivePeriod

public long getKeepAlivePeriod()

Maximum keep alive period for pooled/idle TCP connections. This value MUST be lower than max idle time in the server.

Returns:

the maximum keep alive period for pooled/idle TCP connections

getHeadersProvider

public HttpConfiguration.HeadersProvider getHeadersProvider()

Returns:

the callback instance for adding headers to all requests; may be null

getProtocol

public HttpConfiguration.Protocol getProtocol()

Returns:

vAPI protocol; cannot be null

getProxyConfiguration

public HttpConfiguration.ProxyConfiguration getProxyConfiguration()

Returns:

a ProxyConfiguration instance; may be null.