Package org.attribyte.api.http

Class RequestBuilder

java.lang.Object

org.attribyte.api.http.RequestBuilder

Direct Known Subclasses:

PatchRequestBuilder, PostRequestBuilder, PutRequestBuilder, RequestBuilderWithParameters

public abstract class RequestBuilder
extends Object

Builds HTTP requests.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	attributes
protected List<Cookie>	cookies
protected final Map<String,Header>	headers
protected final URI	uri

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestBuilder(String uri)	Creates a builder with a parsed URI.
protected	RequestBuilder(URI uri)	Creates a builder.

Method Summary

Modifier and Type	Method	Description
RequestBuilder	addAttribute(String name, Object object)	Adds an attribute.
RequestBuilder	addAttributes(Map<String,Object> attributes)	Adds a map of attributes.
RequestBuilder	addCookie(Cookie cookie)	Adds a cookie.
RequestBuilder	addHeader(String name, String value)	Adds a header.
RequestBuilder	addHeaders(Collection<Header> headers)	Adds a collection of headers.
RequestBuilder	addHeaders(Map<?,?> headerMap)	Adds a map of headers.
abstract Request	create()	Creates the immutable request after all headers, parameters and attributes are added.

Methods inherited from class java.lang.Object

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

Field Details

headers

protected final Map<String,Header> headers

uri

protected final URI uri

attributes

protected Map<String,Object> attributes

cookies

protected List<Cookie> cookies

Constructor Details

RequestBuilder

protected RequestBuilder(String uri)
                  throws org.attribyte.api.InvalidURIException

Creates a builder with a parsed URI.

Parameters:

uri - The URI string.

Throws:

org.attribyte.api.InvalidURIException - if URI is invalid.

RequestBuilder

protected RequestBuilder(URI uri)

Creates a builder.

Parameters:

uri - The URI.

Method Details

create

public abstract Request create()

Creates the immutable request after all headers, parameters and attributes are added.

Returns:

The request.

addHeader

public RequestBuilder addHeader(String name,
 String value)

Adds a header.

Parameters:

name - The header name.

value - The header value.

Returns:

A self-reference.

addHeaders

public RequestBuilder addHeaders(Collection<Header> headers)

Adds a collection of headers.

Parameters:

headers - The headers to add.

Returns:

A self-reference.

addHeaders

public RequestBuilder addHeaders(Map<?,?> headerMap)

Adds a map of headers.

Parameters:

headerMap - The map of headers.

Returns:

A self-reference.

addAttribute

public RequestBuilder addAttribute(String name,
 Object object)

Adds an attribute.

Parameters:

name - The attribute name.

object - The attribute value.

Returns:

A self-reference.

addAttributes

public RequestBuilder addAttributes(Map<String,Object> attributes)

Adds a map of attributes.

Parameters:

attributes - The map of attributes.

Returns:

A self-reference.

addCookie

public RequestBuilder addCookie(Cookie cookie)

Adds a cookie.

Parameters:

cookie - The cookie to add.

Returns:

A self-reference.