org.springframework.http.server.reactive

Class ServletServerHttpResponse

java.lang.Object

org.springframework.http.server.reactive.AbstractServerHttpResponse

org.springframework.http.server.reactive.AbstractListenerServerHttpResponse

org.springframework.http.server.reactive.ServletServerHttpResponse

All Implemented Interfaces:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse

Direct Known Subclasses:

JettyHttpHandlerAdapter.JettyServerHttpResponse, TomcatHttpHandlerAdapter.TomcatServerHttpResponse

class ServletServerHttpResponse
extends AbstractListenerServerHttpResponse

Adapt ServerHttpResponse to the Servlet HttpServletResponse.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ServletServerHttpResponse.ResponseAsyncListener
private class	ServletServerHttpResponse.ResponseBodyFlushProcessor
private class	ServletServerHttpResponse.ResponseBodyProcessor
private class	ServletServerHttpResponse.ResponseBodyWriteListener

Field Summary

Fields

Modifier and Type	Field and Description
private ServletServerHttpResponse.ResponseBodyFlushProcessor	bodyFlushProcessor
private ServletServerHttpResponse.ResponseBodyProcessor	bodyProcessor
private int	bufferSize
private boolean	flushOnNext
private ServletOutputStream	outputStream
private HttpServletResponse	response

Constructor Summary

Constructors

Constructor and Description
ServletServerHttpResponse(HttpServletResponse response, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize)

Method Summary

Modifier and Type	Method and Description
protected void	applyCookies() Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyHeaders() Apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyStatusCode() Write the status code to the underlying response.
protected <any>	createBodyFlushProcessor() Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output.
private void	flush()
<T> T	getNativeResponse() Return the underlying server response.
private boolean	isWritePossible()
protected int	writeToOutputStream(DataBuffer dataBuffer) Write the DataBuffer to the response body OutputStream.

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

writeAndFlushWithInternal, writeWithInternal

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

addCookie, beforeCommit, bufferFactory, doCommit, doCommit, getCookies, getHeaders, getStatusCode, getStatusCodeValue, isCommitted, setComplete, setStatusCode, setStatusCodeValue, writeAndFlushWith, writeWith

Methods inherited from class java.lang.Object

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

Field Detail

response

private final HttpServletResponse response

outputStream

private final ServletOutputStream outputStream

bufferSize

private final int bufferSize

bodyFlushProcessor

@Nullable
private volatile ServletServerHttpResponse.ResponseBodyFlushProcessor bodyFlushProcessor

bodyProcessor

@Nullable
private volatile ServletServerHttpResponse.ResponseBodyProcessor bodyProcessor

flushOnNext

private volatile boolean flushOnNext

Constructor Detail

ServletServerHttpResponse

public ServletServerHttpResponse(HttpServletResponse response,
                                 AsyncContext asyncContext,
                                 DataBufferFactory bufferFactory,
                                 int bufferSize)
                          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getNativeResponse

public <T> T getNativeResponse()

Description copied from class: AbstractServerHttpResponse

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:

getNativeResponse in class AbstractServerHttpResponse

applyStatusCode

protected void applyStatusCode()

Description copied from class: AbstractServerHttpResponse

Write the status code to the underlying response. This method is called once only.

Specified by:

applyStatusCode in class AbstractServerHttpResponse

applyHeaders

protected void applyHeaders()

Description copied from class: AbstractServerHttpResponse

Apply header changes from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyHeaders in class AbstractServerHttpResponse

applyCookies

protected void applyCookies()

Description copied from class: AbstractServerHttpResponse

Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

Specified by:

applyCookies in class AbstractServerHttpResponse

createBodyFlushProcessor

protected <any> createBodyFlushProcessor()

Description copied from class: AbstractListenerServerHttpResponse

Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output. Called from #writeAndFlushWithInternal(Publisher).

Specified by:

createBodyFlushProcessor in class AbstractListenerServerHttpResponse

writeToOutputStream

protected int writeToOutputStream(DataBuffer dataBuffer)
                           throws java.io.IOException

Write the DataBuffer to the response body OutputStream. Invoked only when ServletOutputStream#isReady() returns "true" and the readable bytes in the DataBuffer is greater than 0.

Returns:

the number of bytes written

Throws:

java.io.IOException

flush

private void flush()
            throws java.io.IOException

Throws:

java.io.IOException

isWritePossible

private boolean isWritePossible()