Package org.apache.hc.core5.http.nio.support

Class AsyncRequestBuilder

java.lang.Object

org.apache.hc.core5.http.support.AbstractMessageBuilder<T>

org.apache.hc.core5.http.support.AbstractRequestBuilder<AsyncRequestProducer>

org.apache.hc.core5.http.nio.support.AsyncRequestBuilder

public class AsyncRequestBuilder
extends AbstractRequestBuilder<AsyncRequestProducer>

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

Fields

Modifier and Type	Field	Description
private AsyncEntityProducer	entityProducer

Constructor Summary

Constructors

Constructor	Description
AsyncRequestBuilder(java.lang.String method)
AsyncRequestBuilder(java.lang.String method, java.lang.String uri)
AsyncRequestBuilder(java.lang.String method, java.net.URI uri)
AsyncRequestBuilder(Method method)
AsyncRequestBuilder(Method method, java.lang.String uri)
AsyncRequestBuilder(Method method, java.net.URI uri)

Method Summary

Modifier and Type	Method	Description
AsyncRequestBuilder	addHeader(java.lang.String name, java.lang.String value)
AsyncRequestBuilder	addHeader(Header header)
AsyncRequestBuilder	addParameter(java.lang.String name, java.lang.String value)
AsyncRequestBuilder	addParameter(NameValuePair nvp)
AsyncRequestBuilder	addParameters(NameValuePair... nvps)
AsyncRequestProducer	build()
static AsyncRequestBuilder	create(java.lang.String method)
static AsyncRequestBuilder	delete()
static AsyncRequestBuilder	delete(java.lang.String uri)
static AsyncRequestBuilder	delete(java.net.URI uri)
static AsyncRequestBuilder	get()
static AsyncRequestBuilder	get(java.lang.String uri)
static AsyncRequestBuilder	get(java.net.URI uri)
AsyncEntityProducer	getEntity()
static AsyncRequestBuilder	head()
static AsyncRequestBuilder	head(java.lang.String uri)
static AsyncRequestBuilder	head(java.net.URI uri)
static AsyncRequestBuilder	options()
static AsyncRequestBuilder	options(java.lang.String uri)
static AsyncRequestBuilder	options(java.net.URI uri)
static AsyncRequestBuilder	patch()
static AsyncRequestBuilder	patch(java.lang.String uri)
static AsyncRequestBuilder	patch(java.net.URI uri)
static AsyncRequestBuilder	post()
static AsyncRequestBuilder	post(java.lang.String uri)
static AsyncRequestBuilder	post(java.net.URI uri)
static AsyncRequestBuilder	put()
static AsyncRequestBuilder	put(java.lang.String uri)
static AsyncRequestBuilder	put(java.net.URI uri)
AsyncRequestBuilder	removeHeader(Header header)
AsyncRequestBuilder	removeHeaders(java.lang.String name)
AsyncRequestBuilder	setAbsoluteRequestUri(boolean absoluteRequestUri)
AsyncRequestBuilder	setAuthority(URIAuthority authority)
AsyncRequestBuilder	setCharset(java.nio.charset.Charset charset)
AsyncRequestBuilder	setEntity(byte[] content, ContentType contentType)
AsyncRequestBuilder	setEntity(java.lang.String content)
AsyncRequestBuilder	setEntity(java.lang.String content, ContentType contentType)
AsyncRequestBuilder	setEntity(AsyncEntityProducer entityProducer)
AsyncRequestBuilder	setHeader(java.lang.String name, java.lang.String value)
AsyncRequestBuilder	setHeader(Header header)
AsyncRequestBuilder	setHeaders(Header... headers)
AsyncRequestBuilder	setHttpHost(HttpHost httpHost)
AsyncRequestBuilder	setPath(java.lang.String path)
AsyncRequestBuilder	setScheme(java.lang.String scheme)
AsyncRequestBuilder	setUri(java.lang.String uri)
AsyncRequestBuilder	setUri(java.net.URI uri)
AsyncRequestBuilder	setVersion(ProtocolVersion version)
java.lang.String	toString()
static AsyncRequestBuilder	trace()
static AsyncRequestBuilder	trace(java.lang.String uri)
static AsyncRequestBuilder	trace(java.net.URI uri)

Methods inherited from class org.apache.hc.core5.http.support.AbstractRequestBuilder

digest, getAuthority, getCharset, getMethod, getParameters, getPath, getScheme, getUri, isAbsoluteRequestUri

Methods inherited from class org.apache.hc.core5.http.support.AbstractMessageBuilder

digest, getFirstHeader, getFirstHeaders, getHeaders, getHeaders, getLastHeader, getVersion, setHeaders

Methods inherited from class java.lang.Object

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

Field Detail

entityProducer

private AsyncEntityProducer entityProducer

Constructor Detail

AsyncRequestBuilder

AsyncRequestBuilder(java.lang.String method)

AsyncRequestBuilder

AsyncRequestBuilder(Method method)

AsyncRequestBuilder

AsyncRequestBuilder(java.lang.String method,
                    java.net.URI uri)

AsyncRequestBuilder

AsyncRequestBuilder(Method method,
                    java.net.URI uri)

AsyncRequestBuilder

AsyncRequestBuilder(Method method,
                    java.lang.String uri)

AsyncRequestBuilder

