org.apache.http.client.methods

Class RequestBuilder

java.lang.Object

org.apache.http.client.methods.RequestBuilder

@NotThreadSafe
public class RequestBuilder
extends Object

Builder for HttpUriRequest instances.

Please note that this class treats parameters differently depending on composition of the request: if the request has a content entity explicitly set with setEntity(org.apache.http.HttpEntity) or it is not an entity enclosing method (such as POST or PUT), parameters will be added to the query component of the request URI. Otherwise, parameters will be added as a URL encoded entity.

Since:

4.3

Method Summary

Methods

Modifier and Type	Method and Description
RequestBuilder	addHeader(Header header)
RequestBuilder	addHeader(String name, String value)
RequestBuilder	addParameter(NameValuePair nvp)
RequestBuilder	addParameter(String name, String value)
RequestBuilder	addParameters(NameValuePair... nvps)
HttpUriRequest	build()
static RequestBuilder	copy(HttpRequest request)
static RequestBuilder	create(String method)
static RequestBuilder	delete()
static RequestBuilder	get()
RequestConfig	getConfig()
HttpEntity	getEntity()
Header	getFirstHeader(String name)
Header[]	getHeaders(String name)
Header	getLastHeader(String name)
String	getMethod()
List<NameValuePair>	getParameters()
URI	getUri()
ProtocolVersion	getVersion()
static RequestBuilder	head()
static RequestBuilder	options()
static RequestBuilder	post()
static RequestBuilder	put()
RequestBuilder	removeHeader(Header header)
RequestBuilder	removeHeaders(String name)
RequestBuilder	setConfig(RequestConfig config)
RequestBuilder	setEntity(HttpEntity entity)
RequestBuilder	setHeader(Header header)
RequestBuilder	setHeader(String name, String value)
RequestBuilder	setUri(String uri)
RequestBuilder	setUri(URI uri)
RequestBuilder	setVersion(ProtocolVersion version)
static RequestBuilder	trace()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RequestBuilder create(String method)

get

public static RequestBuilder get()

head

public static RequestBuilder head()

post

public static RequestBuilder post()

put

public static RequestBuilder put()

delete

public static RequestBuilder delete()

trace

public static RequestBuilder trace()

options

public static RequestBuilder options()

copy

public static RequestBuilder copy(HttpRequest request)

getMethod

public String getMethod()

getVersion

public ProtocolVersion getVersion()

setVersion

public RequestBuilder setVersion(ProtocolVersion version)

getUri

public URI getUri()

setUri

public RequestBuilder setUri(URI uri)

setUri

public RequestBuilder setUri(String uri)

getFirstHeader

public Header getFirstHeader(String name)

getLastHeader

public Header getLastHeader(String name)

getHeaders

public Header[] getHeaders(String name)

addHeader

public RequestBuilder addHeader(Header header)

addHeader

public RequestBuilder addHeader(String name,
                       String value)

removeHeader

public RequestBuilder removeHeader(Header header)

removeHeaders

public RequestBuilder removeHeaders(String name)

setHeader

public RequestBuilder setHeader(Header header)

setHeader

public RequestBuilder setHeader(String name,
                       String value)

getEntity

public HttpEntity getEntity()

setEntity

public RequestBuilder setEntity(HttpEntity entity)

getParameters

public List<NameValuePair> getParameters()

addParameter

public RequestBuilder addParameter(NameValuePair nvp)

addParameter

public RequestBuilder addParameter(String name,
                          String value)

addParameters

public RequestBuilder addParameters(NameValuePair... nvps)

getConfig

public RequestConfig getConfig()

setConfig

public RequestBuilder setConfig(RequestConfig config)

build

public HttpUriRequest build()