Top Description Fields Constructors Methods
org.apache.hc.core5.http.io.support

public Class ClassicRequestBuilder

extends AbstractRequestBuilder<ClassicHttpRequest>
Class Inheritance
Imports
java.net.URI, .URISyntaxException, java.nio.charset.Charset, java.util.Arrays, .List, org.apache.hc.core5.http.ClassicHttpRequest, .ContentType, .Header, .HttpEntity, .HttpHost, .Method, .NameValuePair, .ProtocolVersion, org.apache.hc.core5.http.io.entity.ByteArrayEntity, .HttpEntities, .StringEntity, org.apache.hc.core5.http.message.BasicClassicHttpRequest, org.apache.hc.core5.http.support.AbstractRequestBuilder, org.apache.hc.core5.net.URIAuthority, .URIBuilder, org.apache.hc.core5.util.Args, .TextUtils
Builder for ClassicHttpRequest 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(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
5.0

Field Summary

Modifier and TypeField and Description
private HttpEntity
entity

Constructor Summary

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

pack-priv
ClassicRequestBuilder(final Method method)

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

pack-priv
ClassicRequestBuilder(final Method method, final URI uri)

pack-priv
ClassicRequestBuilder(final Method method, final String uri)

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

Method Summary

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

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addHeader.

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

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addHeader.

public ClassicRequestBuilder
addParameter(final NameValuePair nvp)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameter.

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

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameter.

public ClassicRequestBuilder
addParameters(final NameValuePair... nvps)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameters.

public ClassicHttpRequest
build()

Implements abstract org.apache.hc.core5.http.support.AbstractMessageBuilder.build.

public static ClassicRequestBuilder
copy(final ClassicHttpRequest request)

public static ClassicRequestBuilder
create(final String method)

public static ClassicRequestBuilder
delete()

public static ClassicRequestBuilder
delete(final URI uri)

public static ClassicRequestBuilder
delete(final String uri)

protected void
digest(final ClassicHttpRequest request)

public static ClassicRequestBuilder
get()

public static ClassicRequestBuilder
get(final URI uri)

public static ClassicRequestBuilder
get(final String uri)

public HttpEntity
getEntity()

public static ClassicRequestBuilder
head()

public static ClassicRequestBuilder
head(final URI uri)

public static ClassicRequestBuilder
head(final String uri)

public static ClassicRequestBuilder
options()

public static ClassicRequestBuilder
options(final URI uri)

public static ClassicRequestBuilder
options(final String uri)

public static ClassicRequestBuilder
patch()

public static ClassicRequestBuilder
patch(final URI uri)

public static ClassicRequestBuilder
patch(final String uri)

public static ClassicRequestBuilder
post()

public static ClassicRequestBuilder
post(final URI uri)

public static ClassicRequestBuilder
post(final String uri)

public static ClassicRequestBuilder
put()

public static ClassicRequestBuilder
put(final URI uri)

public static ClassicRequestBuilder
put(final String uri)

public ClassicRequestBuilder
removeHeader(final Header header)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.removeHeader.

public ClassicRequestBuilder
removeHeaders(final String name)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.removeHeaders.

public ClassicRequestBuilder
setAbsoluteRequestUri(final boolean absoluteRequestUri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setAbsoluteRequestUri.

public ClassicRequestBuilder
setAuthority(final URIAuthority authority)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setAuthority.

public ClassicRequestBuilder
setCharset(final Charset charset)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setCharset.

public ClassicRequestBuilder
setEntity(final HttpEntity entity)

public ClassicRequestBuilder
setEntity(final String content, final ContentType contentType)

public ClassicRequestBuilder
setEntity(final String content)

public ClassicRequestBuilder
setEntity(final byte[] content, final ContentType contentType)

public ClassicRequestBuilder
setHeader(final Header header)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeader.

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

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeader.

public ClassicRequestBuilder
setHeaders(final Header... headers)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeaders.

public ClassicRequestBuilder
setHttpHost(final HttpHost httpHost)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHttpHost.

public ClassicRequestBuilder
setPath(final String path)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setPath.

public ClassicRequestBuilder
setScheme(final String scheme)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setScheme.

public ClassicRequestBuilder
setUri(final URI uri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setUri.

public ClassicRequestBuilder
setUri(final String uri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setUri.

public ClassicRequestBuilder
setVersion(final ProtocolVersion version)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setVersion.

public String
toString()

Overrides java.lang.Object.toString.

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

public static ClassicRequestBuilder
trace(final URI uri)

public static ClassicRequestBuilder
trace(final String uri)

Inherited from org.apache.hc.core5.http.support.AbstractRequestBuilder:
digestgetAuthoritygetCharsetgetMethodgetParametersgetPathgetSchemegetUriisAbsoluteRequestUri

Field Detail

entityback to summary
private HttpEntity entity

Constructor Detail

ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final String method)
ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final Method method)
ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final String method, final URI uri)
ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final Method method, final URI uri)
ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final Method method, final String uri)
ClassicRequestBuilderback to summary
pack-priv ClassicRequestBuilder(final String method, final String uri)

