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:

JettyHttpHandlerAdapter.JettyServerHttpRequest, TomcatHttpHandlerAdapter.TomcatServerHttpRequest

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
(package private) static DataBuffer	EOF_BUFFER
private HttpServletRequest	request

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

logger

Constructor Summary

Constructors

Constructor and Description
ServletServerHttpRequest(HttpHeaders headers, HttpServletRequest request, AsyncContext asyncContext, java.lang.String servletPath, DataBufferFactory bufferFactory, int bufferSize)
ServletServerHttpRequest(HttpServletRequest request, AsyncContext asyncContext, java.lang.String servletPath, DataBufferFactory bufferFactory, int bufferSize)

Method Summary

Modifier and Type	Method and Description
private static HttpHeaders	createDefaultHttpHeaders(HttpServletRequest request)
<any>	getBody() Return the body of the message as a Publisher.
java.lang.String	getMethodValue() Return the HTTP method of the request as a String value.
<T> T	getNativeRequest() Return the underlying server response.
java.net.InetSocketAddress	getRemoteAddress() Return the remote address where this request is connected to, if available.
private java.lang.String	getSslSessionId()
private java.security.cert.X509Certificate[]	getX509Certificates()
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(HttpHeaders headers, HttpServletRequest request)
protected SslInfo	initSslInfo() Obtain SSL session information from the underlying "native" request.
private static java.net.URI	initUri(HttpServletRequest request)
protected void	logBytesRead(int read)
(package private) DataBuffer	readFromInputStream() Read from the request body InputStream and return a DataBuffer.

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

getCookies, getHeaders, getId, getLogPrefix, getPath, getQueryParams, getSslInfo, getURI, initId, 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

Methods inherited from interface org.springframework.http.HttpRequest

getMethod

Field Detail

EOF_BUFFER

static final DataBuffer EOF_BUFFER

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,
                                java.lang.String servletPath,
                                DataBufferFactory bufferFactory,
                                int bufferSize)
                         throws java.io.IOException,
                                java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

ServletServerHttpRequest

public ServletServerHttpRequest(HttpHeaders headers,
                                HttpServletRequest request,
                                AsyncContext asyncContext,
                                java.lang.String servletPath,
                                DataBufferFactory bufferFactory,
                                int bufferSize)
                         throws java.io.IOException,
                                java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

Method Detail

createDefaultHttpHeaders

private static HttpHeaders createDefaultHttpHeaders(HttpServletRequest request)

initUri

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

Throws:

java.net.URISyntaxException

initHeaders

private static HttpHeaders initHeaders(HttpHeaders headers,
                                       HttpServletRequest request)

getMethodValue

public java.lang.String getMethodValue()

Description copied from interface: HttpRequest

Return the HTTP method of the request as a String value.

Returns:

the HTTP method as a plain String

See Also:

HttpRequest.getMethod()

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.net.InetSocketAddress getRemoteAddress()

Description copied from interface: ServerHttpRequest

Return the remote address where this request is connected to, if available.

initSslInfo

@Nullable
protected SslInfo initSslInfo()

Description copied from class: AbstractServerHttpRequest

Obtain SSL session information from the underlying "native" request.

Specified by:

initSslInfo in class AbstractServerHttpRequest

Returns:

the session information, or null if none available

getSslSessionId

@Nullable
private java.lang.String getSslSessionId()

getX509Certificates

@Nullable
private java.security.cert.X509Certificate[] getX509Certificates()

getBody

public <any> getBody()

Description copied from interface: ReactiveHttpInputMessage

Return the body of the message as a Publisher.

Returns:

the body content publisher

readFromInputStream

@Nullable
DataBuffer readFromInputStream()
                                  throws java.io.IOException

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

Returns:

a DataBuffer with data read, or EOF_BUFFER if the input stream returned -1, or null if 0 bytes were read.

Throws:

java.io.IOException

logBytesRead

protected final void logBytesRead(int read)

getNativeRequest

public <T> T getNativeRequest()

Description copied from class: AbstractServerHttpRequest

Return the underlying server response.

Note: This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module.

Specified by:

getNativeRequest in class AbstractServerHttpRequest