io.micronaut.servlet.engine

Class DefaultServletHttpRequest<B>

java.lang.Object

io.micronaut.servlet.engine.DefaultServletHttpRequest<B>

Type Parameters:

B - The body type

All Implemented Interfaces:

io.micronaut.core.attr.AttributeHolder, io.micronaut.core.attr.MutableAttributeHolder, io.micronaut.core.convert.value.ConvertibleValues<java.lang.Object>, io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>, io.micronaut.core.value.ValueResolver<java.lang.CharSequence>, io.micronaut.http.HttpMessage<B>, io.micronaut.http.HttpRequest<B>, ServletExchange<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>, ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>, StreamedServletMessage<B,byte[]>, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>, org.reactivestreams.Publisher<byte[]>

@Internal
public class DefaultServletHttpRequest<B>
extends java.lang.Object
implements ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>, io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>, ServletExchange<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>, StreamedServletMessage<B,byte[]>

Implementation of HttpRequest ontop of the Servlet API.

Since:

1.0.0

Author:

graemerocher

Field Summary

Fields inherited from interface io.micronaut.http.HttpRequest

SCHEME_HTTP, SCHEME_HTTPS

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultServletHttpRequest(javax.servlet.http.HttpServletRequest delegate, javax.servlet.http.HttpServletResponse response, io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry) Default constructor.

Method Summary

