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

public Class AsyncRequestBuilder

extends AbstractRequestBuilder<AsyncRequestProducer>
Class Inheritance
Imports
java.net.URI, .URISyntaxException, java.nio.charset.Charset, java.util.Arrays, .List, org.apache.hc.core5.http.ContentType, .Header, .HttpHost, .Method, .NameValuePair, .ProtocolVersion, org.apache.hc.core5.http.message.BasicHttpRequest, org.apache.hc.core5.http.nio.AsyncEntityProducer, .AsyncRequestProducer, org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer, .StringAsyncEntityProducer, org.apache.hc.core5.http.support.AbstractRequestBuilder, org.apache.hc.core5.net.URIAuthority, .URIBuilder, .WWWFormCodec, org.apache.hc.core5.util.Args, .TextUtils
Builder for AsyncRequestProducer 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(AsyncEntityProducer) 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 AsyncEntityProducer
entityProducer

Constructor Summary

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

pack-priv
AsyncRequestBuilder(final Method method)

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

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

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

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

Method Summary

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

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

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

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

public AsyncRequestBuilder
addParameter(final NameValuePair nvp)

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

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

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

public AsyncRequestBuilder
addParameters(final NameValuePair... nvps)

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

public AsyncRequestProducer
build()

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

public static AsyncRequestBuilder
create(final String method)

public static AsyncRequestBuilder
delete()

public static AsyncRequestBuilder
delete(final URI uri)

public static AsyncRequestBuilder
delete(final String uri)

public static AsyncRequestBuilder
get()

public static AsyncRequestBuilder
get(final URI uri)

public static AsyncRequestBuilder
get(final String uri)

public AsyncEntityProducer
getEntity()

public static AsyncRequestBuilder
head()

public static AsyncRequestBuilder
head(final URI uri)

public static AsyncRequestBuilder
head(final String uri)

public static AsyncRequestBuilder
options()

public static AsyncRequestBuilder
options(final URI uri)

public static AsyncRequestBuilder
options(final String uri)

public static AsyncRequestBuilder
patch()

public static AsyncRequestBuilder
patch(final URI uri)

public static AsyncRequestBuilder
patch(final String uri)

public static AsyncRequestBuilder
post()

public static AsyncRequestBuilder
post(final URI uri)

public static AsyncRequestBuilder
post(final String uri)

public static AsyncRequestBuilder
put()

public static AsyncRequestBuilder
put(final URI uri)

public static AsyncRequestBuilder
put(final String uri)

public AsyncRequestBuilder
removeHeader(final Header header)

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

public AsyncRequestBuilder
removeHeaders(final String name)

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

public AsyncRequestBuilder
setAbsoluteRequestUri(final boolean absoluteRequestUri)

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

public AsyncRequestBuilder
setAuthority(final URIAuthority authority)

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

public AsyncRequestBuilder
setCharset(final Charset charset)

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

public AsyncRequestBuilder
setEntity(final AsyncEntityProducer entityProducer)

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

public AsyncRequestBuilder
setEntity(final String content)

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

public AsyncRequestBuilder
setHeader(final Header header)

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

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

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

public AsyncRequestBuilder
setHeaders(final Header... headers)

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

public AsyncRequestBuilder
setHttpHost(final HttpHost httpHost)

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

public AsyncRequestBuilder
setPath(final String path)

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

public AsyncRequestBuilder
setScheme(final String scheme)

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

public AsyncRequestBuilder
setUri(final URI uri)

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

public AsyncRequestBuilder
setUri(final String uri)

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

public AsyncRequestBuilder
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 AsyncRequestBuilder
trace()

public static AsyncRequestBuilder
trace(final URI uri)

public static AsyncRequestBuilder
trace(final String uri)

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

Field Detail

entityProducerback to summary
private AsyncEntityProducer entityProducer

Constructor Detail

AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final String method)
AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final Method method)
AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final String method, final URI uri)
AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final Method method, final URI uri)
AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final Method method, final String uri)
AsyncRequestBuilderback to summary
pack-priv AsyncRequestBuilder(final String method, final String uri)

Method Detail

addHeaderback to summary
public AsyncRequestBuilder addHeader(final Header header)

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

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

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

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

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

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

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

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

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

Annotations
@Override
buildback to summary
public AsyncRequestProducer build()

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

Annotations
@Override
createback to summary
public static AsyncRequestBuilder create(final String method)
deleteback to summary
public static AsyncRequestBuilder delete()
deleteback to summary
public static AsyncRequestBuilder delete(final URI uri)
deleteback to summary
public static AsyncRequestBuilder delete(final String uri)
getback to summary
public static AsyncRequestBuilder get()
getback to summary
public static AsyncRequestBuilder get(final URI uri)
getback to summary
public static AsyncRequestBuilder get(final String uri)
getEntityback to summary
public AsyncEntityProducer getEntity()
headback to summary
public static AsyncRequestBuilder head()
headback to summary
public static AsyncRequestBuilder head(final URI uri)
headback to summary
public static AsyncRequestBuilder head(final String uri)
optionsback to summary
public static AsyncRequestBuilder options()
optionsback to summary
public static AsyncRequestBuilder options(final URI uri)
optionsback to summary
public static AsyncRequestBuilder options(final String uri)
patchback to summary
public static AsyncRequestBuilder patch()
patchback to summary
public static AsyncRequestBuilder patch(final URI uri)
patchback to summary
public static AsyncRequestBuilder patch(final String uri)
postback to summary
public static AsyncRequestBuilder post()
postback to summary
public static AsyncRequestBuilder post(final URI uri)
postback to summary
public static AsyncRequestBuilder post(final String uri)
putback to summary
public static AsyncRequestBuilder put()
putback to summary
public static AsyncRequestBuilder put(final URI uri)
putback to summary
public static AsyncRequestBuilder put(final String uri)
removeHeaderback to summary
public AsyncRequestBuilder removeHeader(final Header header)

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

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

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

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

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

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

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

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

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

Annotations
@Override
setEntityback to summary
public AsyncRequestBuilder setEntity(final AsyncEntityProducer entityProducer)
setEntityback to summary
public AsyncRequestBuilder setEntity(final String content, final ContentType contentType)
setEntityback to summary
public AsyncRequestBuilder setEntity(final String content)
setEntityback to summary
public AsyncRequestBuilder setEntity(final byte[] content, final ContentType contentType)
setHeaderback to summary
public AsyncRequestBuilder setHeader(final Header header)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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