uk.co.visalia.brightpearl.apiclient.http

Class RequestBuilder

java.lang.Object

uk.co.visalia.brightpearl.apiclient.http.RequestBuilder

public class RequestBuilder
extends Object

A builder used to create immutable Request instances.

Method Summary

Methods

Modifier and Type	Method and Description
Request	build() Constructs the immutable Request instance.
static RequestBuilder	newRequest() Creates a new builder instance.
RequestBuilder	withBody(String body) Add a JSON body to a PUT or POST request.
RequestBuilder	withHeaders(Map<String,String> headers) Sets the map of unencoded headers to be added to the request.
RequestBuilder	withMethod(Method method) Sets the HTTP method of the request.
RequestBuilder	withParameters(Map<String,String> parameters) Sets the map of unencoded querystring parameters to be added to the URL.
RequestBuilder	withUrl(String url) Sets the full URL of the resource.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static RequestBuilder newRequest()

Creates a new builder instance. At minimum, a method and URL must be set.

Returns:

a new builder instance.

build

public Request build()

Constructs the immutable Request instance.

Returns:

a request instance for execution.

withMethod

public RequestBuilder withMethod(Method method)

Sets the HTTP method of the request.

Parameters:

method - HTTP method.

Returns:

builder instance for method chaining.

withUrl

public RequestBuilder withUrl(String url)

Sets the full URL of the resource.

Parameters:

url - full URL excluding querystring parameters.

Returns:

builder instance for method chaining.

withParameters

public RequestBuilder withParameters(Map<String,String> parameters)

Sets the map of unencoded querystring parameters to be added to the URL.

Parameters:

parameters - querystring parameters.

Returns:

builder instance for method chaining.

withHeaders

public RequestBuilder withHeaders(Map<String,String> headers)

Sets the map of unencoded headers to be added to the request.

Parameters:

headers - request headers.

Returns:

builder instance for method chaining.

withBody

public RequestBuilder withBody(String body)

Add a JSON body to a PUT or POST request.

Parameters:

body - JSON request body.

Returns:

builder instance for method chaining.