Package org.mule.weave.v2.module.http.service

Class HttpClientRequest.Builder

java.lang.Object

org.mule.weave.v2.module.http.service.HttpClientRequest.Builder

Enclosing class:

HttpClientRequest

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

Builder of HttpClientRequests.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpClientRequest.Builder	addHeader(java.lang.String name, java.lang.String value)	Includes a new header to be sent in the desired HttpClientRequest.
HttpClientRequest.Builder	addHeader(HttpClientHeaders.HttpHeader header)	Includes a new header to be sent in the desired HttpClientRequest.
HttpClientRequest.Builder	addHeaders(java.lang.String name, java.util.List<java.lang.String> values)	Includes a new header with multiple values to be sent in the desired HttpClientRequest.
HttpClientRequest.Builder	addQueryParam(java.lang.String name, java.lang.String value)	Includes a new queryParam to be sent in the desired HttpClientRequest.
HttpClientRequest.Builder	addQueryParam(HttpClientQueryParams.HttpQueryParam queryParam)	Includes a new queryParam to be sent in the desired HttpClientRequest.
HttpClientRequest	build()	Creates an instance of HttpClientRequest.
HttpClientRequest.Builder	setBody(java.io.InputStream body)	Includes the HTTP entity that should be used sent in the desired HttpClientRequest.
HttpClientRequest.Builder	setEnableMetrics(boolean enableMetrics)	Set the HTTP request enableMetrics of the HttpClientRequest desired.
HttpClientRequest.Builder	setFollowRedirect(boolean followRedirects)	If HttpClientRequest is to follow redirects.
HttpClientRequest.Builder	setMethod(java.lang.String method)	Set the HTTP method of the HttpClientRequest desired.
HttpClientRequest.Builder	setReadTimeout(int readTimeout)	Set the HTTP request timeout of the HttpClientRequest desired.
HttpClientRequest.Builder	setRequestTimeout(int requestTimeout)	Set the HTTP request timeout of the HttpClientRequest desired.
HttpClientRequest.Builder	setStreamResponse(boolean streamResponse)	Set the HTTP request streamingResponse of the HttpClientRequest desired.
HttpClientRequest.Builder	setUrl(java.lang.String url)	Declares the url where this HttpClientRequest will be sent.

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

setUrl

public HttpClientRequest.Builder setUrl(java.lang.String url)

Declares the url where this HttpClientRequest will be sent. Required configuration.

Parameters:

url - the url of the HttpClientRequest desired.

Returns:

this builder.

setMethod

public HttpClientRequest.Builder setMethod(java.lang.String method)

Set the HTTP method of the HttpClientRequest desired.

Parameters:

method - the HTTP method of the HttpClientRequest desired. Not null.

Returns:

this builder.

addHeader

public HttpClientRequest.Builder addHeader(java.lang.String name,
                                           java.lang.String value)

Includes a new header to be sent in the desired HttpClientRequest.

Parameters:

name - the name of the HTTP header.

value - the value of the HTTP header.

Returns:

this builder.

addHeader

public HttpClientRequest.Builder addHeader(HttpClientHeaders.HttpHeader header)

Includes a new header to be sent in the desired HttpClientRequest.

Parameters:

header - the HttpClientHeaders.HttpHeader that should be used. Not null.

Returns:

this builder.

addHeaders

public HttpClientRequest.Builder addHeaders(java.lang.String name,
                                            java.util.List<java.lang.String> values)

Includes a new header with multiple values to be sent in the desired HttpClientRequest.

Parameters:

name - the name of the HTTP header.

values - the values of the HTTP header.

Returns:

this builder.

addQueryParam

public HttpClientRequest.Builder addQueryParam(java.lang.String name,
                                               java.lang.String value)

Includes a new queryParam to be sent in the desired HttpClientRequest.

Parameters:

name - the name of the HTTP queryParam.

value - the value of the HTTP queryParam.

Returns:

this builder.

addQueryParam

public HttpClientRequest.Builder addQueryParam(HttpClientQueryParams.HttpQueryParam queryParam)

Includes a new queryParam to be sent in the desired HttpClientRequest.

Parameters:

queryParam - the HttpClientQueryParams.HttpQueryParam that should be used. Not null.

Returns:

this builder.

setBody

public HttpClientRequest.Builder setBody(java.io.InputStream body)

Includes the HTTP entity that should be used sent in the desired HttpClientRequest.

Parameters:

body - the InputStream that should be used as body for the HttpClientRequest. Not null.

Returns:

this builder

setFollowRedirect

public HttpClientRequest.Builder setFollowRedirect(boolean followRedirects)

If HttpClientRequest is to follow redirects.

Parameters:

followRedirects - if this request is to follow redirects.

Returns:

this builder.

setReadTimeout

public HttpClientRequest.Builder setReadTimeout(int readTimeout)

Set the HTTP request timeout of the HttpClientRequest desired.

Parameters:

readTimeout - the read timeout.

Returns:

this builder.

setRequestTimeout

public HttpClientRequest.Builder setRequestTimeout(int requestTimeout)

Set the HTTP request timeout of the HttpClientRequest desired.

Parameters:

requestTimeout - the request timeout.

Returns:

this builder.

setStreamResponse

public HttpClientRequest.Builder setStreamResponse(boolean streamResponse)

Set the HTTP request streamingResponse of the HttpClientRequest desired.

Parameters:

streamResponse - if this request response should be streamed.

Returns:

this builder.

setEnableMetrics

public HttpClientRequest.Builder setEnableMetrics(boolean enableMetrics)

Set the HTTP request enableMetrics of the HttpClientRequest desired.

Parameters:

enableMetrics - if this request response should be measured.

Returns:

this builder.

build

public HttpClientRequest build()

Creates an instance of HttpClientRequest.

Returns:

an HttpClientRequest as described.