Package io.micronaut.http

Interface HttpRequest<B>

Type Parameters:

B - The Http message body

All Superinterfaces:

AttributeHolder, HttpMessage<B>, MutableAttributeHolder

All Known Subinterfaces:

FullHttpRequest<B>, MutableHttpRequest<B>, PushCapableHttpRequest<B>, ServerHttpRequest<B>

All Known Implementing Classes:

AbstractNettyHttpRequest, HttpRequestWrapper, NettyClientHttpRequest, NettyHttpRequest, SimpleHttpRequest

public interface HttpRequest<B>
extends HttpMessage<B>

Common interface for HTTP request implementations.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEME_HTTP	Constant for HTTP scheme.
static final String	SCHEME_HTTPS	Constant for HTTPS scheme.

Method Summary

Modifier and Type	Method	Description
default Collection<MediaType>	accept()	A list of accepted MediaType instances sorted by their quality rating.
static <T> MutableHttpRequest<T>	create(HttpMethod httpMethod, String uri)	Create a new MutableHttpRequest for the given method and URI.
static <T> MutableHttpRequest<T>	create(HttpMethod httpMethod, String uri, String httpMethodName)	Create a new MutableHttpRequest for the given method and URI.
static <T> MutableHttpRequest<T>	DELETE(String uri)	Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.
static <T> MutableHttpRequest<T>	DELETE(String uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.
static <T> MutableHttpRequest<T>	DELETE(URI uri)	Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.
static <T> MutableHttpRequest<T>	DELETE(URI uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.
static <T> MutableHttpRequest<T>	GET(String uri)	Return a MutableHttpRequest for a HttpMethod.GET request for the given URI.
static <T> MutableHttpRequest<T>	GET(URI uri)	Return a MutableHttpRequest for a HttpMethod.GET request for the given URI.
default Optional<Certificate>	getCertificate()	Retrieves the Certificate used for mutual authentication.
@NonNull Cookies	getCookies()
default HttpVersion	getHttpVersion()
default Optional<Locale>	getLocale()
@NonNull HttpMethod	getMethod()
default @NonNull String	getMethodName()
default Optional<String>	getOrigin()	Get the origin header.
@NonNull HttpParameters	getParameters()
default @NonNull String	getPath()
default @NonNull InetSocketAddress	getRemoteAddress()
default @NonNull InetSocketAddress	getServerAddress()
default @Nullable String	getServerName()
default Optional<SSLSession>	getSslSession()	Get the SSL session used for the connection to the client, if available.
@NonNull URI	getUri()
default @NonNull Optional<Principal>	getUserPrincipal()	The user principal stored within the request.
default <T extends Principal> @NonNull Optional<T>	getUserPrincipal(Class<T> principalType)	The user principal stored within the request.
static MutableHttpRequest<?>	HEAD(String uri)	Return a MutableHttpRequest for a HttpMethod.HEAD request for the given URI.
static MutableHttpRequest<?>	HEAD(URI uri)	Return a MutableHttpRequest for a HttpMethod.HEAD request for the given URI.
default boolean	isSecure()
default MutableHttpRequest<B>	mutate()	Returns a new request object that allows mutation.
static <T> MutableHttpRequest<T>	OPTIONS(String uri)	Return a MutableHttpRequest for a HttpMethod.OPTIONS request for the given URI.
static <T> MutableHttpRequest<T>	OPTIONS(URI uri)	Return a MutableHttpRequest for a HttpMethod.OPTIONS request for the given URI.
static <T> MutableHttpRequest<T>	PATCH(String uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.
static <T> MutableHttpRequest<T>	PATCH(URI uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.
static <T> MutableHttpRequest<T>	POST(String uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.
static <T> MutableHttpRequest<T>	POST(URI uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.
static <T> MutableHttpRequest<T>	PUT(String uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.
static <T> MutableHttpRequest<T>	PUT(URI uri, T body)	Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.
default HttpRequest<B>	setAttribute(CharSequence name, Object value)	Sets an attribute on the message.
default MutableHttpRequest<B>	toMutableRequest()	Returns a mutable request based on this request.

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

getAttributes, getBody, getBody, getBody, getBody, getBodyWriter, getCharacterEncoding, getContentLength, getContentType, getHeaders

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

removeAttribute

Field Details

SCHEME_HTTP

static final String SCHEME_HTTP

Constant for HTTP scheme.

See Also:

• Constant Field Values

SCHEME_HTTPS

static final String SCHEME_HTTPS

Constant for HTTPS scheme.

See Also:

• Constant Field Values

Method Details

getCookies

@NonNull
@NonNull Cookies getCookies()

Returns:

The Cookies instance

getParameters

@NonNull
@NonNull HttpParameters getParameters()

Returns:

The HTTP parameters contained with the URI query string

getMethod

@NonNull
@NonNull HttpMethod getMethod()

Returns:

The request method

getUri

@NonNull
@NonNull URI getUri()

Returns:

The full request URI

mutate

default MutableHttpRequest<B> mutate()

Returns a new request object that allows mutation.

Returns:

The mutable request

Since:

2.0.0

getHttpVersion

default HttpVersion getHttpVersion()

Returns:

The http version of the request.

accept

default Collection<MediaType> accept()

A list of accepted MediaType instances sorted by their quality rating.

Returns:

A list of zero or many MediaType instances

getMethodName

@NonNull
default @NonNull String getMethodName()

Returns:

The name of the method (same as HttpMethod value for standard http methods).

getUserPrincipal

@NonNull
default @NonNull Optional<Principal> getUserPrincipal()

The user principal stored within the request.

Returns:

The principal

Since:

1.0.4

getUserPrincipal

@NonNull
default <T extends Principal> @NonNull Optional<T> getUserPrincipal(Class<T> principalType)

The user principal stored within the request.

Type Parameters:

T - The principal type

Parameters:

principalType - The principal type

Returns:

The principal

Since:

1.0.4

getPath

@NonNull
default @NonNull String getPath()

Returns:

Get the raw, percent-encoded path without any parameters

getRemoteAddress

@NonNull
default @NonNull InetSocketAddress getRemoteAddress()

Returns:

Obtain the remote address

getServerAddress

@NonNull
default @NonNull InetSocketAddress getServerAddress()

Returns:

Obtain the server address

getServerName

@Nullable
default @Nullable String getServerName()

Returns:

The server host name

isSecure

default boolean isSecure()

Returns:

Is the request an HTTPS request

setAttribute

default HttpRequest<B> setAttribute(CharSequence name,
 Object value)

Description copied from interface: MutableAttributeHolder

Sets an attribute on the message.

Specified by:

setAttribute in interface HttpMessage<B>

Specified by:

setAttribute in interface MutableAttributeHolder

Parameters:

name - The name of the attribute

value - The value of the attribute

Returns:

This message

getLocale

default Optional<Locale> getLocale()

Specified by:

getLocale in interface HttpMessage<B>

Returns:

The locale of the message

getCertificate

default Optional<Certificate> getCertificate()

Retrieves the Certificate used for mutual authentication.

Returns:

A certificate used for authentication, if applicable.

getSslSession

default Optional<SSLSession> getSslSession()

Get the SSL session used for the connection to the client, if available.

Returns:

The session

getOrigin

default Optional<String> getOrigin()

Get the origin header.

Returns:

The origin header

See Also:

• HttpHeaders.getOrigin()

GET

static <T> MutableHttpRequest<T> GET(URI uri)

Return a MutableHttpRequest for a HttpMethod.GET request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

GET

static <T> MutableHttpRequest<T> GET(String uri)

Return a MutableHttpRequest for a HttpMethod.GET request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

OPTIONS

static <T> MutableHttpRequest<T> OPTIONS(URI uri)

Return a MutableHttpRequest for a HttpMethod.OPTIONS request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

OPTIONS

static <T> MutableHttpRequest<T> OPTIONS(String uri)

Return a MutableHttpRequest for a HttpMethod.OPTIONS request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

HEAD

static MutableHttpRequest<?> HEAD(URI uri)

Return a MutableHttpRequest for a HttpMethod.HEAD request for the given URI.

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

HEAD

static MutableHttpRequest<?> HEAD(String uri)

Return a MutableHttpRequest for a HttpMethod.HEAD request for the given URI.

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

POST

static <T> MutableHttpRequest<T> POST(URI uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

POST

static <T> MutableHttpRequest<T> POST(String uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.POST request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

PUT

static <T> MutableHttpRequest<T> PUT(URI uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

PUT

static <T> MutableHttpRequest<T> PUT(String uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.PUT request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

PATCH

static <T> MutableHttpRequest<T> PATCH(URI uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

PATCH

static <T> MutableHttpRequest<T> PATCH(String uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.PATCH request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

DELETE

static <T> MutableHttpRequest<T> DELETE(URI uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

DELETE

static <T> MutableHttpRequest<T> DELETE(String uri,
 T body)

Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.

Type Parameters:

T - The body type

Parameters:

uri - The URI

body - The body of the request (content type defaults to MediaType.APPLICATION_JSON

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

DELETE

static <T> MutableHttpRequest<T> DELETE(String uri)

Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

DELETE

static <T> MutableHttpRequest<T> DELETE(URI uri)

Return a MutableHttpRequest that executes an HttpMethod.DELETE request for the given URI.

Type Parameters:

T - The Http request type

Parameters:

uri - The URI

Returns:

The MutableHttpRequest instance

See Also:

• HttpRequestFactory

create

static <T> MutableHttpRequest<T> create(HttpMethod httpMethod,
 String uri)

Create a new MutableHttpRequest for the given method and URI.

Type Parameters:

T - The Http request type

Parameters:

httpMethod - The method

uri - The URI

Returns:

The request

create

static <T> MutableHttpRequest<T> create(HttpMethod httpMethod,
 String uri,
 String httpMethodName)

Create a new MutableHttpRequest for the given method and URI.

Type Parameters:

T - The Http request type

Parameters:

httpMethod - The method

uri - The URI

httpMethodName - Method name - for standard http methods is equal to Enum.name()

Returns:

The request

toMutableRequest

default MutableHttpRequest<B> toMutableRequest()

Returns a mutable request based on this request.

Returns:

the mutable request

Since:

4.7