Top Description Fields Constructors Methods
org.apache.hc.client5.http.async.methods

public Class SimpleRequestBuilder

extends AbstractRequestBuilder<SimpleHttpRequest>
Class Inheritance
Imports
java.net.URI, .URISyntaxException, java.nio.charset.Charset, java.util.Arrays, .List, org.apache.hc.client5.http.config.RequestConfig, org.apache.hc.core5.http.ContentType, .Header, .HttpHost, .HttpRequest, .Method, .NameValuePair, .ProtocolVersion, org.apache.hc.core5.http.support.AbstractRequestBuilder, org.apache.hc.core5.net.URIAuthority, .URIBuilder, .WWWFormCodec, org.apache.hc.core5.util.Args
Builder for SimpleHttpRequest 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 setBody(SimpleBody) 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 SimpleBody
body

private RequestConfig
requestConfig

Constructor Summary

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

pack-priv
SimpleRequestBuilder(final Method method)

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

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

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

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

Method Summary

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

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

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

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

public SimpleRequestBuilder
addParameter(final NameValuePair nvp)

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

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

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

public SimpleRequestBuilder
addParameters(final NameValuePair... nvps)

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

public SimpleHttpRequest
build()

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

public static SimpleRequestBuilder
copy(final SimpleHttpRequest request)

public static SimpleRequestBuilder
copy(final HttpRequest request)

public static SimpleRequestBuilder
create(final String method)

public static SimpleRequestBuilder
create(final Method method)

public static SimpleRequestBuilder
delete()

public static SimpleRequestBuilder
delete(final URI uri)

public static SimpleRequestBuilder
delete(final String uri)

protected void
digest(final SimpleHttpRequest request)

protected void
digest(final HttpRequest request)

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

public static SimpleRequestBuilder
get()

public static SimpleRequestBuilder
get(final URI uri)

public static SimpleRequestBuilder
get(final String uri)

public SimpleBody
getBody()

public RequestConfig
getRequestConfig()

public static SimpleRequestBuilder
head()

public static SimpleRequestBuilder
head(final URI uri)

public static SimpleRequestBuilder
head(final String uri)

public static SimpleRequestBuilder
options()

public static SimpleRequestBuilder
options(final URI uri)

public static SimpleRequestBuilder
options(final String uri)

public static SimpleRequestBuilder
patch()

public static SimpleRequestBuilder
patch(final URI uri)

public static SimpleRequestBuilder
patch(final String uri)

public static SimpleRequestBuilder
post()

public static SimpleRequestBuilder
post(final URI uri)

public static SimpleRequestBuilder
post(final String uri)

public static SimpleRequestBuilder
put()

public static SimpleRequestBuilder
put(final URI uri)

public static SimpleRequestBuilder
put(final String uri)

public SimpleRequestBuilder
removeHeader(final Header header)

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

public SimpleRequestBuilder
removeHeaders(final String name)

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

public SimpleRequestBuilder
setAbsoluteRequestUri(final boolean absoluteRequestUri)

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

public SimpleRequestBuilder
setAuthority(final URIAuthority authority)

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

public SimpleRequestBuilder
setBody(final SimpleBody body)

public SimpleRequestBuilder
setBody(final String content, final ContentType contentType)

public SimpleRequestBuilder
setBody(final byte[] content, final ContentType contentType)

public SimpleRequestBuilder
setCharset(final Charset charset)

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

public SimpleRequestBuilder
setHeader(final Header header)

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

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

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

public SimpleRequestBuilder
setHeaders(final Header... headers)

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

public SimpleRequestBuilder
setHttpHost(final HttpHost httpHost)

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

public SimpleRequestBuilder
setPath(final String path)

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

public SimpleRequestBuilder
setRequestConfig(final RequestConfig requestConfig)

public SimpleRequestBuilder
setScheme(final String scheme)

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

public SimpleRequestBuilder
setUri(final URI uri)

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

