org.apache.hc.client5.http.async.methods

Class SimpleHttpRequest

java.lang.Object

org.apache.hc.core5.http.message.HeaderGroup

org.apache.hc.core5.http.message.BasicHttpRequest

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

org.apache.hc.client5.http.async.methods.SimpleHttpRequest

All Implemented Interfaces:

Serializable, Configurable, org.apache.hc.core5.http.HttpMessage, org.apache.hc.core5.http.HttpRequest, org.apache.hc.core5.http.MessageHeaders

public final class SimpleHttpRequest
extends ConfigurableHttpRequest

HTTP request that can enclose a body represented as a simple text string or an array of bytes.

IMPORTANT: SimpleHttpRequests are intended for simple scenarios where entities inclosed in requests are known to be small. It is generally recommended to use AsyncRequestBuilder and streaming AsyncEntityProducers.

Since:

5.0

See Also:

SimpleBody, AsyncRequestBuilder, AsyncEntityProducer, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleHttpRequest(org.apache.hc.core5.http.Method method, org.apache.hc.core5.http.HttpHost host, String path) Constructs a new request message with the given method, host, and request path.
SimpleHttpRequest(org.apache.hc.core5.http.Method method, URI requestUri) Constructs a new request message with the given method, and request URI.
SimpleHttpRequest(String method, org.apache.hc.core5.http.HttpHost host, String path) Constructs a new request message with the given method, host, and request path.
SimpleHttpRequest(String method, String path) Constructs a new request message with the given method and request path.
SimpleHttpRequest(String method, String scheme, org.apache.hc.core5.net.URIAuthority authority, String path) Constructs a new request message with the given method, scheme, authority, and request path.
SimpleHttpRequest(String method, URI requestUri) Constructs a new request message with the given method, and request URI.

Method Summary

Modifier and Type	Method and Description
static SimpleHttpRequest	copy(org.apache.hc.core5.http.HttpRequest original) Deprecated. Use SimpleRequestBuilder
static SimpleHttpRequest	create(org.apache.hc.core5.http.Method method, org.apache.hc.core5.http.HttpHost host, String path) Creates a new request message with the given method, host, and request path.
static SimpleHttpRequest	create(org.apache.hc.core5.http.Method method, URI uri) Creates a new request message with the given method and request path.
static SimpleHttpRequest	create(String method, String uri) Creates a new request message with the given method and request path.
static SimpleHttpRequest	create(String method, String scheme, org.apache.hc.core5.net.URIAuthority authority, String path) Creates a new request message with the given method, scheme, authority, and request path.
static SimpleHttpRequest	create(String method, URI uri) Creates a new request message with the given method and request path.
SimpleBody	getBody() Gets the request body.
byte[]	getBodyBytes() Gets the request body as a byte array.
String	getBodyText() Gets the request body as a String.
org.apache.hc.core5.http.ContentType	getContentType() Gets the request content type.
void	setBody(byte[] bodyBytes, org.apache.hc.core5.http.ContentType contentType) Sets the message body and content type.
void	setBody(SimpleBody body) Sets the message body and content type.
void	setBody(String bodyText, org.apache.hc.core5.http.ContentType contentType) Sets the message body and content type.

Methods inherited from class org.apache.hc.client5.http.async.methods.ConfigurableHttpRequest

getConfig, setConfig

Methods inherited from class org.apache.hc.core5.http.message.BasicHttpRequest

addHeader, getAuthority, getMethod, getPath, getRequestUri, getScheme, getUri, getVersion, setAbsoluteRequestUri, setAuthority, setHeader, setPath, setScheme, setUri, setVersion, toString

Methods inherited from class org.apache.hc.core5.http.message.HeaderGroup

addHeader, clear, containsHeader, countHeaders, getCondensedHeader, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator, removeHeader, removeHeaders, removeHeaders, setHeader, setHeaders

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hc.core5.http.HttpMessage

addHeader, removeHeader, removeHeaders, setHeader, setHeaders

Methods inherited from interface org.apache.hc.core5.http.MessageHeaders

containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator

Constructor Detail

SimpleHttpRequest

public SimpleHttpRequest(String method,
                         String path)

