Interface HttpRequest

All Superinterfaces:

DecoderResultProvider, HttpMessage, HttpObject

All Known Subinterfaces:

FullHttpRequest

All Known Implementing Classes:

DefaultFullHttpRequest, DefaultHttpRequest

public interface HttpRequest
extends HttpMessage

An HTTP request.

Accessing Query Parameters and Cookie

Unlike the Servlet API, a query string is constructed and decomposed by QueryStringEncoder and QueryStringDecoder. Cookie support is also provided separately via ServerCookieDecoder, ClientCookieDecoder, ServerCookieEncoder, and ClientCookieEncoder.

See Also:

• HttpResponse
• ServerCookieDecoder
• ClientCookieDecoder
• ServerCookieEncoder
• ClientCookieEncoder

Method Summary

Modifier and Type	Method	Description
HttpMethod	getMethod()	Deprecated. Use method() instead.
String	getUri()	Deprecated. Use uri() instead.
HttpMethod	method()	Returns the HttpMethod of this HttpRequest.
HttpRequest	setMethod(HttpMethod method)	Set the HttpMethod of this HttpRequest.
HttpRequest	setProtocolVersion(HttpVersion version)	Set the protocol version of this HttpMessage
HttpRequest	setUri(String uri)	Set the requested URI (or alternatively, path)
String	uri()	Returns the requested URI (or alternatively, path)

Methods inherited from interface DecoderResultProvider

decoderResult, setDecoderResult

Modifier and Type	Method	Description
DecoderResult	decoderResult()	Returns the result of decoding this object.
void	setDecoderResult(DecoderResult result)	Updates the result of decoding this object.

Methods inherited from interface HttpMessage

getProtocolVersion, headers, protocolVersion

Modifier and Type	Method	Description
HttpVersion	getProtocolVersion()	Deprecated. Use HttpMessage.protocolVersion() instead.
HttpHeaders	headers()	Returns the headers of this message.
HttpVersion	protocolVersion()	Returns the protocol version of this HttpMessage

Methods inherited from interface HttpObject

getDecoderResult

Modifier and Type	Method	Description
DecoderResult	getDecoderResult()	Deprecated. Use DecoderResultProvider.decoderResult() instead.

Method Details

getMethod

@Deprecated
HttpMethod getMethod()

Deprecated.

Use method() instead.

method

HttpMethod method()

Returns the HttpMethod of this HttpRequest.

Returns:

The HttpMethod of this HttpRequest

setMethod

HttpRequest setMethod(HttpMethod method)

Set the HttpMethod of this HttpRequest.

getUri

@Deprecated
String getUri()

Deprecated.

Use uri() instead.

uri

String uri()

Returns the requested URI (or alternatively, path)

Returns:

The URI being requested

setUri

HttpRequest setUri(String uri)

Set the requested URI (or alternatively, path)

setProtocolVersion

HttpRequest setProtocolVersion(HttpVersion version)

Description copied from interface: HttpMessage

Set the protocol version of this HttpMessage

Specified by:

setProtocolVersion in interface HttpMessage