org.mule.runtime.http.api.client

Class HttpClientConfiguration.Builder

java.lang.Object

org.mule.runtime.http.api.client.HttpClientConfiguration.Builder

Enclosing class:

HttpClientConfiguration

public static class HttpClientConfiguration.Builder
extends Object

Builder of HttpClientConfigurations. At the very least, a name must be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpClientConfiguration	build()
HttpClientConfiguration.Builder	setClientSocketProperties(TcpClientSocketProperties clientSocketProperties) Optionally defines TCP specific properties like the socket connection timeout, for example, via a TcpClientSocketProperties.
HttpClientConfiguration.Builder	setConnectionIdleTimeout(int connectionIdleTimeout) Defines the number of milliseconds that a connection can remain idle before being closed.
HttpClientConfiguration.Builder	setDecompress(Boolean decompress) Defines whether responses should be decompressed automatically by the HttpClient, false by default.
HttpClientConfiguration.Builder	setMaxConnections(int maxConnections) Defines the maximum number of outbound connections that will be kept open at the same time.
HttpClientConfiguration.Builder	setName(String name) Defines the name of the HttpClient.
HttpClientConfiguration.Builder	setProxyConfig(ProxyConfig proxyConfig) Required when connecting through a proxy, this defines the relevant data to do so using a ProxyConfig.
HttpClientConfiguration.Builder	setResponseBufferSize(int responseBufferSize) Defines the size of the buffer in bytes used to store the HTTP response, the default value is 10KB.
HttpClientConfiguration.Builder	setStreaming(boolean streaming) Defines whether the HTTP response should be streamed, meaning processing will continue as soon as all headers are parsed and the body populated as it arrives.
HttpClientConfiguration.Builder	setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Required exclusively for HTTPS, this defines through a TlsContextFactory all the TLS related data to establish such connections.
HttpClientConfiguration.Builder	setUsePersistentConnections(boolean usePersistentConnections) Defines if connections should be kept after a request is completed or closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setTlsContextFactory

public HttpClientConfiguration.Builder setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Required exclusively for HTTPS, this defines through a TlsContextFactory all the TLS related data to establish such connections. Set to null by default.

Parameters:

tlsContextFactory - a TlsContextFactory with the required data.

Returns:

this builder

setProxyConfig

public HttpClientConfiguration.Builder setProxyConfig(ProxyConfig proxyConfig)

Required when connecting through a proxy, this defines the relevant data to do so using a ProxyConfig. Set to null by default.

Parameters:

proxyConfig - a ProxyConfig specifying the proxy data

Returns:

this builder

setClientSocketProperties

public HttpClientConfiguration.Builder setClientSocketProperties(TcpClientSocketProperties clientSocketProperties)

Optionally defines TCP specific properties like the socket connection timeout, for example, via a TcpClientSocketProperties. Set to null by default, transport default values will be used in that case.

Parameters:

clientSocketProperties - a TcpClientSocketProperties specifying each property

Returns:

this builder

setMaxConnections

public HttpClientConfiguration.Builder setMaxConnections(int maxConnections)

Defines the maximum number of outbound connections that will be kept open at the same time. Unlimited by default.

Parameters:

maxConnections - number of connections to allow

Returns:

this builder

setUsePersistentConnections

public HttpClientConfiguration.Builder setUsePersistentConnections(boolean usePersistentConnections)

Defines if connections should be kept after a request is completed or closed. Default value is true.

Parameters:

usePersistentConnections - boolean specifying the decision

Returns:

this builder

setConnectionIdleTimeout

public HttpClientConfiguration.Builder setConnectionIdleTimeout(int connectionIdleTimeout)

Defines the number of milliseconds that a connection can remain idle before being closed. Only relevant if persistent connections are used, the default value is 30 seconds.

Parameters:

connectionIdleTimeout - timeout value (in milliseconds)

Returns:

this builder

setStreaming

public HttpClientConfiguration.Builder setStreaming(boolean streaming)

Defines whether the HTTP response should be streamed, meaning processing will continue as soon as all headers are parsed and the body populated as it arrives. Default is false.

When streaming is enabled, because of the internal buffer used to hold the arriving body chunks, the response MUST be eventually read or the worker threads handling the chunks will block waiting to allocate them. Likewise, read/write speed differences could cause issues. Buffer size can be customized for these reasons. Additionally, to avoid deadlocks, a hand off to another thread MUST be performed before consuming the response.

Parameters:

streaming - whether or not to enable streaming

Returns:

this builder

setResponseBufferSize

public HttpClientConfiguration.Builder setResponseBufferSize(int responseBufferSize)

Defines the size of the buffer in bytes used to store the HTTP response, the default value is 10KB.

Parameters:

responseBufferSize - buffer size (in bytes)

Returns:

this builder

setName

public HttpClientConfiguration.Builder setName(String name)

Defines the name of the HttpClient. Must be specified.

Parameters:

name - a String representing the prefix

Returns:

this builder

setDecompress

public HttpClientConfiguration.Builder setDecompress(Boolean decompress)

Defines whether responses should be decompressed automatically by the HttpClient, false by default. Note that only GZIP encoding is supported.

Parameters:

decompress - whether or not responses should be decompressed

Returns:

this builder

Since:

1.3

build

public HttpClientConfiguration build()

Returns:

an HttpClientConfiguration as specified.