org.attribyte.api.http

Class FormPostRequestBuilder

java.lang.Object

org.attribyte.api.http.RequestBuilder

org.attribyte.api.http.RequestBuilderWithParameters

org.attribyte.api.http.FormPostRequestBuilder

public class FormPostRequestBuilder
extends RequestBuilderWithParameters

Builds immutable HTTP POST requests with body specified as application/x-www-form-urlencoded parameters.

Parameters in the URI are not parsed.

Constructor Summary

Constructors

Constructor and Description
FormPostRequestBuilder(java.lang.String uri) Creates a POST request builder.
FormPostRequestBuilder(java.net.URI uri) Creates a POST request builder.

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.String value) Adds a parameter.
void	addParameters(java.util.Map<?,?> parameters) Adds a map of parameters.
Request	create() Creates the immutable request after all headers, parameters and attributes are added.
void	setParameter(java.lang.String name, java.lang.String[] values) Adds a multi-valued parameter.

Methods inherited from class org.attribyte.api.http.RequestBuilder

addAttribute, addAttributes, addHeader, addHeaders, addHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

FormPostRequestBuilder

public FormPostRequestBuilder(java.lang.String uri)
                       throws InvalidURIException

Creates a POST request builder.

Parameters:

uri - The URI. If a query string is specified, it is preserved but parameters are ignored.

Throws:

InvalidURIException - if URI is invalid.

FormPostRequestBuilder

public FormPostRequestBuilder(java.net.URI uri)

Creates a POST request builder.

Parameters:

uri - The URI. If a query string is specified, it is preserved but parameters are ignored.

Method Detail

create

public Request create()

Description copied from class: RequestBuilder

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

Specified by:

create in class RequestBuilder

Returns:

The request.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Adds a parameter.

Parameters:

name - The parameter name.

value - The parameter value.

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String[] values)

Adds a multi-valued parameter.

Parameters:

name - The parameter name.

values - The parameter values.

addParameters

public void addParameters(java.util.Map<?,?> parameters)

Adds a map of parameters.

The toString method will be called on map keys to generate parameter names. Map values may be String, String[], Collection<String>.

Parameters:

parameters - The map of parameters.