org.asynchttpclient

Interface Request

All Known Implementing Classes:

DefaultRequest

public interface Request

The Request class can be used to construct HTTP request:

   Request r = new RequestBuilder().setUrl("url")
                      .setRealm((new Realm.RealmBuilder()).setPrincipal(user)
                      .setPassword(admin)
                      .setRealmName("MyRealm")
                      .setScheme(Realm.AuthScheme.DIGEST).build());
 

Method Summary

Modifier and Type	Method and Description
InetAddress	getAddress() Return the InetAddress to override
BodyGenerator	getBodyGenerator() Return the current request's body generator.
List<Part>	getBodyParts() Return the current Part
ByteBuffer	getByteBufferData() Return the current request's body as a ByteBuffer
byte[]	getByteData() Return the current request's body as a byte array
ChannelPoolPartitioning	getChannelPoolPartitioning()
Charset	getCharset() Return the charset value used when decoding the request's body.
List<byte[]>	getCompositeByteData()
long	getContentLength() Return the current size of the content-lenght header based on the body's size.
List<Cookie>	getCookies() Return cookies.
File	getFile() Return the File to upload.
Boolean	getFollowRedirect() Return follow redirect
List<Param>	getFormParams() Return the current form parameters.
io.netty.handler.codec.http.HttpHeaders	getHeaders() Return the current set of Headers.
InetAddress	getLocalAddress()
String	getMethod() Return the request's method name (GET, POST, etc.)
NameResolver<InetAddress>	getNameResolver()
ProxyServer	getProxyServer() Return the ProxyServer
List<Param>	getQueryParams() Return the query params.
long	getRangeOffset() Return the HTTP Range header value, or
Realm	getRealm() Return the Realm
int	getRequestTimeout() Overrides the config default value
InputStream	getStreamData() Return the current request's body as an InputStream
String	getStringData() Return the current request's body as a string
Uri	getUri()
String	getUrl()
String	getVirtualHost() Return the virtual host value.

Method Detail

getMethod

String getMethod()

Return the request's method name (GET, POST, etc.)

Returns:

the request's method name (GET, POST, etc.)

getUri

Uri getUri()

getUrl

String getUrl()

getAddress

InetAddress getAddress()

Return the InetAddress to override

Returns:

the InetAddress

getLocalAddress

InetAddress getLocalAddress()

getHeaders

io.netty.handler.codec.http.HttpHeaders getHeaders()

Return the current set of Headers.

Returns:

a HttpHeaders contains headers.

getCookies

List<Cookie> getCookies()

Return cookies.

Returns:

an unmodifiable Collection of Cookies

getByteData

byte[] getByteData()

Return the current request's body as a byte array

Returns:

a byte array of the current request's body.

getCompositeByteData

List<byte[]> getCompositeByteData()

Returns:

the current request's body as a composite of byte arrays

getStringData

String getStringData()

Return the current request's body as a string

Returns:

an String representation of the current request's body.

getByteBufferData

ByteBuffer getByteBufferData()

Return the current request's body as a ByteBuffer

Returns:

a ByteBuffer

getStreamData

InputStream getStreamData()

Return the current request's body as an InputStream

Returns:

an InputStream representation of the current request's body.

getBodyGenerator

BodyGenerator getBodyGenerator()

Return the current request's body generator.

Returns:

A generator for the request body.

getContentLength

long getContentLength()

Return the current size of the content-lenght header based on the body's size.

Returns:

the current size of the content-lenght header based on the body's size.

getFormParams

List<Param> getFormParams()

Return the current form parameters.

Returns:

the form parameters.

getBodyParts

List<Part> getBodyParts()

Return the current Part

Returns:

the current Part

getVirtualHost

String getVirtualHost()

Return the virtual host value.

Returns:

the virtual host value.

getQueryParams

List<Param> getQueryParams()

Return the query params.

Returns:

the query parameters

getProxyServer

ProxyServer getProxyServer()

Return the ProxyServer

Returns:

the ProxyServer

getRealm

Realm getRealm()

Return the Realm

Returns:

the Realm

getFile

File getFile()

Return the File to upload.

Returns:

the File to upload.

getFollowRedirect

Boolean getFollowRedirect()

Return follow redirect

Returns:

Boolean.TRUE to follow redirect, Boolean.FALSE if NOT to follow whatever the client config, null otherwise.

getRequestTimeout

int getRequestTimeout()

Overrides the config default value

Returns:

the request timeout

getRangeOffset

long getRangeOffset()

Return the HTTP Range header value, or

Returns:

the range header value, or 0 is not set.

getCharset

Charset getCharset()

Return the charset value used when decoding the request's body.

Returns:

the charset value used when decoding the request's body.

getChannelPoolPartitioning

ChannelPoolPartitioning getChannelPoolPartitioning()

getNameResolver

NameResolver<InetAddress> getNameResolver()