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

public final Class SimpleHttpRequest

extends ConfigurableHttpRequest
Class Inheritance
Imports
java.net.URI, java.util.Iterator, org.apache.hc.core5.http.ContentType, .Header, .HttpHost, .HttpRequest, .Method, org.apache.hc.core5.net.URIAuthority, org.apache.hc.core5.util.Args
HTTP request that can enclose a body represented as a simple text string or an array of bytes.

Important Note

SimpleHttpRequests are intended for simple scenarios where entities inclosed in requests are known to be small. It is generally recommended to use org.apache.hc.core5.http.nio.support.AsyncRequestBuilder and streaming org.apache.hc.core5.http.nio.AsyncEntityProducers.

Since
5.0
See Also
SimpleBody, org.apache.hc.core5.http.nio.support.AsyncRequestBuilder, org.apache.hc.core5.http.nio.AsyncEntityProducer

Field Summary

Modifier and TypeField and Description
private SimpleBody
body

private static final long
serialVersionUID

Hides org.apache.hc.client5.http.async.methods.ConfigurableHttpRequest.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
SimpleHttpRequest(final String method, final String path)

public
SimpleHttpRequest(final String method, final HttpHost host, final String path)

public
SimpleHttpRequest(final String method, final URI requestUri)

public
SimpleHttpRequest(final Method method, final URI requestUri)

public
SimpleHttpRequest(final Method method, final HttpHost host, final String path)

public
SimpleHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path)

Method Summary

Modifier and TypeMethod and Description
public static SimpleHttpRequest
copy(final HttpRequest original)

Deprecated Use SimpleRequestBuilder
public static SimpleHttpRequest
create(final String method, final String uri)

public static SimpleHttpRequest
create(final String method, final URI uri)

public static SimpleHttpRequest
create(final Method method, final URI uri)

public static SimpleHttpRequest
create(final Method method, final HttpHost host, final String path)

public static SimpleHttpRequest
create(final String method, final String scheme, final URIAuthority authority, final String path)

public SimpleBody
getBody()

public byte[]
getBodyBytes()

public String
getBodyText()

public ContentType
getContentType()

public void
setBody(final SimpleBody body)

public void
setBody(final byte[] bodyBytes, final ContentType contentType)

public void
setBody(final String bodyText, final ContentType contentType)

Inherited from org.apache.hc.client5.http.async.methods.ConfigurableHttpRequest:
getConfigsetConfig

Field Detail

bodyback to summary
private SimpleBody body
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.hc.client5.http.async.methods.ConfigurableHttpRequest.serialVersionUID.

Constructor Detail

SimpleHttpRequestback to summary
public SimpleHttpRequest(final String method, final String path)
SimpleHttpRequestback to summary
public SimpleHttpRequest(final String method, final HttpHost host, final String path)
SimpleHttpRequestback to summary
public SimpleHttpRequest(final String method, final URI requestUri)
SimpleHttpRequestback to summary
public SimpleHttpRequest(final Method method, final URI requestUri)
Since
5.1
SimpleHttpRequestback to summary
public SimpleHttpRequest(final Method method, final HttpHost host, final String path)
Since
5.1
SimpleHttpRequestback to summary
public SimpleHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path)
Since
5.1

Method Detail

copyback to summary
public static SimpleHttpRequest copy(final HttpRequest original)

Deprecated

Use SimpleRequestBuilder

Annotations
@Deprecated
createback to summary
public static SimpleHttpRequest create(final String method, final String uri)
Since
5.1
createback to summary
public static SimpleHttpRequest create(final String method, final URI uri)
Since
5.1
createback to summary
public static SimpleHttpRequest create(final Method method, final URI uri)
Since
5.1
createback to summary
public static SimpleHttpRequest create(final Method method, final HttpHost host, final String path)
Since
5.1
createback to summary
public static SimpleHttpRequest create(final String method, final String scheme, final URIAuthority authority, final String path)
Since
5.1
getBodyback to summary
public SimpleBody getBody()
getBodyBytesback to summary
public byte[] getBodyBytes()
getBodyTextback to summary
public String getBodyText()
getContentTypeback to summary
public ContentType getContentType()
setBodyback to summary
public void setBody(final SimpleBody body)
setBodyback to summary
public void setBody(final byte[] bodyBytes, final ContentType contentType)
setBodyback to summary
public void setBody(final String bodyText, final ContentType contentType)