Top Description Inners Fields Constructors Methods
org.apache.http.client.methods

public Class RequestBuilder

extends Object
Class Inheritance
Imports
java.io.IOException, java.net.URI, .URISyntaxException, java.nio.charset.Charset, java.util.ArrayList, .LinkedList, .List, org.apache.http.Consts, .Header, .HeaderIterator, .HttpEntity, .HttpEntityEnclosingRequest, .HttpRequest, .NameValuePair, .ProtocolVersion, org.apache.http.client.config.RequestConfig, org.apache.http.client.entity.UrlEncodedFormEntity, org.apache.http.client.utils.URIBuilder, .URLEncodedUtils, org.apache.http.entity.ContentType, org.apache.http.message.BasicHeader, .BasicNameValuePair, .HeaderGroup, org.apache.http.protocol.HTTP, org.apache.http.util.Args
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

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
RequestBuilder.InternalEntityEclosingRequest

Deprecated as a consequence of HttpEntityEnclosingRequestBase being deprecated.
pack-priv static class
RequestBuilder.InternalRequest

Deprecated as a consequence of HttpRequestBase being deprecated.

Field Summary

Modifier and TypeField and Description
private Charset
charset

private RequestConfig
config

private HttpEntity
entity

private HeaderGroup
headerGroup

private String
method

private List<NameValuePair>
parameters

private URI
uri

private ProtocolVersion
version

Constructor Summary

AccessConstructor and Description
pack-priv
RequestBuilder(final String method)

pack-priv
RequestBuilder(final String method, final URI uri)

pack-priv
RequestBuilder(final String method, final String uri)

pack-priv
RequestBuilder()

Method Summary

Modifier and TypeMethod and Description
public RequestBuilder
addHeader(final Header header)

public RequestBuilder
addHeader(final String name, final String value)

public RequestBuilder
addParameter(final NameValuePair nvp)

public RequestBuilder
addParameter(final String name, final String value)

public RequestBuilder
addParameters(final NameValuePair... nvps)

public HttpUriRequest
build()

public static RequestBuilder
copy(final HttpRequest request)

public static RequestBuilder
create(final String method)

public static RequestBuilder
delete()

public static RequestBuilder
delete(final URI uri)

public static RequestBuilder
delete(final String uri)

private RequestBuilder
doCopy(final HttpRequest request)

public static RequestBuilder
get()

public static RequestBuilder
get(final URI uri)

public static RequestBuilder
get(final String uri)

public Charset
getCharset()

public RequestConfig
getConfig()

public HttpEntity
getEntity()

public Header
getFirstHeader(final String name)

public Header[]
getHeaders(final String name)

public Header
getLastHeader(final String name)

public String
getMethod()

public List<NameValuePair>
getParameters()

public URI
getUri()

public ProtocolVersion
getVersion()

public static RequestBuilder
head()

public static RequestBuilder
head(final URI uri)

public static RequestBuilder
head(final String uri)

public static RequestBuilder
options()

public static RequestBuilder
options(final URI uri)

public static RequestBuilder
options(final String uri)

public static RequestBuilder
patch()

public static RequestBuilder
patch(final URI uri)

public static RequestBuilder
patch(final String uri)

public static RequestBuilder
post()

public static RequestBuilder
post(final URI uri)

public static RequestBuilder
post(final String uri)

public static RequestBuilder
put()

public static RequestBuilder
put(final URI uri)

public static RequestBuilder
put(final String uri)

public RequestBuilder
removeHeader(final Header header)

public RequestBuilder
removeHeaders(final String name)

public RequestBuilder
setCharset(final Charset charset)

public RequestBuilder
setConfig(final RequestConfig config)

public RequestBuilder
setEntity(final HttpEntity entity)

public RequestBuilder
setHeader(final Header header)

public RequestBuilder
setHeader(final String name, final String value)

public RequestBuilder
setUri(final URI uri)

public RequestBuilder
setUri(final String uri)

public RequestBuilder
setVersion(final ProtocolVersion version)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public static RequestBuilder
trace()

public static RequestBuilder
trace(final URI uri)

public static RequestBuilder
trace(final String uri)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

charsetback to summary
private Charset charset
configback to summary
private RequestConfig config
entityback to summary
private HttpEntity entity
headerGroupback to summary
private HeaderGroup headerGroup
methodback to summary
private String method
parametersback to summary
private List<NameValuePair> parameters
uriback to summary
private URI uri
versionback to summary
private ProtocolVersion version

Constructor Detail

RequestBuilderback to summary
pack-priv RequestBuilder(final String method)
RequestBuilderback to summary
pack-priv RequestBuilder(final String method, final URI uri)
RequestBuilderback to summary
pack-priv RequestBuilder(final String method, final String uri)
RequestBuilderback to summary
pack-priv RequestBuilder()

Method Detail

