Package io.helidon.common.http

Interface HttpRequest

All Known Subinterfaces:

ServerRequest

public interface HttpRequest

Common attributes of an HTTP Request, that are used both in server requests and in client requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpRequest.Path Represents requested normalised URI path.

Method Summary

Modifier and Type	Method and Description
String	fragment() Returns a decoded request URI fragment without leading hash '#' character.
Http.RequestMethod	method() Returns an HTTP request method.
HttpRequest.Path	path() Returns a path which was accepted by matcher in actual routing.
String	query() Returns an encoded query string without leading '?' character.
Parameters	queryParams() Returns query parameters.
URI	uri() Returns a Request-URI (or alternatively path) as defined in request line.
Http.Version	version() Returns an HTTP version from the request line.

Method Detail

method

Http.RequestMethod method()

Returns an HTTP request method. See also HTTP standard methods utility class.

Returns:

an HTTP method

See Also:

Http.Method

version

Http.Version version()

Returns an HTTP version from the request line.

See HTTP Version enumeration for supported versions.

If communication starts as a HTTP/1.1 with h2c upgrade, then it will be automatically upgraded and this method returns HTTP/2.0.

Returns:

an HTTP version

uri

URI uri()

Returns a Request-URI (or alternatively path) as defined in request line.

Returns:

a request URI

query

String query()

Returns an encoded query string without leading '?' character.

Returns:

an encoded query string

queryParams

Parameters queryParams()

Returns query parameters.

Returns:

an parameters representing query parameters

path

HttpRequest.Path path()

Returns a path which was accepted by matcher in actual routing. It is path without a context root of the routing.

Use HttpRequest.Path.absolute() method to obtain absolute request URI path representation.

Returned HttpRequest.Path also provide access to path template parameters. An absolute path then provides access to all (including) context parameters if any. In case of conflict between parameter names, most recent value is returned.

Returns:

a path

fragment

String fragment()

Returns a decoded request URI fragment without leading hash '#' character.

Returns:

a decoded URI fragment