com.mulesoft.extensions.request.builder

Class RequestBuilder<T>

java.lang.Object

org.mule.runtime.http.api.domain.message.HttpMessageBuilder<RequestBuilder<T>,org.mule.runtime.http.api.domain.message.request.HttpRequest>

com.mulesoft.extensions.request.builder.RequestBuilder<T>

Type Parameters:

T - The type response.

public class RequestBuilder<T>
extends org.mule.runtime.http.api.domain.message.HttpMessageBuilder<RequestBuilder<T>,org.mule.runtime.http.api.domain.message.request.HttpRequest>

Builder class for http requests.
To use the requests do the following:

 // GET request.
 RequestBuilder.get(client, "http://mypath.com/endpoint/action").execute();
 // POST request.
 RequestBuilder.post(client, "http://mypath.com/endpoint/action").execute();
 // PUT request.
 RequestBuilder.put(client, "http://mypath.com/endpoint/action").execute();
 // DELETE request.
 RequestBuilder.delete(client, "http://mypath.com/endpoint/action").execute();
 

The static methods generate an instance of this builder and allow the following:

• Addition of query parameters by using the queryParam(String, Object) or through a MultiMap.
• Addition of path parameters by setting them in the path parameter on the static method and assigning them to a placeholder and then setting them using pathParam(String, Object).
• Setting an entity object to be sent as part of the request using entity(Object) for the object and contentType(String) for the content type (default is APPLICATION_XML).
• Handling the HttpResponse object using a ResponseHandler.
• Setting the response type of the request by using the responseType(Class, Type...)
• Setting headers using header(String, Object).

Author:

gaston.ortiz@mulesoft.com

Field Summary

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

entity, headers

Method Summary