Method Detail

addHeaderback to summary
public ClassicRequestBuilder addHeader(final Header header)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addHeader.

Annotations
@Override
addHeaderback to summary
public ClassicRequestBuilder addHeader(final String name, final String value)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addHeader.

Annotations
@Override
addParameterback to summary
public ClassicRequestBuilder addParameter(final NameValuePair nvp)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameter.

Annotations
@Override
addParameterback to summary
public ClassicRequestBuilder addParameter(final String name, final String value)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameter.

Annotations
@Override
addParametersback to summary
public ClassicRequestBuilder addParameters(final NameValuePair... nvps)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.addParameters.

Annotations
@Override
buildback to summary
public ClassicHttpRequest build()

Implements abstract org.apache.hc.core5.http.support.AbstractMessageBuilder.build.

Annotations
@Override
copyback to summary
public static ClassicRequestBuilder copy(final ClassicHttpRequest request)
Since
5.1
createback to summary
public static ClassicRequestBuilder create(final String method)
deleteback to summary
public static ClassicRequestBuilder delete()
deleteback to summary
public static ClassicRequestBuilder delete(final URI uri)
deleteback to summary
public static ClassicRequestBuilder delete(final String uri)
digestback to summary
protected void digest(final ClassicHttpRequest request)
getback to summary
public static ClassicRequestBuilder get()
getback to summary
public static ClassicRequestBuilder get(final URI uri)
getback to summary
public static ClassicRequestBuilder get(final String uri)
getEntityback to summary
public HttpEntity getEntity()
headback to summary
public static ClassicRequestBuilder head()
headback to summary
public static ClassicRequestBuilder head(final URI uri)
headback to summary
public static ClassicRequestBuilder head(final String uri)
optionsback to summary
public static ClassicRequestBuilder options()
optionsback to summary
public static ClassicRequestBuilder options(final URI uri)
optionsback to summary
public static ClassicRequestBuilder options(final String uri)
patchback to summary
public static ClassicRequestBuilder patch()
patchback to summary
public static ClassicRequestBuilder patch(final URI uri)
patchback to summary
public static ClassicRequestBuilder patch(final String uri)
postback to summary
public static ClassicRequestBuilder post()
postback to summary
public static ClassicRequestBuilder post(final URI uri)
postback to summary
public static ClassicRequestBuilder post(final String uri)
putback to summary
public static ClassicRequestBuilder put()
putback to summary
public static ClassicRequestBuilder put(final URI uri)
putback to summary
public static ClassicRequestBuilder put(final String uri)
removeHeaderback to summary
public ClassicRequestBuilder removeHeader(final Header header)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.removeHeader.

Annotations
@Override
removeHeadersback to summary
public ClassicRequestBuilder removeHeaders(final String name)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.removeHeaders.

Annotations
@Override
setAbsoluteRequestUriback to summary
public ClassicRequestBuilder setAbsoluteRequestUri(final boolean absoluteRequestUri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setAbsoluteRequestUri.

Annotations
@Override
setAuthorityback to summary
public ClassicRequestBuilder setAuthority(final URIAuthority authority)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setAuthority.

Annotations
@Override
setCharsetback to summary
public ClassicRequestBuilder setCharset(final Charset charset)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setCharset.

Annotations
@Override
setEntityback to summary
public ClassicRequestBuilder setEntity(final HttpEntity entity)
setEntityback to summary
public ClassicRequestBuilder setEntity(final String content, final ContentType contentType)
setEntityback to summary
public ClassicRequestBuilder setEntity(final String content)
setEntityback to summary
public ClassicRequestBuilder setEntity(final byte[] content, final ContentType contentType)
setHeaderback to summary
public ClassicRequestBuilder setHeader(final Header header)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeader.

Annotations
@Override
setHeaderback to summary
public ClassicRequestBuilder setHeader(final String name, final String value)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeader.

Annotations
@Override
setHeadersback to summary
public ClassicRequestBuilder setHeaders(final Header... headers)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHeaders.

Annotations
@Override
setHttpHostback to summary
public ClassicRequestBuilder setHttpHost(final HttpHost httpHost)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setHttpHost.

Annotations
@Override
Since
5.1
setPathback to summary
public ClassicRequestBuilder setPath(final String path)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setPath.

Annotations
@Override
setSchemeback to summary
public ClassicRequestBuilder setScheme(final String scheme)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setScheme.

Annotations
@Override
setUriback to summary
public ClassicRequestBuilder setUri(final URI uri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setUri.

Annotations
@Override
setUriback to summary
public ClassicRequestBuilder setUri(final String uri)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setUri.

Annotations
@Override
setVersionback to summary
public ClassicRequestBuilder setVersion(final ProtocolVersion version)

Overrides org.apache.hc.core5.http.support.AbstractRequestBuilder.setVersion.

Annotations
@Override
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 ClassicRequestBuilder trace()
traceback to summary
public static ClassicRequestBuilder trace(final URI uri)
traceback to summary
public static ClassicRequestBuilder trace(final String uri)