org.springframework.http.server.reactive

Class ServletServerHttpRequest

java.lang.Object

org.springframework.http.server.reactive.AbstractServerHttpRequest

org.springframework.http.server.reactive.ServletServerHttpRequest

All Implemented Interfaces:

HttpMessage, HttpRequest, ReactiveHttpInputMessage, ServerHttpRequest

Direct Known Subclasses:

TomcatHttpHandlerAdapter.TomcatServerHttpRequest

public class ServletServerHttpRequest
extends AbstractServerHttpRequest

Adapt ServerHttpRequest to the Servlet HttpServletRequest.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ServletServerHttpRequest.RequestAsyncListener
private class	ServletServerHttpRequest.RequestBodyPublisher

Nested classes/interfaces inherited from interface org.springframework.http.server.reactive.ServerHttpRequest

ServerHttpRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private ServletServerHttpRequest.RequestBodyPublisher	bodyPublisher
private byte[]	buffer
private DataBufferFactory	bufferFactory
private java.lang.Object	cookieLock
protected Log	logger
private HttpServletRequest	request

Constructor Summary

Constructors

Constructor and Description
ServletServerHttpRequest(HttpServletRequest request, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize)

Method Summary

Modifier and Type	Method and Description
<any>	getBody() Return the body of the message as a Publisher.
java.lang.String	getContextPath() Returns the portion of the URL path that represents the context path for the current HttpHandler.
HttpMethod	getMethod() Return the HTTP method of the request.
java.util.Optional<java.net.InetSocketAddress>	getRemoteAddress() Returns the remote address where this request is connected to.
HttpServletRequest	getServletRequest()
protected MultiValueMap<java.lang.String,HttpCookie>	initCookies() Obtain the cookies from the underlying "native" request and adapt those to an HttpCookie map.
private static HttpHeaders	initHeaders(HttpServletRequest request)
private static java.net.URI	initUri(HttpServletRequest request)
protected DataBuffer	readFromInputStream() Read from the request body InputStream and return a DataBuffer.

Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpRequest

getCookies, getHeaders, getQueryParams, getURI, initQueryParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.server.reactive.ServerHttpRequest

mutate

Field Detail

logger

protected final Log logger

request

private final HttpServletRequest request

bodyPublisher

private final ServletServerHttpRequest.RequestBodyPublisher bodyPublisher

cookieLock

private final java.lang.Object cookieLock

bufferFactory

private final DataBufferFactory bufferFactory

buffer

private final byte[] buffer

Constructor Detail

ServletServerHttpRequest

public ServletServerHttpRequest(HttpServletRequest request,
                                AsyncContext asyncContext,
                                DataBufferFactory bufferFactory,
                                int bufferSize)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

initUri

private static java.net.URI initUri(HttpServletRequest request)

initHeaders

private static HttpHeaders initHeaders(HttpServletRequest request)

getServletRequest

public HttpServletRequest getServletRequest()

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Returns:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

getContextPath

public java.lang.String getContextPath()

Description copied from interface: ServerHttpRequest

Returns the portion of the URL path that represents the context path for the current HttpHandler. The context path is always at the beginning of the request path. It starts with "/" but but does not end with "/". This method may return an empty string if no context path is configured.

Returns:

the context path (not decoded) or an empty string

initCookies

protected MultiValueMap<java.lang.String,HttpCookie> initCookies()

Description copied from class: AbstractServerHttpRequest

Obtain the cookies from the underlying "native" request and adapt those to an HttpCookie map. The return value is turned into an immutable map and cached.

Note that this method is invoked lazily on access to AbstractServerHttpRequest.getCookies(). Sub-classes should synchronize cookie initialization if the underlying "native" request does not provide thread-safe access to cookie data.

Specified by:

initCookies in class AbstractServerHttpRequest

getRemoteAddress

public java.util.Optional<java.net.InetSocketAddress> getRemoteAddress()

Description copied from interface: ServerHttpRequest

Returns the remote address where this request is connected to.

Returns:

remote address if available

getBody

public <any> getBody()

Description copied from interface: ReactiveHttpInputMessage

Return the body of the message as a Publisher.

Returns:

the body content publisher

readFromInputStream

protected DataBuffer readFromInputStream()
                                  throws java.io.IOException

Read from the request body InputStream and return a DataBuffer. Invoked only when ServletInputStream#isReady() returns "true".

Throws:

java.io.IOException