addHeaderback to summary
public RequestBuilder addHeader(final Header header)
addHeaderback to summary
public RequestBuilder addHeader(final String name, final String value)
addParameterback to summary
public RequestBuilder addParameter(final NameValuePair nvp)
addParameterback to summary
public RequestBuilder addParameter(final String name, final String value)
addParametersback to summary
public RequestBuilder addParameters(final NameValuePair... nvps)
buildback to summary
public HttpUriRequest build()
copyback to summary
public static RequestBuilder copy(final HttpRequest request)
createback to summary
public static RequestBuilder create(final String method)
deleteback to summary
public static RequestBuilder delete()
deleteback to summary
public static RequestBuilder delete(final URI uri)
Since
4.4
deleteback to summary
public static RequestBuilder delete(final String uri)
Since
4.4
doCopyback to summary
private RequestBuilder doCopy(final HttpRequest request)
getback to summary
public static RequestBuilder get()
getback to summary
public static RequestBuilder get(final URI uri)
Since
4.4
getback to summary
public static RequestBuilder get(final String uri)
Since
4.4
getCharsetback to summary
public Charset getCharset()
Since
4.4
getConfigback to summary
public RequestConfig getConfig()
getEntityback to summary
public HttpEntity getEntity()
getFirstHeaderback to summary
public Header getFirstHeader(final String name)
getHeadersback to summary
public Header[] getHeaders(final String name)
getLastHeaderback to summary
public Header getLastHeader(final String name)
getMethodback to summary
public String getMethod()
getParametersback to summary
public List<NameValuePair> getParameters()
getUriback to summary
public URI getUri()
getVersionback to summary
public ProtocolVersion getVersion()
headback to summary
public static RequestBuilder head()
headback to summary
public static RequestBuilder head(final URI uri)
Since
4.4
headback to summary
public static RequestBuilder head(final String uri)
Since
4.4
optionsback to summary
public static RequestBuilder options()
optionsback to summary
public static RequestBuilder options(final URI uri)
Since
4.4
optionsback to summary
public static RequestBuilder options(final String uri)
Since
4.4
patchback to summary
public static RequestBuilder patch()
Since
4.4
patchback to summary
public static RequestBuilder patch(final URI uri)
Since
4.4
patchback to summary
public static RequestBuilder patch(final String uri)
Since
4.4
postback to summary
public static RequestBuilder post()
postback to summary
public static RequestBuilder post(final URI uri)
Since
4.4
postback to summary
public static RequestBuilder post(final String uri)
Since
4.4
putback to summary
public static RequestBuilder put()
putback to summary
public static RequestBuilder put(final URI uri)
Since
4.4
putback to summary
public static RequestBuilder put(final String uri)
Since
4.4
removeHeaderback to summary
public RequestBuilder removeHeader(final Header header)
removeHeadersback to summary
public RequestBuilder removeHeaders(final String name)
setCharsetback to summary
public RequestBuilder setCharset(final Charset charset)
Since
4.4
setConfigback to summary
public RequestBuilder setConfig(final RequestConfig config)
setEntityback to summary
public RequestBuilder setEntity(final HttpEntity entity)
setHeaderback to summary
public RequestBuilder setHeader(final Header header)
setHeaderback to summary
public RequestBuilder setHeader(final String name, final String value)
setUriback to summary
public RequestBuilder setUri(final URI uri)
setUriback to summary
public RequestBuilder setUri(final String uri)
setVersionback to summary
public RequestBuilder setVersion(final ProtocolVersion version)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
traceback to summary
public static RequestBuilder trace()
traceback to summary
public static RequestBuilder trace(final URI uri)
Since
4.4
traceback to summary
public static RequestBuilder trace(final String uri)
Since
4.4
org.apache.http.client.methods back to summary

pack-priv Class RequestBuilder.InternalEntityEclosingRequest

extends HttpEntityEnclosingRequestBase
Class Inheritance

Deprecated

as a consequence of HttpEntityEnclosingRequestBase being deprecated. See corresponding docs for further information.

Field Summary

Modifier and TypeField and Description
private final String
method

Constructor Summary

AccessConstructor and Description
pack-priv
InternalEntityEclosingRequest(final String method)

Method Summary

Modifier and TypeMethod and Description
public String
getMethod()

Implements abstract org.apache.http.client.methods.HttpRequestBase.getMethod.

Implements org.apache.http.client.methods.HttpUriRequest.getMethod.

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
Inherited from org.apache.http.client.methods.HttpEntityEnclosingRequestBase:
cloneexpectContinuegetEntitysetEntity

Field Detail

methodback to summary
private final String method

Constructor Detail

InternalEntityEclosingRequestback to summary
pack-priv InternalEntityEclosingRequest(final String method)

Method Detail

getMethodback to summary
public String getMethod()

Implements abstract org.apache.http.client.methods.HttpRequestBase.getMethod.

Implements org.apache.http.client.methods.HttpUriRequest.getMethod.

Doc from org.apache.http.client.methods.HttpUriRequest.getMethod.

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.

Annotations
@Override
org.apache.http.client.methods back to summary

pack-priv Class RequestBuilder.InternalRequest

extends HttpRequestBase
Class Inheritance

Deprecated

as a consequence of HttpRequestBase being deprecated. See corresponding docs for further information.

Field Summary

Modifier and TypeField and Description
private final String
method

Constructor Summary

AccessConstructor and Description
pack-priv
InternalRequest(final String method)

Method Summary

Modifier and TypeMethod and Description
public String
getMethod()

Implements abstract org.apache.http.client.methods.HttpRequestBase.getMethod.

Implements org.apache.http.client.methods.HttpUriRequest.getMethod.

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.
Inherited from org.apache.http.client.methods.HttpRequestBase:
getConfiggetProtocolVersiongetRequestLinegetURIreleaseConnectionsetConfigsetProtocolVersionsetURIstartedtoString

Field Detail

methodback to summary
private final String method

Constructor Detail

InternalRequestback to summary
pack-priv InternalRequest(final String method)

Method Detail

getMethodback to summary
public String getMethod()

Implements abstract org.apache.http.client.methods.HttpRequestBase.getMethod.

Implements org.apache.http.client.methods.HttpUriRequest.getMethod.

Doc from org.apache.http.client.methods.HttpUriRequest.getMethod.

Returns the HTTP method this request uses, such as GET, PUT, POST, or other.

Annotations
@Override