org.apache.http.client.methods
Class RequestBuilder

java.lang.Object
  extended by org.apache.http.client.methods.RequestBuilder

@NotThreadSafe
public class RequestBuilder
extends java.lang.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
 RequestBuilder addHeader(org.apache.http.Header header)
           
 RequestBuilder addHeader(java.lang.String name, java.lang.String value)
           
 RequestBuilder addParameter(org.apache.http.NameValuePair nvp)
           
 RequestBuilder addParameter(java.lang.String name, java.lang.String value)
           
 RequestBuilder addParameters(org.apache.http.NameValuePair... nvps)
           
 org.apache.http.client.methods.HttpUriRequest build()
           
static RequestBuilder copy(org.apache.http.HttpRequest request)
           
static RequestBuilder create(java.lang.String method)
           
static RequestBuilder delete()
           
static RequestBuilder get()
           
 RequestConfig getConfig()
           
 org.apache.http.HttpEntity getEntity()
           
 org.apache.http.Header getFirstHeader(java.lang.String name)
           
 org.apache.http.Header[] getHeaders(java.lang.String name)
           
 org.apache.http.Header getLastHeader(java.lang.String name)
           
 java.lang.String getMethod()
           
 java.util.List<org.apache.http.NameValuePair> getParameters()
           
 java.net.URI getUri()
           
 org.apache.http.ProtocolVersion getVersion()
           
static RequestBuilder head()
           
static RequestBuilder options()
           
static RequestBuilder post()
           
static RequestBuilder put()
           
 RequestBuilder removeHeader(org.apache.http.Header header)
           
 RequestBuilder removeHeaders(java.lang.String name)
           
 RequestBuilder setConfig(RequestConfig config)
           
 RequestBuilder setEntity(org.apache.http.HttpEntity entity)
           
 RequestBuilder setHeader(org.apache.http.Header header)
           
 RequestBuilder setHeader(java.lang.String name, java.lang.String value)
           
 RequestBuilder setUri(java.lang.String uri)
           
 RequestBuilder setUri(java.net.URI uri)
           
 RequestBuilder setVersion(org.apache.http.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(java.lang.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(org.apache.http.HttpRequest request)

getMethod

public java.lang.String getMethod()

getVersion

public org.apache.http.ProtocolVersion getVersion()

setVersion

public RequestBuilder setVersion(org.apache.http.ProtocolVersion version)

getUri

public java.net.URI getUri()

setUri

public RequestBuilder setUri(java.net.URI uri)

setUri

public RequestBuilder setUri(java.lang.String uri)

getFirstHeader

public org.apache.http.Header getFirstHeader(java.lang.String name)

getLastHeader

public org.apache.http.Header getLastHeader(java.lang.String name)

getHeaders

public org.apache.http.Header[] getHeaders(java.lang.String name)

addHeader

public RequestBuilder addHeader(org.apache.http.Header header)

addHeader

public RequestBuilder addHeader(java.lang.String name,
                                java.lang.String value)

removeHeader

public RequestBuilder removeHeader(org.apache.http.Header header)

removeHeaders

public RequestBuilder removeHeaders(java.lang.String name)

setHeader

public RequestBuilder setHeader(org.apache.http.Header header)

setHeader

public RequestBuilder setHeader(java.lang.String name,
                                java.lang.String value)

getEntity

public org.apache.http.HttpEntity getEntity()

setEntity

public RequestBuilder setEntity(org.apache.http.HttpEntity entity)

getParameters

public java.util.List<org.apache.http.NameValuePair> getParameters()

addParameter

public RequestBuilder addParameter(org.apache.http.NameValuePair nvp)

addParameter

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

addParameters

public RequestBuilder addParameters(org.apache.http.NameValuePair... nvps)

getConfig

public RequestConfig getConfig()

setConfig

public RequestBuilder setConfig(RequestConfig config)

build

public org.apache.http.client.methods.HttpUriRequest build()