Modifier and Type	Method and Description
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	clear()
<T> java.util.Optional<T>	get(java.lang.CharSequence key, io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	getAttributes()
java.util.Optional<B>	getBody()
<T> java.util.Optional<T>	getBody(io.micronaut.core.type.Argument<T> arg)
java.nio.charset.Charset	getCharacterEncoding()
io.micronaut.http.codec.MediaTypeCodecRegistry	getCodecRegistry()
long	getContentLength()
java.util.Optional<io.micronaut.http.MediaType>	getContentType()
java.lang.String	getContextPath()
io.micronaut.http.cookie.Cookies	getCookies()
io.micronaut.http.HttpHeaders	getHeaders()
java.io.InputStream	getInputStream() Returns an InputStream that can be used to read the body of this HTTP request.
java.util.Optional<java.util.Locale>	getLocale()
io.micronaut.http.HttpMethod	getMethod()
java.lang.String	getMethodName()
javax.servlet.http.HttpServletRequest	getNativeRequest()
io.micronaut.http.HttpParameters	getParameters()
java.io.BufferedReader	getReader() Returns a BufferedReader that can be used to read the text body of this HTTP request.
java.net.InetSocketAddress	getRemoteAddress()
ServletHttpRequest<javax.servlet.http.HttpServletRequest,? super java.lang.Object>	getRequest()
ServletHttpResponse<javax.servlet.http.HttpServletResponse,? super java.lang.Object>	getResponse()
java.net.InetSocketAddress	getServerAddress()
java.lang.String	getServerName()
java.net.URI	getUri()
java.util.Optional<java.security.Principal>	getUserPrincipal()
boolean	isAsyncSupported() Checks if this request supports asynchronous operation.
boolean	isSecure()
java.util.Set<java.lang.String>	names()
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	put(java.lang.CharSequence key, java.lang.Object value)
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	remove(java.lang.CharSequence key)
void	subscribe(org.reactivestreams.Subscriber<? super byte[]> s)
org.reactivestreams.Publisher<? extends io.micronaut.http.MutableHttpResponse<?>>	subscribeOnExecutor(org.reactivestreams.Publisher<? extends io.micronaut.http.MutableHttpResponse<?>> responsePublisher) Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable.
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.HttpRequest

accept, create, create, DELETE, DELETE, DELETE, GET, GET, getCertificate, getHttpVersion, getPath, getUserPrincipal, HEAD, HEAD, mutate, OPTIONS, OPTIONS, PATCH, PATCH, POST, POST, PUT, PUT, setAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

getBody

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

removeAttribute

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

getAttribute, getAttribute

Methods inherited from interface io.micronaut.core.convert.value.MutableConvertibleValues

of, putAll, putAll

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, empty, forEach, getValue, getValueType, isEmpty, iterator, subMap, subMap, subMap

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultServletHttpRequest

protected DefaultServletHttpRequest(javax.servlet.http.HttpServletRequest delegate,
                                    javax.servlet.http.HttpServletResponse response,
                                    io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry)

Default constructor.

Parameters:

delegate - The servlet request

response - The servlet response

codecRegistry - The codec registry

Method Detail

getCodecRegistry

public io.micronaut.http.codec.MediaTypeCodecRegistry getCodecRegistry()

Returns:

The codec registry.

isAsyncSupported

public boolean isAsyncSupported()

Description copied from interface: ServletHttpRequest

Checks if this request supports asynchronous operation.

Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.

Specified by:

isAsyncSupported in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Returns:

true if this request supports asynchronous operation, false otherwise

subscribeOnExecutor

public org.reactivestreams.Publisher<? extends io.micronaut.http.MutableHttpResponse<?>> subscribeOnExecutor(org.reactivestreams.Publisher<? extends io.micronaut.http.MutableHttpResponse<?>> responsePublisher)

Description copied from interface: ServletHttpRequest

Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable. The container may propagate appropriate contextual information to the Runnable.

Specified by:

subscribeOnExecutor in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Parameters:

responsePublisher - The response publisher

Returns:

A publisher that emits the response

getBody

@NonNull
public <T> java.util.Optional<T> getBody(@NonNull
                                                  io.micronaut.core.type.Argument<T> arg)

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

getUserPrincipal

@NonNull
public java.util.Optional<java.security.Principal> getUserPrincipal()

Specified by:

getUserPrincipal in interface io.micronaut.http.HttpRequest<B>

isSecure

public boolean isSecure()

Specified by:

isSecure in interface io.micronaut.http.HttpRequest<B>

getContentType

@NonNull
public java.util.Optional<io.micronaut.http.MediaType> getContentType()

Specified by:

getContentType in interface io.micronaut.http.HttpMessage<B>

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface io.micronaut.http.HttpMessage<B>

getRemoteAddress

@NonNull
public java.net.InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface io.micronaut.http.HttpRequest<B>

getServerAddress

@NonNull
public java.net.InetSocketAddress getServerAddress()

Specified by:

getServerAddress in interface io.micronaut.http.HttpRequest<B>

getServerName

@Nullable
public java.lang.String getServerName()

Specified by:

getServerName in interface io.micronaut.http.HttpRequest<B>

getLocale

@NonNull
public java.util.Optional<java.util.Locale> getLocale()

Specified by:

getLocale in interface io.micronaut.http.HttpMessage<B>

Specified by:

getLocale in interface io.micronaut.http.HttpRequest<B>

getCharacterEncoding

@NonNull
public java.nio.charset.Charset getCharacterEncoding()

Specified by:

getCharacterEncoding in interface io.micronaut.http.HttpMessage<B>

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Returns:

The context path of the request.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from interface: ServletHttpRequest

Returns an InputStream that can be used to read the body of this HTTP request. This method is typically used to read binary data. If the body is text, the ServletHttpRequest.getReader() method is more appropriate.

Specified by:

getInputStream in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Returns:

The input stream

Throws:

java.io.IOException - if a valid InputStream cannot be returned for some reason.

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Description copied from interface: ServletHttpRequest

Returns a BufferedReader that can be used to read the text body of this HTTP request.

Specified by:

getReader in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Returns:

The reader

Throws:

java.io.IOException - if a valid BufferedReader cannot be returned for some reason.

getNativeRequest

public javax.servlet.http.HttpServletRequest getNativeRequest()

Specified by:

getNativeRequest in interface ServletHttpRequest<javax.servlet.http.HttpServletRequest,B>

Returns:

The native request type

getCookies

@NonNull
public io.micronaut.http.cookie.Cookies getCookies()

Specified by:

getCookies in interface io.micronaut.http.HttpRequest<B>

getParameters

@NonNull
public io.micronaut.http.HttpParameters getParameters()

Specified by:

getParameters in interface io.micronaut.http.HttpRequest<B>

getMethod

@NonNull
public io.micronaut.http.HttpMethod getMethod()

Specified by:

getMethod in interface io.micronaut.http.HttpRequest<B>

getMethodName

@NonNull
public java.lang.String getMethodName()

Specified by:

getMethodName in interface io.micronaut.http.HttpRequest<B>

getUri

@NonNull
public java.net.URI getUri()

Specified by:

getUri in interface io.micronaut.http.HttpRequest<B>

getHeaders

@NonNull
public io.micronaut.http.HttpHeaders getHeaders()

Specified by:

getHeaders in interface io.micronaut.http.HttpMessage<B>

getAttributes

@NonNull
public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> getAttributes()

Specified by:

getAttributes in interface io.micronaut.core.attr.AttributeHolder

Specified by:

getAttributes in interface io.micronaut.core.attr.MutableAttributeHolder

Specified by:

getAttributes in interface io.micronaut.http.HttpMessage<B>

getBody

@NonNull
public java.util.Optional<B> getBody()

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

put

public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> put(java.lang.CharSequence key,
                                                                                      @Nullable
                                                                                      java.lang.Object value)

Specified by:

put in interface io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>

remove

public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> remove(java.lang.CharSequence key)

Specified by:

remove in interface io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>

clear

public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> clear()

Specified by:

clear in interface io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>

names

public java.util.Set<java.lang.String> names()

Specified by:

names in interface io.micronaut.core.convert.value.ConvertibleValues<java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface io.micronaut.core.convert.value.ConvertibleValues<java.lang.Object>

get

public <T> java.util.Optional<T> get(java.lang.CharSequence key,
                                     io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)

Specified by:

get in interface io.micronaut.core.value.ValueResolver<java.lang.CharSequence>

getRequest

public ServletHttpRequest<javax.servlet.http.HttpServletRequest,? super java.lang.Object> getRequest()

Specified by:

getRequest in interface ServletExchange<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

The request object

getResponse

public ServletHttpResponse<javax.servlet.http.HttpServletResponse,? super java.lang.Object> getResponse()

Specified by:

getResponse in interface ServletExchange<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

The response object

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super byte[]> s)

Specified by:

subscribe in interface org.reactivestreams.Publisher<byte[]>