org.mule.module.http.api.requester

Class HttpRequesterConfigBuilder

java.lang.Object

org.mule.module.http.api.requester.HttpRequesterConfigBuilder

public class HttpRequesterConfigBuilder
extends Object

Builder for creating http request configs pragmatically. HttpRequesterConfig created by the builder will be initialized. The lifecycle of the created object must be managed by the client of this class.

Constructor Summary

Constructors

Constructor and Description
HttpRequesterConfigBuilder(MuleContext muleContext)

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequesterConfig	build() Builder the request config and initializes it.
HttpRequesterConfigBuilder	setAuthentication(HttpAuthentication authentication) To create instances of HttpAuthentication use BasicAuthenticationBuilder
HttpRequesterConfigBuilder	setConnectionIdleTimeout(int connectionIdleTimeout)
HttpRequesterConfigBuilder	setHostExpression(String host)
HttpRequesterConfigBuilder	setMaxConnections(int maxConnections)
HttpRequesterConfigBuilder	setParseResponse(boolean parseResponse)
HttpRequesterConfigBuilder	setParseResponseExpression(String parseResponse)
HttpRequesterConfigBuilder	setPort(int port)
HttpRequesterConfigBuilder	setPortExpression(String port)
HttpRequesterConfigBuilder	setProtocol(HttpConstants.Protocols protocol)
HttpRequesterConfigBuilder	setProxyConfig(ProxyConfig proxyConfig) To create instances of ProxyConfig use NtlmProxyConfigBuilder or ProxyConfigBuilder
HttpRequesterConfigBuilder	setRequestStreamingMode(HttpStreamingType requestStreamingMode)
HttpRequesterConfigBuilder	setRequestStreamingModeExpression(String requestStreamingMode)
HttpRequesterConfigBuilder	setResponseTimeout(int responseTimeout)
HttpRequesterConfigBuilder	setResponseTimeoutExpression(String responseTimeoutExpression)
HttpRequesterConfigBuilder	setSendBodyMode(HttpSendBodyMode sendBodyMode)
HttpRequesterConfigBuilder	setSendBodyModeExpression(String sendBodyMode)
HttpRequesterConfigBuilder	setTlsContext(TlsContextFactory tlsContext) To create instance of TlsContextFactory use TlsContextFactoryBuilder
HttpRequesterConfigBuilder	setUsePersistentConnections(boolean usePersistentConnections)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequesterConfigBuilder

public HttpRequesterConfigBuilder(MuleContext muleContext)

Method Detail

setAuthentication

public HttpRequesterConfigBuilder setAuthentication(HttpAuthentication authentication)

To create instances of HttpAuthentication use BasicAuthenticationBuilder

Parameters:

authentication - authentication configuration to use for requests.

Returns:

the builder

setTlsContext

public HttpRequesterConfigBuilder setTlsContext(TlsContextFactory tlsContext)

To create instance of TlsContextFactory use TlsContextFactoryBuilder

Parameters:

tlsContext - tls configuration for HTTPS connections

Returns:

the builder

setProxyConfig

public HttpRequesterConfigBuilder setProxyConfig(ProxyConfig proxyConfig)

To create instances of ProxyConfig use NtlmProxyConfigBuilder or ProxyConfigBuilder

Parameters:

proxyConfig - proxy configuration for outgoing HTTP request

Returns:

the builder

setResponseTimeout

public HttpRequesterConfigBuilder setResponseTimeout(int responseTimeout)

Parameters:

responseTimeout - maximum time to wait for a response

Returns:

the builder

setMaxConnections

public HttpRequesterConfigBuilder setMaxConnections(int maxConnections)

Parameters:

maxConnections - the maximum number of outgoing connections opened

Returns:

the builder

setUsePersistentConnections

public HttpRequesterConfigBuilder setUsePersistentConnections(boolean usePersistentConnections)

Parameters:

usePersistentConnections - true to reuse a connection for several request, false to discard a connection after the first request.

