com.mulesoft.connectivity.rest.commons.internal.util

Class RestRequestBuilder

java.lang.Object

com.mulesoft.connectivity.rest.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.ParameterArrayFormat COMMA: key=value1,value2,value3.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_URI_PARAMETER_ERROR_TEMPLATE
static String	PATH_PARAMETERS_NOT_USED_ERROR_TEMPLATE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RestRequestBuilder	addHeader(String key, Object value) Adds a header to the request builder.
RestRequestBuilder	addQueryParam(String key, Object value) Adds a query parameter to the request builder.
RestRequestBuilder	addUriParam(String placeholderKey, Object value) Adds an uri parameter to the request builder.
org.mule.runtime.http.api.domain.message.request.HttpRequest	build()
void	clearHeaders() Clears the header parameters configured for this request.
void	clearQueryParams() Clears the query parameters configured for this request.
void	clearUriParams() Clears the uri parameters configured for this request.
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.
HttpResponseInterceptorDescriptor	getResponseInterceptorDescriptor()
String	getUri() Returns the full uri for this request.
Map<String,String>	getUriParams() Returns an immutable map containing the uri parameters configured for this request.
RestRequestBuilder	responseInterceptorDescriptor(HttpResponseInterceptorDescriptor httpResponseInterceptorDescriptor) Describes a post process HttpResponseInterceptorDescriptor to intercept and modify server's response before this is mapped to a Result.
RestRequestBuilder	setBody(org.mule.runtime.api.metadata.TypedValue<InputStream> body, StreamingType streamingType) Defines the body and content streaming for this request.
void	setFullUri(String fullUri) Sets a full request URI that overrides the configured baseUri and path.
void	setPath(String path) Sets the path section for the request URI
RestRequestBuilder	setQueryParamFormat(RestRequestBuilder.ParameterArrayFormat 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

Field Detail

PATH_PARAMETERS_NOT_USED_ERROR_TEMPLATE

public static final String PATH_PARAMETERS_NOT_USED_ERROR_TEMPLATE

See Also:

Constant Field Values

NULL_URI_PARAMETER_ERROR_TEMPLATE

public static final String NULL_URI_PARAMETER_ERROR_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

RestRequestBuilder

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

Creates a preconfigured RestRequestBuilder per the given parameters.

This creates a new RestRequestBuilder and initializes its URI and method.

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.

RestRequestBuilder

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

Creates a preconfigured RestRequestBuilder per the given parameters.

This creates a new RestRequestBuilder and initializes its 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.

customParameters - a list of custom request parameters that will always be sent in the final request.

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

addUriParam

public RestRequestBuilder addUriParam(String placeholderKey,
                                      Object value)

Adds an uri parameter to the request builder. It will only be added if it's value is not null. URI parameters will be replaced in the path where a placeholder matches its key. This method will use a best effort approach to convert the Object to a valid String representation. If a specific format is needed, send the value as String.

Parameters:

placeholderKey - The header name.

value - The header value. Will be converted to string.

Returns:

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

addHeader

public RestRequestBuilder addHeader(String key,
                                    Object value)

Adds a header to the request builder. It will only be added if it's value is not null. This method will use a best effort approach to convert the Object to a valid String representation. If a specific format is needed, send the value as String.

Parameters:

key - The header name.

value - The header value. Will be converted to string.

Returns:

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

addQueryParam

public RestRequestBuilder addQueryParam(String key,
                                        Object value)

Adds a query parameter to the request builder. It will only be added if it's value is not null. This method will use a best effort approach to convert the Object to a valid String representation. If a specific format is needed, send the value as String.

Parameters:

key - The query parameter name.

value - The query parameter value. Will be converted to string.

Returns:

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

clearUriParams

public void clearUriParams()

Clears the uri parameters configured for this request.

clearQueryParams

public void clearQueryParams()

Clears the query parameters configured for this request.

clearHeaders

public void clearHeaders()

Clears the header parameters configured for this request.

getUriParams

public Map<String,String> getUriParams()

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

getQueryParams

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

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

getHeaders

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

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

setQueryParamFormat

public RestRequestBuilder setQueryParamFormat(RestRequestBuilder.ParameterArrayFormat 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.

responseInterceptorDescriptor

public RestRequestBuilder responseInterceptorDescriptor(HttpResponseInterceptorDescriptor httpResponseInterceptorDescriptor)

Describes a post process HttpResponseInterceptorDescriptor to intercept and modify server's response before this is mapped to a Result.

Parameters:

httpResponseInterceptorDescriptor - A HttpResponseInterceptorDescriptor to describe how to intercept server's response.

Returns:

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

getResponseInterceptorDescriptor

public HttpResponseInterceptorDescriptor getResponseInterceptorDescriptor()

Returns:

a post process HttpResponseInterceptorDescriptor to intercept and modify server's response before this is mapped to a Result.

build

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

Returns:

The configured HttpRequest

setPath

public void setPath(String path)

Sets the path section for the request URI

Parameters:

path - the path of the request.

setFullUri

public void setFullUri(String fullUri)

Sets a full request URI that overrides the configured baseUri and path.

Parameters:

fullUri - to be set as the request URI