AsyncRequestBuilder(java.lang.String method,
                    java.lang.String uri)

Method Detail

create

public static AsyncRequestBuilder create(java.lang.String method)

get

public static AsyncRequestBuilder get()

get

public static AsyncRequestBuilder get(java.net.URI uri)

get

public static AsyncRequestBuilder get(java.lang.String uri)

head

public static AsyncRequestBuilder head()

head

public static AsyncRequestBuilder head(java.net.URI uri)

head

public static AsyncRequestBuilder head(java.lang.String uri)

patch

public static AsyncRequestBuilder patch()

patch

public static AsyncRequestBuilder patch(java.net.URI uri)

patch

public static AsyncRequestBuilder patch(java.lang.String uri)

post

public static AsyncRequestBuilder post()

post

public static AsyncRequestBuilder post(java.net.URI uri)

post

public static AsyncRequestBuilder post(java.lang.String uri)

put

public static AsyncRequestBuilder put()

put

public static AsyncRequestBuilder put(java.net.URI uri)

put

public static AsyncRequestBuilder put(java.lang.String uri)

delete

public static AsyncRequestBuilder delete()

delete

public static AsyncRequestBuilder delete(java.net.URI uri)

delete

public static AsyncRequestBuilder delete(java.lang.String uri)

trace

public static AsyncRequestBuilder trace()

trace

public static AsyncRequestBuilder trace(java.net.URI uri)

trace

public static AsyncRequestBuilder trace(java.lang.String uri)

options

public static AsyncRequestBuilder options()

options

public static AsyncRequestBuilder options(java.net.URI uri)

options

public static AsyncRequestBuilder options(java.lang.String uri)

setVersion

public AsyncRequestBuilder setVersion(ProtocolVersion version)

Overrides:

setVersion in class AbstractRequestBuilder<AsyncRequestProducer>

setUri

public AsyncRequestBuilder setUri(java.net.URI uri)

Overrides:

setUri in class AbstractRequestBuilder<AsyncRequestProducer>

setUri

public AsyncRequestBuilder setUri(java.lang.String uri)

Overrides:

setUri in class AbstractRequestBuilder<AsyncRequestProducer>

setScheme

public AsyncRequestBuilder setScheme(java.lang.String scheme)

Overrides:

setScheme in class AbstractRequestBuilder<AsyncRequestProducer>

setAuthority

public AsyncRequestBuilder setAuthority(URIAuthority authority)

Overrides:

setAuthority in class AbstractRequestBuilder<AsyncRequestProducer>

setHttpHost

public AsyncRequestBuilder setHttpHost(HttpHost httpHost)

Overrides:

setHttpHost in class AbstractRequestBuilder<AsyncRequestProducer>

Since:

5.1

setPath

public AsyncRequestBuilder setPath(java.lang.String path)

Overrides:

setPath in class AbstractRequestBuilder<AsyncRequestProducer>

setHeaders

public AsyncRequestBuilder setHeaders(Header... headers)

Overrides:

setHeaders in class AbstractRequestBuilder<AsyncRequestProducer>

addHeader

public AsyncRequestBuilder addHeader(Header header)

Overrides:

addHeader in class AbstractRequestBuilder<AsyncRequestProducer>

addHeader

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

Overrides:

addHeader in class AbstractRequestBuilder<AsyncRequestProducer>

removeHeader

public AsyncRequestBuilder removeHeader(Header header)

Overrides:

removeHeader in class AbstractRequestBuilder<AsyncRequestProducer>

removeHeaders

public AsyncRequestBuilder removeHeaders(java.lang.String name)

Overrides:

removeHeaders in class AbstractRequestBuilder<AsyncRequestProducer>

setHeader

public AsyncRequestBuilder setHeader(Header header)

Overrides:

setHeader in class AbstractRequestBuilder<AsyncRequestProducer>

setHeader

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

Overrides:

setHeader in class AbstractRequestBuilder<AsyncRequestProducer>

setCharset

public AsyncRequestBuilder setCharset(java.nio.charset.Charset charset)

Overrides:

setCharset in class AbstractRequestBuilder<AsyncRequestProducer>

addParameter

public AsyncRequestBuilder addParameter(NameValuePair nvp)

Overrides:

addParameter in class AbstractRequestBuilder<AsyncRequestProducer>

addParameter

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

Overrides:

addParameter in class AbstractRequestBuilder<AsyncRequestProducer>

addParameters

public AsyncRequestBuilder addParameters(NameValuePair... nvps)

Overrides:

addParameters in class AbstractRequestBuilder<AsyncRequestProducer>

setAbsoluteRequestUri

public AsyncRequestBuilder setAbsoluteRequestUri(boolean absoluteRequestUri)

Overrides:

setAbsoluteRequestUri in class AbstractRequestBuilder<AsyncRequestProducer>

getEntity

public AsyncEntityProducer getEntity()

setEntity

public AsyncRequestBuilder setEntity(AsyncEntityProducer entityProducer)

setEntity

public AsyncRequestBuilder setEntity(java.lang.String content,
                                     ContentType contentType)

setEntity

public AsyncRequestBuilder setEntity(java.lang.String content)

setEntity

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

build

public AsyncRequestProducer build()

Specified by:

build in class AbstractMessageBuilder<AsyncRequestProducer>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object