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 uri(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
HttpRequestBuilder	addQueryParam(String name, String value) Includes a new queryParam to be sent in the desired HttpMessage.
HttpRequest	build()
String	getMethod()
MultiMap<String,String>	getQueryParams()
URI	getUri()
HttpRequestBuilder	method(HttpConstants.Method method)
HttpRequestBuilder	method(String method) Allows for using extension methods, as defined in the rfc.
HttpRequestBuilder	queryParams(MultiMap<String,String> queryParams)
HttpRequestBuilder	uri(String uri) Declares the URI where this HttpRequest will be sent.
HttpRequestBuilder	uri(URI uri) Declares the URI where this HttpRequest will be sent.

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

addHeader, addHeaders, entity, getHeaders, getHeaderValue, getHeaderValues, headers, initHeaders, removeHeader

Methods inherited from class java.lang.Object

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

Method Detail

uri

public HttpRequestBuilder uri(String uri)

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

Parameters:

uri - the URI (as a String) of the HttpRequest desired. Non null.

Returns:

this builder

uri

public HttpRequestBuilder uri(URI 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

method

public HttpRequestBuilder method(String method)

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

Parameters:

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

Returns:

this builder

method

public HttpRequestBuilder method(HttpConstants.Method method)

Parameters:

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

Returns:

this builder

queryParams

public HttpRequestBuilder queryParams(MultiMap<String,String> queryParams)

Parameters:

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

Returns:

this builder

addQueryParam

public HttpRequestBuilder addQueryParam(String name,
                                        String value)

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

Parameters:

name - the name of the HTTP queryParam

value - the value of the HTTP queryParam

Returns:

this builder

getUri

public URI getUri()

Returns:

the current URI configured in the builder.

getMethod

public String getMethod()

Returns:

the current HTTP method configured in the builder.

getQueryParams

public MultiMap<String,String> getQueryParams()

Returns:

an immutable version of the current query parameters in the builder.

build

public HttpRequest build()

Specified by:

build in class HttpMessageBuilder<HttpRequestBuilder,HttpRequest>

Returns:

an HttpRequest as described