com.mule.connectors.commons.rest.builder

Class RequestBuilder<T>

java.lang.Object

com.mule.connectors.commons.rest.builder.RequestBuilder<T>

Type Parameters:

T - The type response.

public class RequestBuilder<T>
extends Object

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 MultivaluedMap.
• 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 Response object using a ResponseHandler.
• Setting the response type of the request by using the responseType(Type, Type...)
• Setting headers using header(String, Object).

Author:

gaston.ortiz@mulesoft.com

Method Summary

Modifier and Type	Method and Description
RequestBuilder<T>	accept(String accept)
RequestBuilder<T>	basicAuthorization(String username, String password)
RequestBuilder<T>	contentType(String contentType)
static <T> RequestBuilder<T>	delete(javax.ws.rs.client.Client client, String path)
RequestBuilder<T>	entity(Object entity)
T	execute()
static <T> RequestBuilder<T>	get(javax.ws.rs.client.Client client, String path)
static <T> RequestBuilder<T>	head(javax.ws.rs.client.Client client, String path)
RequestBuilder<T>	header(String key, Object value)
RequestBuilder<T>	onBeforeRequest(RequestListener... listeners)
static <T> RequestBuilder<T>	options(javax.ws.rs.client.Client client, String path)
static <T> RequestBuilder<T>	patch(javax.ws.rs.client.Client client, String path)
RequestBuilder<T>	pathParam(String key, Object value)
static <T> RequestBuilder<T>	post(javax.ws.rs.client.Client client, String path)
static <T> RequestBuilder<T>	put(javax.ws.rs.client.Client client, String path)
RequestBuilder<T>	queryParam(String key, Object value)
RequestBuilder<T>	queryParams(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
RequestBuilder<T>	responseHandler(ResponseHandler<T> responseHandler)
RequestBuilder<T>	responseType(Type rawType, Type... parameterTypes)

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(Type rawType,
                                      Type... parameterTypes)

responseHandler

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

header

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

basicAuthorization

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

queryParam

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

queryParams

public RequestBuilder<T> queryParams(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

pathParam

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

entity

public RequestBuilder<T> entity(Object entity)

accept

public RequestBuilder<T> accept(String accept)

contentType

public RequestBuilder<T> contentType(String contentType)

onBeforeRequest

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

execute

public T execute()

get

public static <T> RequestBuilder<T> get(javax.ws.rs.client.Client client,
                                        String path)

post

public static <T> RequestBuilder<T> post(javax.ws.rs.client.Client client,
                                         String path)

put

public static <T> RequestBuilder<T> put(javax.ws.rs.client.Client client,
                                        String path)

delete

public static <T> RequestBuilder<T> delete(javax.ws.rs.client.Client client,
                                           String path)

patch

public static <T> RequestBuilder<T> patch(javax.ws.rs.client.Client client,
                                          String path)

head

public static <T> RequestBuilder<T> head(javax.ws.rs.client.Client client,
                                         String path)

options

public static <T> RequestBuilder<T> options(javax.ws.rs.client.Client client,
                                            String path)