io.micronaut.servlet.http

Interface ServletHttpRequest<N,B>

Type Parameters:

N - The native request type

B - The body type

All Superinterfaces:

io.micronaut.core.attr.AttributeHolder, io.micronaut.http.HttpMessage<B>, io.micronaut.http.HttpRequest<B>, io.micronaut.core.attr.MutableAttributeHolder

All Known Implementing Classes:

DefaultServletHttpRequest

public interface ServletHttpRequest<N,B>
extends io.micronaut.http.HttpRequest<B>

Interface that models a serverless request which typically support blocking I/O.

Since:

2.0.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getContextPath()
java.io.InputStream	getInputStream() Returns an InputStream that can be used to read the body of this HTTP request.
N	getNativeRequest()
java.io.BufferedReader	getReader() Returns a BufferedReader that can be used to read the text body of this HTTP request.
default boolean	isAsyncSupported() Checks if this request supports asynchronous operation.
default 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.

Methods inherited from interface io.micronaut.http.HttpRequest

create, create, DELETE, DELETE, DELETE, GET, GET, getCertificate, getCookies, getLocale, getMethod, getMethodName, getParameters, getPath, getRemoteAddress, getServerAddress, getServerName, getUri, getUserPrincipal, getUserPrincipal, HEAD, HEAD, isSecure, OPTIONS, OPTIONS, PATCH, PATCH, POST, POST, PUT, PUT, setAttribute

Methods inherited from interface io.micronaut.http.HttpMessage

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

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

removeAttribute

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

getAttribute, getAttribute

Method Detail

getContextPath

default java.lang.String getContextPath()

Returns:

The context path of the request.

getInputStream

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

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 getReader() method is more appropriate.

Returns:

The input stream

Throws:

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

java.lang.IllegalStateException - if getReader() has already been called on this instance.

getReader

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

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

Returns:

The reader

Throws:

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

java.lang.IllegalStateException - if getInputStream() has already been called on this instance.

getNativeRequest

N getNativeRequest()

Returns:

The native request type

isAsyncSupported

default boolean isAsyncSupported()

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.

Returns:

true if this request supports asynchronous operation, false otherwise

Since:

Servlet 3.0

subscribeOnExecutor

default 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. The container may propagate appropriate contextual information to the Runnable.

Parameters:

responsePublisher - The response publisher

Returns:

A publisher that emits the response