org.mule.connectors.restconnect.commons.internal.util

Class RestRequestBuilder

java.lang.Object

org.mule.connectors.restconnect.commons.internal.util.RestRequestBuilder

public class RestRequestBuilder
extends Object

Builder of HttpRequests. Handles ignoring null queryParams and Headers by default. Provides the ability of setting a format for query parameter arrays. Handles request streaming mode (Content-Length and Transfer-Encoding headers).

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequestBuilder.QueryParamFormat COMMA: key=value1,value2,value3 MULTIMAP: key=value1&key=value2&key=value3

Constructor Summary

Constructors

Constructor and Description
RestRequestBuilder(String baseUri, String path, org.mule.runtime.http.api.HttpConstants.Method method, RequestParameters requestParameters) Creates a preconfigured RestRequestBuilder per the given parameters.

Method Summary

Modifier and Type	Method and Description
RestRequestBuilder	addHeader(String key, String value) Adds a header to the request builder.
RestRequestBuilder	addHeaders(String key, List<String> values) Adds multiple headers (with the same name) to the request builder.
RestRequestBuilder	addQueryParam(String key, String value) Adds a query parameter to the request builder.
RestRequestBuilder	addQueryParams(String key, List<String> values) Adds multiple query parameters (with the same name) to the request builder.
org.mule.runtime.http.api.domain.message.request.HttpRequest	build()
org.mule.runtime.api.util.MultiMap<String,String>	getHeaders() Returns an immutable map containing the headers configured for this request\
String	getMethod() Returns the HTTP verb to be used in this request
org.mule.runtime.api.util.MultiMap<String,String>	getQueryParams() Returns an immutable map containing the query parameters configured for this request.
String	getUri() Returns the full uri for this request.
RestRequestBuilder	headers(org.mule.runtime.api.util.MultiMap<String,String> headers) Adds all the headers present in a multimap to the request builder.
RestRequestBuilder	queryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams) Adds all the query parameters present in a multimap to the request builder.
RestRequestBuilder	setBody(org.mule.runtime.api.metadata.TypedValue<InputStream> body, StreamingType streamingType) Defines the body and content streaming for this request.
RestRequestBuilder	setQueryParamFormat(RestRequestBuilder.QueryParamFormat queryParamFormat) Defines the format in which the query parameter arrays must be handled by this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRequestBuilder

public RestRequestBuilder(String baseUri,
                          String path,
                          org.mule.runtime.http.api.HttpConstants.Method method,
                          RequestParameters requestParameters)

Creates a preconfigured RestRequestBuilder per the given parameters.

This creates a new RestRequestBuilder and initializes it's URI, method, custom query params and custom headers.

The returned builder can still to add/change additional information.

Parameters:

baseUri - the base uri to be used

path - the path of the resource to request, relative to the base URI

method - the request method

requestParameters - the request parameters

Method Detail

getUri

public String getUri()

Returns the full uri for this request. (Base Uri + Path)

getMethod

public String getMethod()

Returns the HTTP verb to be used in this request

addHeader

public RestRequestBuilder addHeader(String key,
                                    String value)

Adds a header to the request builder. It will only be added if it's value is not null.

Parameters:

key - The header name.

value - The header value.

Returns:

The request builder so it can be used in a fluent way.

addHeaders

public RestRequestBuilder addHeaders(String key,
                                     List<String> values)

Adds multiple headers (with the same name) to the request builder. All values are expected to be not null and will be added using the same key.

Parameters:

key - The header name.

values - The header values.

Returns:

The request builder so it can be used in a fluent way.

headers

public RestRequestBuilder headers(org.mule.runtime.api.util.MultiMap<String,String> headers)

Adds all the headers present in a multimap to the request builder.

Parameters:

headers - The headers to be added to the request builder.

Returns:

The request builder so it can be used in a fluent way.

getHeaders

public org.mule.runtime.api.util.MultiMap<String,String> getHeaders()

Returns an immutable map containing the headers configured for this request\

addQueryParam

public RestRequestBuilder addQueryParam(String key,
                                        String value)

Adds a query parameter to the request builder. It will only be added if it's value is not null.

Parameters:

key - The query parameter name.

value - The query parameter value.

Returns:

The request builder so it can be used in a fluent way.

addQueryParams

public RestRequestBuilder addQueryParams(String key,
                                         List<String> values)

Adds multiple query parameters (with the same name) to the request builder. All values are expected to be not null and will be added using the same key.

Parameters:

key - The query parameter name.

values - The query parameter value.

Returns:

The request builder so it can be used in a fluent way.

queryParams

public RestRequestBuilder queryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams)

Adds all the query parameters present in a multimap to the request builder.

Parameters:

queryParams - The query parameters to be added to the request builder.

Returns:

The request builder so it can be used in a fluent way.

getQueryParams

public org.mule.runtime.api.util.MultiMap<String,String> getQueryParams()

Returns an immutable map containing the query parameters configured for this request.

setQueryParamFormat

public RestRequestBuilder setQueryParamFormat(RestRequestBuilder.QueryParamFormat queryParamFormat)

Defines the format in which the query parameter arrays must be handled by this request.

Parameters:

queryParamFormat - The query parameter array format

Returns:

The request builder so it can be used in a fluent way.

setBody

public RestRequestBuilder setBody(org.mule.runtime.api.metadata.TypedValue<InputStream> body,
                                  StreamingType streamingType)

Defines the body and content streaming for this request.

Parameters:

body - A TypedValue that contains the body to be sent in this request. Nullable.

streamingType - The streaming type that must be used for this request's content.

Returns:

The request builder so it can be used in a fluent way.

build

public org.mule.runtime.http.api.domain.message.request.HttpRequest build()

Returns:

The configured HttpRequest