Package io.micronaut.http

Class MutableHttpRequestWrapper<B>

java.lang.Object

io.micronaut.http.HttpMessageWrapper<B>

io.micronaut.http.HttpRequestWrapper<B>

io.micronaut.http.MutableHttpRequestWrapper<B>

Type Parameters:

B - Body type

All Implemented Interfaces:

AttributeHolder, MutableAttributeHolder, ConversionServiceAware, HttpMessage<B>, HttpRequest<B>, MutableHttpMessage<B>, MutableHttpRequest<B>

@Internal
public class MutableHttpRequestWrapper<B>
extends HttpRequestWrapper<B>
implements MutableHttpRequest<B>

Wrapper around an immutable HttpRequest that allows mutation.

Since:

4.0.0

Field Summary

Fields inherited from interface io.micronaut.http.HttpRequest

SCHEME_HTTP, SCHEME_HTTPS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MutableHttpRequestWrapper(ConversionService conversionService, HttpRequest<B> delegate)

Method Summary

Modifier and Type	Method	Description
<T> MutableHttpRequest<T>	body(T body)	Sets the body.
MutableHttpRequest<B>	cookie(Cookie cookie)	Sets the specified cookie on the request.
@NonNull Optional<B>	getBody()
<T> @NonNull Optional<T>	getBody(@NonNull Class<T> type)	Return the body as the given type.
<T> Optional<T>	getBody(ArgumentConversionContext<T> conversionContext)	Return the body, will use the provided conversion context if needed.
@NonNull MutableHttpHeaders	getHeaders()
@NonNull MutableHttpParameters	getParameters()
@NonNull URI	getUri()
void	setConversionService(ConversionService conversionService)	Sets the conversion service.
MutableHttpRequest<B>	uri(URI uri)	Sets the uri on the request.
static MutableHttpRequest<?>	wrapIfNecessary(ConversionService conversionService, HttpRequest<?> request)

Methods inherited from class io.micronaut.http.HttpRequestWrapper

accept, getCertificate, getCookies, getDelegate, getHttpVersion, getLocale, getMethod, getMethodName, getPath, getRemoteAddress, getServerAddress, getServerName, getSslSession, getUserPrincipal, getUserPrincipal, isSecure, setAttribute

Methods inherited from class io.micronaut.http.HttpMessageWrapper

getAttributes, getBody

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, getBodyWriter, getCharacterEncoding, getContentLength, getContentType

Methods inherited from interface io.micronaut.http.HttpRequest

accept, getCertificate, getCookies, getHttpVersion, getLocale, getMethod, getMethodName, getOrigin, getPath, getRemoteAddress, getServerAddress, getServerName, getSslSession, getUserPrincipal, getUserPrincipal, isSecure, mutate, setAttribute, setUserPrincipal

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

removeAttribute

Methods inherited from interface io.micronaut.http.MutableHttpMessage

bodyWriter

Methods inherited from interface io.micronaut.http.MutableHttpRequest

accept, accept, basicAuth, bearerAuth, contentEncoding, contentLength, contentType, contentType, cookies, header, headers, headers, toMutableRequest, uri

Constructor Details

MutableHttpRequestWrapper

protected MutableHttpRequestWrapper(ConversionService conversionService,
 HttpRequest<B> delegate)

Method Details

wrapIfNecessary

public static MutableHttpRequest<?> wrapIfNecessary(ConversionService conversionService,
 HttpRequest<?> request)

getBody

@NonNull
public @NonNull Optional<B> getBody()

Specified by:

getBody in interface HttpMessage<B>

Overrides:

getBody in class HttpMessageWrapper<B>

Returns:

The request body

getBody

@NonNull
public <T> @NonNull Optional<T> getBody(@NonNull
 @NonNull Class<T> type)

Description copied from interface: HttpMessage

Return the body as the given type.

Specified by:

getBody in interface HttpMessage<B>

Overrides:

getBody in class HttpMessageWrapper<B>

Type Parameters:

T - The generic type

Parameters:

type - The type of the body

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

getBody

public <T> Optional<T> getBody(ArgumentConversionContext<T> conversionContext)

Description copied from interface: HttpMessage

Return the body, will use the provided conversion context if needed.

Specified by:

getBody in interface HttpMessage<B>

Overrides:

getBody in class HttpMessageWrapper<B>

Type Parameters:

T - The generic type

Parameters:

conversionContext - The body conversion context

Returns:

An Optional of the type or Optional.empty() if the body cannot be returned as the given type

cookie

public MutableHttpRequest<B> cookie(Cookie cookie)

Description copied from interface: MutableHttpRequest

Sets the specified cookie on the request.

Specified by:

cookie in interface MutableHttpRequest<B>

Parameters:

cookie - the Cookie to return to the client

Returns:

The http request

uri

public MutableHttpRequest<B> uri(URI uri)

Description copied from interface: MutableHttpRequest

Sets the uri on the request.

Specified by:

uri in interface MutableHttpRequest<B>

Parameters:

uri - The uri to call

Returns:

The http request

getUri

@NonNull
public @NonNull URI getUri()

Specified by:

getUri in interface HttpRequest<B>

Overrides:

getUri in class HttpRequestWrapper<B>

Returns:

The full request URI

getParameters

@NonNull
public @NonNull MutableHttpParameters getParameters()

Specified by:

getParameters in interface HttpRequest<B>

Specified by:

getParameters in interface MutableHttpRequest<B>

Overrides:

getParameters in class HttpRequestWrapper<B>

Returns:

The HTTP parameters contained with the URI query string

getHeaders

@NonNull
public @NonNull MutableHttpHeaders getHeaders()

Specified by:

getHeaders in interface HttpMessage<B>

Specified by:

getHeaders in interface MutableHttpMessage<B>

Specified by:

getHeaders in interface MutableHttpRequest<B>

Overrides:

getHeaders in class HttpMessageWrapper<B>

Returns:

The HttpHeaders object

body

public <T> MutableHttpRequest<T> body(T body)

Description copied from interface: MutableHttpMessage

Sets the body.

Specified by:

body in interface MutableHttpMessage<B>

Specified by:

body in interface MutableHttpRequest<B>

Type Parameters:

T - The new body type

Parameters:

body - The body

Returns:

This message

setConversionService

public void setConversionService(ConversionService conversionService)

Description copied from interface: ConversionServiceAware

Sets the conversion service.

Specified by:

setConversionService in interface ConversionServiceAware

Parameters:

conversionService - The conversion service