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

public class ServletServerHttpResponse
extends AbstractListenerServerHttpResponse

Adapt ServerHttpResponse to the Servlet HttpServletResponse.

Since:

5.0

Author:

Rossen Stoyanchev

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 org.reactivestreams.Processor<? super org.reactivestreams.Publisher<? extends DataBuffer>,Void>	createBodyFlushProcessor() Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output.
HttpServletResponse	getServletResponse()
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, isCommitted, setComplete, setStatusCode, writeAndFlushWith, writeWith

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletServerHttpResponse

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

Throws:

IOException

Method Detail

getServletResponse

public HttpServletResponse getServletResponse()

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 org.reactivestreams.Processor<? super org.reactivestreams.Publisher<? extends DataBuffer>,Void> 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 AbstractListenerServerHttpResponse.writeAndFlushWithInternal(Publisher).

Specified by:

createBodyFlushProcessor in class AbstractListenerServerHttpResponse

writeToOutputStream

protected int writeToOutputStream(DataBuffer dataBuffer)
                           throws 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:

IOException