Constructs a new request message with the given method and request path.

Parameters:

method - request method.

path - request path.

SimpleHttpRequest

public SimpleHttpRequest(String method,
                         org.apache.hc.core5.http.HttpHost host,
                         String path)

Constructs a new request message with the given method, host, and request path.

Parameters:

method - request method.

host - request host.

path - request path.

SimpleHttpRequest

public SimpleHttpRequest(String method,
                         URI requestUri)

Constructs a new request message with the given method, and request URI.

Parameters:

method - request method.

requestUri - request URI.

Since:

5.1

SimpleHttpRequest

public SimpleHttpRequest(org.apache.hc.core5.http.Method method,
                         URI requestUri)

Constructs a new request message with the given method, and request URI.

Parameters:

method - request method.

requestUri - request URI.

Since:

5.1

SimpleHttpRequest

public SimpleHttpRequest(org.apache.hc.core5.http.Method method,
                         org.apache.hc.core5.http.HttpHost host,
                         String path)

Constructs a new request message with the given method, host, and request path.

Parameters:

method - request method.

host - request host.

path - request path.

Since:

5.1

SimpleHttpRequest

public SimpleHttpRequest(String method,
                         String scheme,
                         org.apache.hc.core5.net.URIAuthority authority,
                         String path)

Constructs a new request message with the given method, scheme, authority, and request path.

Parameters:

method - request method.

scheme - request host.

authority - request URI authority.

path - request path.

Since:

5.1

Method Detail

create

public static SimpleHttpRequest create(String method,
                                       String uri)

Creates a new request message with the given method and request path.

Parameters:

method - request method.

uri - request URI.

Returns:

a new SimpleHttpRequest.

Since:

5.1

create

public static SimpleHttpRequest create(String method,
                                       URI uri)

Creates a new request message with the given method and request path.

Parameters:

method - request method.

uri - request URI.

Returns:

a new SimpleHttpRequest.

Since:

5.1

create

public static SimpleHttpRequest create(org.apache.hc.core5.http.Method method,
                                       URI uri)

Creates a new request message with the given method and request path.

Parameters:

method - request method.

uri - request URI.

Returns:

a new SimpleHttpRequest.

Since:

5.1

create

public static SimpleHttpRequest create(org.apache.hc.core5.http.Method method,
                                       org.apache.hc.core5.http.HttpHost host,
                                       String path)

Creates a new request message with the given method, host, and request path.

Parameters:

method - request method.

host - request host.

path - request path.

Returns:

a new SimpleHttpRequest.

Since:

5.1

create

public static SimpleHttpRequest create(String method,
                                       String scheme,
                                       org.apache.hc.core5.net.URIAuthority authority,
                                       String path)

Creates a new request message with the given method, scheme, authority, and request path.

Parameters:

method - request method.

scheme - request host.

authority - request URI authority.

path - request path.

Returns:

a new SimpleHttpRequest.

Since:

5.1

copy

@Deprecated
public static SimpleHttpRequest copy(org.apache.hc.core5.http.HttpRequest original)

Deprecated. Use SimpleRequestBuilder

Copies the given HttpRequest.

Parameters:

original - the source to copy.

Returns:

a new SimpleHttpRequest.

setBody

public void setBody(SimpleBody body)

Sets the message body and content type.

Parameters:

body - request body.

setBody

public void setBody(byte[] bodyBytes,
                    org.apache.hc.core5.http.ContentType contentType)

Sets the message body and content type.

Parameters:

bodyBytes - request body.

contentType - request content type.

setBody

public void setBody(String bodyText,
                    org.apache.hc.core5.http.ContentType contentType)

Sets the message body and content type.

Parameters:

bodyText - request body.

contentType - request content type.

getBody

public SimpleBody getBody()

Gets the request body.

Returns:

the request body.

getContentType

public org.apache.hc.core5.http.ContentType getContentType()

Gets the request content type.

Returns:

the request content type.

getBodyText

public String getBodyText()

Gets the request body as a String.

Returns:

the request body.

getBodyBytes

public byte[] getBodyBytes()

Gets the request body as a byte array.

Returns:

the request body.