org.mule.runtime.http.api.domain.message.request

Class HttpRequestBuilder

java.lang.Object

org.mule.runtime.http.api.domain.message.HttpMessageBuilder<HttpRequestBuilder,HttpRequest>

org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder

public final class HttpRequestBuilder
extends HttpMessageBuilder<HttpRequestBuilder,HttpRequest>

Builder of HttpRequests. Instances can only be obtained using HttpRequest.builder(). At the very least, the request URI needs to be provided via setUri(String). By default, GET is used as method with empty headers, query params and entity.

Since:

4.0

Field Summary

Fields inherited from class org.mule.runtime.http.api.domain.message.HttpMessageBuilder

entity, headers

Method Summary

Modifier and Type	Method and Description
HttpRequest	build()
HttpRequestBuilder	setHeaders(ParameterMap headersMap)
HttpRequestBuilder	setMethod(HttpConstants.Method method)
HttpRequestBuilder	setMethod(String method) Allows for using extension methods, as defined in the rfc.
HttpRequestBuilder	setQueryParams(ParameterMap queryParams)
HttpRequestBuilder	setUri(String uri) Declares the URI where this HttpRequest will be sent.

Methods inherited from class org.mule.runtime.http.api.domain.message.HttpMessageBuilder

addHeader, getHeaderValue, getHeaderValues, removeHeader, setEntity

Methods inherited from class java.lang.Object

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

Method Detail

setUri

public HttpRequestBuilder setUri(String uri)

Declares the URI where this HttpRequest will be sent. Minimum required configuration.

Parameters:

uri - the URI of the HttpRequest desired. Non null.

Returns:

this builder

setMethod

public HttpRequestBuilder setMethod(String method)

Allows for using extension methods, as defined in the rfc. In general, #setMethod(Method) should be used.

Parameters:

method - the HTTP method of the HttpRequest desired. Non null.

Returns:

this builder

setMethod

public HttpRequestBuilder setMethod(HttpConstants.Method method)

Parameters:

method - the HTTP method of the HttpRequest desired. Non null.

Returns:

this builder

setHeaders

public HttpRequestBuilder setHeaders(ParameterMap headersMap)

Parameters:

headersMap - a ParameterMap representing the HTTP headers of the HttpRequest desired. Non null.

Returns:

this builder

setQueryParams

public HttpRequestBuilder setQueryParams(ParameterMap queryParams)

Parameters:

queryParams - a ParameterMap representing the HTTP query params of the HttpRequest desired. Non null.

Returns:

this builder

build

public HttpRequest build()

Specified by:

build in class HttpMessageBuilder<HttpRequestBuilder,HttpRequest>

Returns:

an HttpRequest as described