Package io.micronaut.http

Class HttpRequestWrapper<B>

java.lang.Object

io.micronaut.http.HttpMessageWrapper<B>

io.micronaut.http.HttpRequestWrapper<B>

Type Parameters:

B - The Http body type

All Implemented Interfaces:

AttributeHolder, MutableAttributeHolder, HttpMessage<B>, HttpRequest<B>

Direct Known Subclasses:

MutableHttpRequestWrapper

public class HttpRequestWrapper<B>
extends HttpMessageWrapper<B>
implements HttpRequest<B>

A wrapper around a HttpRequest.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.http.HttpRequest

SCHEME_HTTP, SCHEME_HTTPS

Constructor Summary

Constructors

Constructor	Description
HttpRequestWrapper(HttpRequest<B> delegate)

Method Summary

Modifier and Type	Method	Description
Collection<MediaType>	accept()	A list of accepted MediaType instances sorted by their quality rating.
Optional<Certificate>	getCertificate()	Retrieves the Certificate used for mutual authentication.
Cookies	getCookies()
HttpRequest<B>	getDelegate()
HttpVersion	getHttpVersion()
Optional<Locale>	getLocale()
HttpMethod	getMethod()
String	getMethodName()
HttpParameters	getParameters()
String	getPath()
InetSocketAddress	getRemoteAddress()
InetSocketAddress	getServerAddress()
String	getServerName()
Optional<SSLSession>	getSslSession()	Get the SSL session used for the connection to the client, if available.
URI	getUri()
@NonNull Optional<Principal>	getUserPrincipal()	The user principal stored within the request.
<T extends Principal> @NonNull Optional<T>	getUserPrincipal(Class<T> principalType)	The user principal stored within the request.
boolean	isSecure()
HttpRequest<B>	setAttribute(CharSequence name, Object value)	Sets an attribute on the message.

Methods inherited from class io.micronaut.http.HttpMessageWrapper

getAttributes, getBody, getBody, getBody, getBody, getHeaders

Methods inherited from class java.lang.Object

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

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.http.HttpRequest

getOrigin, mutate, toMutableRequest

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

removeAttribute

Constructor Details

HttpRequestWrapper

public HttpRequestWrapper(HttpRequest<B> delegate)

Parameters:

delegate - The Http Request

Method Details

getDelegate

public HttpRequest<B> getDelegate()

Overrides:

getDelegate in class HttpMessageWrapper<B>

Returns:

The Http message

getHttpVersion

public HttpVersion getHttpVersion()

Specified by:

getHttpVersion in interface HttpRequest<B>

Returns:

The http version of the request.

accept

public Collection<MediaType> accept()

Description copied from interface: HttpRequest

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

Specified by:

accept in interface HttpRequest<B>

Returns:

A list of zero or many MediaType instances

getUserPrincipal

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

Description copied from interface: HttpRequest

The user principal stored within the request.

Specified by:

getUserPrincipal in interface HttpRequest<B>

Returns:

The principal

getUserPrincipal

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

Description copied from interface: HttpRequest

The user principal stored within the request.

Specified by:

getUserPrincipal in interface HttpRequest<B>

Type Parameters:

T - The principal type

Parameters:

principalType - The principal type

Returns:

The principal

setAttribute

public 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 HttpRequest<B>

Specified by:

setAttribute in interface MutableAttributeHolder

Parameters:

name - The name of the attribute

value - The value of the attribute

Returns:

This message

getLocale

public Optional<Locale> getLocale()

Specified by:

getLocale in interface HttpMessage<B>

Specified by:

getLocale in interface HttpRequest<B>

Returns:

The locale of the message

getCertificate

public Optional<Certificate> getCertificate()

Description copied from interface: HttpRequest

Retrieves the Certificate used for mutual authentication.

Specified by:

getCertificate in interface HttpRequest<B>

Returns:

A certificate used for authentication, if applicable.

getSslSession

public Optional<SSLSession> getSslSession()

Description copied from interface: HttpRequest

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

Specified by:

getSslSession in interface HttpRequest<B>

Returns:

The session

getCookies

public Cookies getCookies()

Specified by:

getCookies in interface HttpRequest<B>

Returns:

The Cookies instance

getParameters

public HttpParameters getParameters()

Specified by:

getParameters in interface HttpRequest<B>

Returns:

The HTTP parameters contained with the URI query string

getMethod

public HttpMethod getMethod()

Specified by:

getMethod in interface HttpRequest<B>

Returns:

The request method

getMethodName

public String getMethodName()

Specified by:

getMethodName in interface HttpRequest<B>

Returns:

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

getUri

public URI getUri()

Specified by:

getUri in interface HttpRequest<B>

Returns:

The full request URI

getPath

public String getPath()

Specified by:

getPath in interface HttpRequest<B>

Returns:

Get the raw, percent-encoded path without any parameters

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface HttpRequest<B>

Returns:

Obtain the remote address

getServerAddress

public InetSocketAddress getServerAddress()

Specified by:

getServerAddress in interface HttpRequest<B>

Returns:

Obtain the server address

getServerName

public String getServerName()

Specified by:

getServerName in interface HttpRequest<B>

Returns:

The server host name

isSecure

public boolean isSecure()

Specified by:

isSecure in interface HttpRequest<B>

Returns:

Is the request an HTTPS request