public SimpleRequestBuilder
setUri(final String uri)

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

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

public static SimpleRequestBuilder
trace(final URI uri)

public static SimpleRequestBuilder
trace(final String uri)

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

Field Detail

bodyback to summary
private SimpleBody body
requestConfigback to summary
private RequestConfig requestConfig

Constructor Detail

SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final String method)
SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final Method method)
SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final String method, final URI uri)
SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final Method method, final URI uri)
SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final Method method, final String uri)
SimpleRequestBuilderback to summary
pack-priv SimpleRequestBuilder(final String method, final String uri)

Method Detail

addHeaderback to summary
public SimpleRequestBuilder addHeader(final Header header)

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

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

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

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

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

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

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

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

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

Annotations
@Override
buildback to summary
public SimpleHttpRequest build()

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

Annotations
@Override
copyback to summary
public static SimpleRequestBuilder copy(final SimpleHttpRequest request)
Since
5.1
copyback to summary
public static SimpleRequestBuilder copy(final HttpRequest request)
Since
5.1
createback to summary
public static SimpleRequestBuilder create(final String method)
createback to summary
public static SimpleRequestBuilder create(final Method method)
deleteback to summary
public static SimpleRequestBuilder delete()
deleteback to summary
public static SimpleRequestBuilder delete(final URI uri)
deleteback to summary
public static SimpleRequestBuilder delete(final String uri)
digestback to summary
protected void digest(final SimpleHttpRequest request)
digestback to summary
protected void digest(final HttpRequest request)

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

Annotations
@Override
getback to summary
public static SimpleRequestBuilder get()
getback to summary
public static SimpleRequestBuilder get(final URI uri)
getback to summary
public static SimpleRequestBuilder get(final String uri)
getBodyback to summary
public SimpleBody getBody()
getRequestConfigback to summary
public RequestConfig getRequestConfig()
headback to summary
public static SimpleRequestBuilder head()
headback to summary
public static SimpleRequestBuilder head(final URI uri)
headback to summary
public static SimpleRequestBuilder head(final String uri)
optionsback to summary
public static SimpleRequestBuilder options()
optionsback to summary
public static SimpleRequestBuilder options(final URI uri)
optionsback to summary
public static SimpleRequestBuilder options(final String uri)
patchback to summary
public static SimpleRequestBuilder patch()
patchback to summary
public static SimpleRequestBuilder patch(final URI uri)
patchback to summary
public static SimpleRequestBuilder patch(final String uri)
postback to summary
public static SimpleRequestBuilder post()
postback to summary
public static SimpleRequestBuilder post(final URI uri)
postback to summary
public static SimpleRequestBuilder post(final String uri)
putback to summary
public static SimpleRequestBuilder put()
putback to summary
public static SimpleRequestBuilder put(final URI uri)
putback to summary
public static SimpleRequestBuilder put(final String uri)
removeHeaderback to summary
public SimpleRequestBuilder removeHeader(final Header header)

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

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

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

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

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

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

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

Annotations
@Override
setBodyback to summary
public SimpleRequestBuilder setBody(final SimpleBody body)
setBodyback to summary
public SimpleRequestBuilder setBody(final String content, final ContentType contentType)
setBodyback to summary
public SimpleRequestBuilder setBody(final byte[] content, final ContentType contentType)
setCharsetback to summary
public SimpleRequestBuilder setCharset(final Charset charset)

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

Annotations
@Override
setHeaderback to summary
public SimpleRequestBuilder setHeader(final Header header)

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

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

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

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

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

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

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

Annotations
@Override
setPathback to summary
public SimpleRequestBuilder setPath(final String path)

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

Annotations
@Override
setRequestConfigback to summary
public SimpleRequestBuilder setRequestConfig(final RequestConfig requestConfig)
setSchemeback to summary
public SimpleRequestBuilder setScheme(final String scheme)

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

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

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

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

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

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