Modifier and Type	Method and Description
RequestBuilder<T>	accept(org.mule.runtime.api.metadata.MediaType accept)
RequestBuilder<T>	accept(String accept)
RequestBuilder<T>	authentication(org.mule.runtime.http.api.client.auth.HttpAuthentication authentication)
RequestBuilder<T>	basicAuthentication(String username, String password)
SimpleRequest	build()
RequestBuilder<T>	contentType(org.mule.runtime.api.metadata.MediaType contentType)
RequestBuilder<T>	contentType(String contentType)
static RequestBuilder<String>	delete(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	delete(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
RequestBuilder<T>	doNotFollowRedirects()
<I> RequestBuilder<T>	entity(I entity, ParsingFunction<I,String> converter)
RequestBuilder<T>	entity(Object entity)
RequestBuilder<T>	entity(String entity)
T	execute()
RequestBuilder<T>	followRedirects()
static RequestBuilder<String>	get(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	get(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
static RequestBuilder<String>	head(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	head(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
RequestBuilder<T>	header(String key, Object value)
RequestBuilder<T>	ntlmAuthentication(String username, String password)
RequestBuilder<T>	ntlmAuthentication(String username, String password, String domain)
RequestBuilder<T>	onBeforeRequest(RequestListener... listeners)
static RequestBuilder<String>	options(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	options(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
static RequestBuilder<String>	patch(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	patch(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
RequestBuilder<T>	pathParam(String key, Object value)
RequestBuilder<T>	pathParams(Map<String,String> pathParams)
static RequestBuilder<String>	post(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	post(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
static RequestBuilder<String>	put(org.mule.runtime.http.api.client.HttpClient client, String path)
static <T> RequestBuilder<T>	put(org.mule.runtime.http.api.client.HttpClient client, String path, ResponseHandler<T> responseHandler)
RequestBuilder<T>	queryParam(String key, Object value)
RequestBuilder<T>	queryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams)
RequestBuilder<T>	responseHandler(ResponseHandler<T> responseHandler)
RequestBuilder<T>	responseType(Class<?> baseType, Type... parameterTypes)
RequestBuilder<T>	responseType(ParameterizedType parameterizedType)
RequestBuilder<T>	timeout(int timeout)

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

responseType

public RequestBuilder<T> responseType(Class<?> baseType,
                                      Type... parameterTypes)

responseType

public RequestBuilder<T> responseType(ParameterizedType parameterizedType)

responseHandler

public RequestBuilder<T> responseHandler(ResponseHandler<T> responseHandler)

header

public RequestBuilder<T> header(String key,
                                Object value)

authentication

public RequestBuilder<T> authentication(org.mule.runtime.http.api.client.auth.HttpAuthentication authentication)

basicAuthentication

public RequestBuilder<T> basicAuthentication(String username,
                                             String password)

ntlmAuthentication

public RequestBuilder<T> ntlmAuthentication(String username,
                                            String password)

ntlmAuthentication

public RequestBuilder<T> ntlmAuthentication(String username,
                                            String password,
                                            String domain)

queryParam

public RequestBuilder<T> queryParam(String key,
                                    Object value)

queryParams

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

pathParam

public RequestBuilder<T> pathParam(String key,
                                   Object value)

pathParams

public RequestBuilder<T> pathParams(Map<String,String> pathParams)

entity

public RequestBuilder<T> entity(Object entity)

entity

public <I> RequestBuilder<T> entity(I entity,
                                    ParsingFunction<I,String> converter)

entity

public RequestBuilder<T> entity(String entity)

followRedirects

public RequestBuilder<T> followRedirects()

doNotFollowRedirects

public RequestBuilder<T> doNotFollowRedirects()

timeout

public RequestBuilder<T> timeout(int timeout)

accept

public RequestBuilder<T> accept(org.mule.runtime.api.metadata.MediaType accept)

accept

public RequestBuilder<T> accept(String accept)

contentType

public RequestBuilder<T> contentType(org.mule.runtime.api.metadata.MediaType contentType)

contentType

public RequestBuilder<T> contentType(String contentType)

onBeforeRequest

public RequestBuilder<T> onBeforeRequest(RequestListener... listeners)

get

public static <T> RequestBuilder<T> get(org.mule.runtime.http.api.client.HttpClient client,
                                        String path,
                                        ResponseHandler<T> responseHandler)

get

public static RequestBuilder<String> get(org.mule.runtime.http.api.client.HttpClient client,
                                         String path)

post

public static <T> RequestBuilder<T> post(org.mule.runtime.http.api.client.HttpClient client,
                                         String path,
                                         ResponseHandler<T> responseHandler)

post

public static RequestBuilder<String> post(org.mule.runtime.http.api.client.HttpClient client,
                                          String path)

put

public static <T> RequestBuilder<T> put(org.mule.runtime.http.api.client.HttpClient client,
                                        String path,
                                        ResponseHandler<T> responseHandler)

put

public static RequestBuilder<String> put(org.mule.runtime.http.api.client.HttpClient client,
                                         String path)

delete

public static <T> RequestBuilder<T> delete(org.mule.runtime.http.api.client.HttpClient client,
                                           String path,
                                           ResponseHandler<T> responseHandler)

delete

public static RequestBuilder<String> delete(org.mule.runtime.http.api.client.HttpClient client,
                                            String path)

patch

public static <T> RequestBuilder<T> patch(org.mule.runtime.http.api.client.HttpClient client,
                                          String path,
                                          ResponseHandler<T> responseHandler)

patch

public static RequestBuilder<String> patch(org.mule.runtime.http.api.client.HttpClient client,
                                           String path)

head

public static <T> RequestBuilder<T> head(org.mule.runtime.http.api.client.HttpClient client,
                                         String path,
                                         ResponseHandler<T> responseHandler)

head

public static RequestBuilder<String> head(org.mule.runtime.http.api.client.HttpClient client,
                                          String path)

options

public static <T> RequestBuilder<T> options(org.mule.runtime.http.api.client.HttpClient client,
                                            String path,
                                            ResponseHandler<T> responseHandler)

options

public static RequestBuilder<String> options(org.mule.runtime.http.api.client.HttpClient client,
                                             String path)

build

public SimpleRequest build()

Specified by:

build in class org.mule.runtime.http.api.domain.message.HttpMessageBuilder<RequestBuilder<T>,org.mule.runtime.http.api.domain.message.request.HttpRequest>

execute

public T execute()
          throws IOException,
                 TimeoutException

Throws:

IOException

TimeoutException