Returns:

the builder

setConnectionIdleTimeout

public HttpRequesterConfigBuilder setConnectionIdleTimeout(int connectionIdleTimeout)

Parameters:

connectionIdleTimeout - maximum time a connection will be left open while it's not being used.

Returns:

the builder

setProtocol

public HttpRequesterConfigBuilder setProtocol(HttpConstants.Protocols protocol)

Parameters:

protocol - protocol to use, HTTP or HTTPS. Needs to be HTTPS to establish HTTPS connections

Returns:

the builder

setHostExpression

public HttpRequesterConfigBuilder setHostExpression(String host)

Parameters:

host - the default host to connect to. It may be an expression

Returns:

the builder

setPortExpression

public HttpRequesterConfigBuilder setPortExpression(String port)

Parameters:

port - the default port to connect to.

Returns:

the builder

setPort

public HttpRequesterConfigBuilder setPort(int port)

Parameters:

port - expression that resolves to the port to connect to.

Returns:

the builder

setResponseTimeoutExpression

public HttpRequesterConfigBuilder setResponseTimeoutExpression(String responseTimeoutExpression)

Parameters:

responseTimeoutExpression - maximum time to wait for a response

Returns:

the builder

setParseResponse

public HttpRequesterConfigBuilder setParseResponse(boolean parseResponse)

Parameters:

parseResponse - true if the requester should parse the response or false if the response should be set plain as the payload

Returns:

the builder

setParseResponseExpression

public HttpRequesterConfigBuilder setParseResponseExpression(String parseResponse)

Parameters:

parseResponse - an expression that resolves to true if the requester should parse the response or false if the response should be set plain as the payload

Returns:

the builder

setSendBodyMode

public HttpRequesterConfigBuilder setSendBodyMode(HttpSendBodyMode sendBodyMode)

Parameters:

sendBodyMode - HttpSendBodyMode.ALWAYS if not matter the HTTP method the payload should be sent as the request body HttpSendBodyMode.NEVER if not matter the HTTP method the payload never should be sent as the request body HttpSendBodyMode.AUTO if the payload will be sent as the request body based on the HTTP request method.

Returns:

the builder

setSendBodyModeExpression

public HttpRequesterConfigBuilder setSendBodyModeExpression(String sendBodyMode)

Parameters:

sendBodyMode - an expression that resolves: HttpSendBodyMode.ALWAYS if not matter the HTTP method the payload should be sent as the request body HttpSendBodyMode.NEVER if not matter the HTTP method the payload never should be sent as the request body HttpSendBodyMode.AUTO if the payload will be sent as the request body based on the HTTP request method.

Returns:

the builder

setRequestStreamingMode

public HttpRequesterConfigBuilder setRequestStreamingMode(HttpStreamingType requestStreamingMode)

Parameters:

requestStreamingMode - HttpStreamingType.ALWAYS if the request always will be sent using Transfer-Encoding: chunked HttpStreamingType.NEVER if the request never will be sent using Transfer-Encoding: chunked HttpStreamingType.AUTO if the request will be sent using Transfer-Encoding: chunked based on the payload content. If the payload is an stream then it will be sent using Transfer-Encoding: chunked

Returns:

setRequestStreamingModeExpression

public HttpRequesterConfigBuilder setRequestStreamingModeExpression(String requestStreamingMode)

Parameters:

requestStreamingMode - an expression that resovles to: HttpStreamingType.ALWAYS if the request always will be sent using Transfer-Encoding: chunked HttpStreamingType.NEVER if the request never will be sent using Transfer-Encoding: chunked HttpStreamingType.AUTO if the request will be sent using Transfer-Encoding: chunked based on the payload content. If the payload is an stream then it will be sent using Transfer-Encoding: chunked

Returns:

build

public HttpRequesterConfig build()
                          throws MuleException

Builder the request config and initializes it.

Returns:

an HttpRequesterConfig created with the provided configuration.

Throws:

MuleException