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

Modifier and Type	Field and Description
private final ServletServerHttpResponse.ResponseAsyncListener	asyncListener
private volatile ServletServerHttpResponse.ResponseBodyFlushProcessor	bodyFlushProcessor
private volatile ServletServerHttpResponse.ResponseBodyProcessor	bodyProcessor
private final int	bufferSize
private volatile boolean	flushOnNext
private final ServletOutputStream	outputStream
private final ServletServerHttpRequest	request
private final HttpServletResponse	response

Access	Constructor and Description
public	ServletServerHttpResponse(HttpServletResponse response, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request)
public	ServletServerHttpResponse(HttpHeaders headers, HttpServletResponse response, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request)

Method Summary

Modifier and Type	Method and Description
protected void	adaptHeaders(boolean removeAdaptedHeaders)
protected void	applyCookies() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyCookies. Add cookies from `getHeaders()` to the underlying response.
protected void	applyHeaders() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyHeaders. Invoked when the response is getting committed allowing subclasses to make apply header values to the underlying response.
protected void	applyStatusCode() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyStatusCode. Write the status code to the underlying response.
protected Processor<? super Publisher<? extends DataBuffer>, Void>	createBodyFlushProcessor() Implements abstract org.springframework.http.server.reactive.AbstractListenerServerHttpResponse.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()
pack-priv AsyncListener	getAsyncListener() Return an `ResponseAsyncListener` that notifies the response body Publisher and Subscriber of Servlet container events.
public <T> T	getNativeResponse() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.getNativeResponse. Return the underlying server response.
protected final ServletOutputStream	getOutputStream() Return the `ServletOutputStream` for the current response.
public Integer	getRawStatusCode() Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getRawStatusCode. Overrides default org.springframework.http.server.reactive.ServerHttpResponse.getRawStatusCode. Deprecated Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.
public HttpStatusCode	getStatusCode() Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getStatusCode. Implements org.springframework.http.server.reactive.ServerHttpResponse.getStatusCode. Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.
private boolean	isWritePossible()
protected int	Returns: the number of bytes written writeToOutputStream(DataBuffer dataBuffer) Write the DataBuffer to the response body OutputStream.

Inherited from org.springframework.http.server.reactive.AbstractListenerServerHttpResponse:: writeAndFlushWithInternal writeWithInternal

Field Detail

asyncListener	back to summary
private final ServletServerHttpResponse.ResponseAsyncListener asyncListener

bodyFlushProcessor	back to summary
private volatile ServletServerHttpResponse.ResponseBodyFlushProcessor bodyFlushProcessor Annotations @Nullable

bodyProcessor	back to summary
private volatile ServletServerHttpResponse.ResponseBodyProcessor bodyProcessor Annotations @Nullable

bufferSize	back to summary
private final int bufferSize

flushOnNext	back to summary
private volatile boolean flushOnNext

outputStream	back to summary
private final ServletOutputStream outputStream

request	back to summary
private final ServletServerHttpRequest request

response	back to summary
private final HttpServletResponse response

Constructor Detail

ServletServerHttpResponse	back to summary
public ServletServerHttpResponse(HttpServletResponse response, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request) throws IOException

ServletServerHttpResponse	back to summary
public ServletServerHttpResponse(HttpHeaders headers, HttpServletResponse response, AsyncContext asyncContext, DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request) throws IOException

Method Detail

adaptHeaders	back to summary
protected void adaptHeaders(boolean removeAdaptedHeaders)

applyCookies back to summary

protected void applyCookies()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyCookies.

Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.applyCookies.

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

Annotations

@Override

applyHeaders back to summary

applyHeaders	back to summary
protected void applyHeaders() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyHeaders. Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.applyHeaders. Invoked when the response is getting committed allowing subclasses to make apply header values to the underlying response. Note that some subclasses use an `HttpHeaders` instance that wraps an adapter to the native response headers such that changes are propagated to the underlying response on the go. That means this callback might not be used other than for specialized updates such as setting the contentType or characterEncoding fields in a Servlet response. Annotations @Override

protected void applyHeaders()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyHeaders.

Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.applyHeaders.

Invoked when the response is getting committed allowing subclasses to make apply header values to the underlying response.

Note that some subclasses use an HttpHeaders instance that wraps an adapter to the native response headers such that changes are propagated to the underlying response on the go. That means this callback might not be used other than for specialized updates such as setting the contentType or characterEncoding fields in a Servlet response.

Annotations

@Override

applyStatusCode	back to summary
protected void applyStatusCode() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyStatusCode. Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.applyStatusCode. Write the status code to the underlying response. This method is called once only. Annotations @Override

applyStatusCode

back to summary

protected void applyStatusCode()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.applyStatusCode.

Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.applyStatusCode.

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

Annotations

@Override

createBodyFlushProcessor back to summary

createBodyFlushProcessor	back to summary
protected Processor<? super Publisher<? extends DataBuffer>, Void> createBodyFlushProcessor() Implements abstract org.springframework.http.server.reactive.AbstractListenerServerHttpResponse.createBodyFlushProcessor. Doc from org.springframework.http.server.reactive.AbstractListenerServerHttpResponse.createBodyFlushProcessor. 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)`. Annotations @Override

protected Processor<? super Publisher<? extends DataBuffer>, Void> createBodyFlushProcessor()

Implements abstract org.springframework.http.server.reactive.AbstractListenerServerHttpResponse.createBodyFlushProcessor.

Doc from org.springframework.http.server.reactive.AbstractListenerServerHttpResponse.createBodyFlushProcessor.

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).

Annotations

@Override

flush	back to summary
private void flush() throws IOException

getAsyncListener	back to summary
pack-priv AsyncListener getAsyncListener() Return an `ResponseAsyncListener` that notifies the response body Publisher and Subscriber of Servlet container events. The listener is not actually registered but is rather exposed for `ServletHttpHandlerAdapter` to ensure events are delegated.

getNativeResponse	back to summary
public <T> T getNativeResponse() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.getNativeResponse. Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.getNativeResponse. Return the underlying server response. Note This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module. Annotations @SuppressWarnings:unchecked @Override

getNativeResponse

back to summary

public <T> T getNativeResponse()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpResponse.getNativeResponse.

Doc from org.springframework.http.server.reactive.AbstractServerHttpResponse.getNativeResponse.

Return the underlying server response.

Note

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

Annotations

@SuppressWarnings:unchecked
@Override

getOutputStream	back to summary
protected final ServletOutputStream getOutputStream() Return the `ServletOutputStream` for the current response.

getRawStatusCode back to summary

getRawStatusCode	back to summary
public Integer getRawStatusCode() Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getRawStatusCode. Overrides default org.springframework.http.server.reactive.ServerHttpResponse.getRawStatusCode. Doc from org.springframework.http.server.reactive.ServerHttpResponse.getRawStatusCode. Deprecated Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be `null` if there is no default value from the underlying server. Annotations @Override @Deprecated

public Integer getRawStatusCode()

Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getRawStatusCode.

Overrides default org.springframework.http.server.reactive.ServerHttpResponse.getRawStatusCode.

Doc from org.springframework.http.server.reactive.ServerHttpResponse.getRawStatusCode.

Deprecated

Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be null if there is no default value from the underlying server.

Annotations

@Override
@Deprecated

getStatusCode back to summary

getStatusCode	back to summary
public HttpStatusCode getStatusCode() Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getStatusCode. Implements org.springframework.http.server.reactive.ServerHttpResponse.getStatusCode. Doc from org.springframework.http.server.reactive.ServerHttpResponse.getStatusCode. Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be `null` if there is no default value from the underlying server. Annotations @Override

public HttpStatusCode getStatusCode()

Overrides org.springframework.http.server.reactive.AbstractServerHttpResponse.getStatusCode.

Implements org.springframework.http.server.reactive.ServerHttpResponse.getStatusCode.

Doc from org.springframework.http.server.reactive.ServerHttpResponse.getStatusCode.

Annotations

@Override

isWritePossible	back to summary
private boolean isWritePossible()

writeToOutputStream back to summary

writeToOutputStream	back to summary
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:int the number of bytes written

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:int: the number of bytes written

org.springframework.http.server.reactive back to summary

private final Class ServletServerHttpResponse.ResponseAsyncListener

Class Inheritance

extends Object
implements AsyncListener

java.lang.Object
org.springframework.http.server.reactive.ServletServerHttpResponse.ResponseAsyncListener

All Implemented Interfaces

jakarta.servlet.AsyncListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	ResponseAsyncListener()

Method Summary

Modifier and Type	Method and Description
public void	handleError(Throwable ex)
public void	onComplete(AsyncEvent Provides access to the objects associated with the event event) Implements jakarta.servlet.AsyncListener.onComplete. This event is fired after the call to `AsyncContext#complete()` has been processed by the container.
public void	onError(AsyncEvent Provides access to the objects associated with the event event) Implements jakarta.servlet.AsyncListener.onError. This event is fired if an error occurs during an asynchronous operation but before the container takes any action as a result of the error.
public void	onStartAsync(AsyncEvent Provides access to the objects associated with the event event) Implements jakarta.servlet.AsyncListener.onStartAsync. This event is fired if new call is made to `ServletRequest#startAsync()` after the completion of the `AsyncContext` to which this listener was added.
public void	onTimeout(AsyncEvent Provides access to the objects associated with the event event) Implements jakarta.servlet.AsyncListener.onTimeout. This event is fired if an asynchronous operation times out but before the container takes any action as a result of the timeout.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ResponseAsyncListener	back to summary
private ResponseAsyncListener()

Method Detail

handleError	back to summary
public void handleError(Throwable ex)

onComplete back to summary

onComplete	back to summary
public void onComplete(AsyncEvent event) Implements jakarta.servlet.AsyncListener.onComplete. Doc from jakarta.servlet.AsyncListener.onComplete. This event is fired after the call to `AsyncContext#complete()` has been processed by the container. Parameters event:AsyncEvent Provides access to the objects associated with the event Annotations @Override

public void onComplete(AsyncEvent event)

Implements jakarta.servlet.AsyncListener.onComplete.

Doc from jakarta.servlet.AsyncListener.onComplete.

This event is fired after the call to AsyncContext#complete() has been processed by the container.

Parameters

event:AsyncEvent: Provides access to the objects associated with the event

Annotations

@Override

onError	back to summary
public void onError(AsyncEvent event) Implements jakarta.servlet.AsyncListener.onError. Doc from jakarta.servlet.AsyncListener.onError. This event is fired if an error occurs during an asynchronous operation but before the container takes any action as a result of the error. Parameters event:AsyncEvent Provides access to the objects associated with the event Annotations @Override

onError

back to summary

public void onError(AsyncEvent event)

Implements jakarta.servlet.AsyncListener.onError.

Doc from jakarta.servlet.AsyncListener.onError.

This event is fired if an error occurs during an asynchronous operation but before the container takes any action as a result of the error.

Parameters

event:AsyncEvent: Provides access to the objects associated with the event

Annotations

@Override

onStartAsync back to summary

onStartAsync	back to summary
public void onStartAsync(AsyncEvent event) Implements jakarta.servlet.AsyncListener.onStartAsync. Doc from jakarta.servlet.AsyncListener.onStartAsync. This event is fired if new call is made to `ServletRequest#startAsync()` after the completion of the `AsyncContext` to which this listener was added. Parameters event:AsyncEvent Provides access to the objects associated with the event Annotations @Override

public void onStartAsync(AsyncEvent event)

Implements jakarta.servlet.AsyncListener.onStartAsync.

Doc from jakarta.servlet.AsyncListener.onStartAsync.

This event is fired if new call is made to ServletRequest#startAsync() after the completion of the AsyncContext to which this listener was added.

Parameters

event:AsyncEvent: Provides access to the objects associated with the event

Annotations

@Override

onTimeout	back to summary
public void onTimeout(AsyncEvent event) Implements jakarta.servlet.AsyncListener.onTimeout. Doc from jakarta.servlet.AsyncListener.onTimeout. This event is fired if an asynchronous operation times out but before the container takes any action as a result of the timeout. Parameters event:AsyncEvent Provides access to the objects associated with the event Annotations @Override

onTimeout

back to summary

public void onTimeout(AsyncEvent event)

Implements jakarta.servlet.AsyncListener.onTimeout.

Doc from jakarta.servlet.AsyncListener.onTimeout.

This event is fired if an asynchronous operation times out but before the container takes any action as a result of the timeout.

Parameters

event:AsyncEvent: Provides access to the objects associated with the event

Annotations

@Override

org.springframework.http.server.reactive back to summary

private Class ServletServerHttpResponse.ResponseBodyFlushProcessor

Class Inheritance

extends AbstractListenerWriteFlushProcessor<DataBuffer>

java.lang.Object
org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor
org.springframework.http.server.reactive.ServletServerHttpResponse.ResponseBodyFlushProcessor

Field Summary

Inherited from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor:: rsWriteFlushLogger

Constructor Summary

Access	Constructor and Description
public	ResponseBodyFlushProcessor()

Method Summary

Modifier and Type	Method and Description
protected Processor<? super DataBuffer, Void>	createWriteProcessor() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.createWriteProcessor. Create a new processor for the current flush boundary.
protected void	flush() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.flush. Flush the output if ready, or otherwise `isFlushPending()` should return true after.
protected boolean	isFlushPending() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isFlushPending. Whether flushing is pending.
protected boolean	isWritePossible() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isWritePossible. Whether writing/flushing is possible.

Inherited from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor:: cancel flushingFailed getLogPrefix onComplete onError onFlushPossible onNext onSubscribe subscribe

Constructor Detail

ResponseBodyFlushProcessor	back to summary
public ResponseBodyFlushProcessor()

Method Detail

createWriteProcessor	back to summary
protected Processor<? super DataBuffer, Void> createWriteProcessor() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.createWriteProcessor. Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.createWriteProcessor. Create a new processor for the current flush boundary. Annotations @Override

createWriteProcessor

back to summary

protected Processor<? super DataBuffer, Void> createWriteProcessor()

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.createWriteProcessor.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.createWriteProcessor.

Create a new processor for the current flush boundary.

Annotations

@Override

flush back to summary

flush	back to summary
protected void flush() throws IOException Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.flush. Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.flush. Flush the output if ready, or otherwise `isFlushPending()` should return true after. This is primarily for the Servlet non-blocking I/O API where flush cannot be called without a readyToWrite check. Annotations @Override

protected void flush() throws IOException

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.flush.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.flush.

Flush the output if ready, or otherwise isFlushPending() should return true after.

This is primarily for the Servlet non-blocking I/O API where flush cannot be called without a readyToWrite check.

Annotations

@Override

isFlushPending	back to summary
protected boolean isFlushPending() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isFlushPending. Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isFlushPending. Whether flushing is pending. This is primarily for the Servlet non-blocking I/O API where flush cannot be called without a readyToWrite check. Annotations @Override

isFlushPending

back to summary

protected boolean isFlushPending()

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isFlushPending.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isFlushPending.

Whether flushing is pending.

This is primarily for the Servlet non-blocking I/O API where flush cannot be called without a readyToWrite check.

Annotations

@Override

isWritePossible	back to summary
protected boolean isWritePossible() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isWritePossible. Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isWritePossible. Whether writing/flushing is possible. Annotations @Override

isWritePossible

back to summary

protected boolean isWritePossible()

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isWritePossible.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteFlushProcessor.isWritePossible.

Whether writing/flushing is possible.

Annotations

@Override

org.springframework.http.server.reactive back to summary

private Class ServletServerHttpResponse.ResponseBodyProcessor

Class Inheritance

extends AbstractListenerWriteProcessor<DataBuffer>

java.lang.Object
org.springframework.http.server.reactive.AbstractListenerWriteProcessor
org.springframework.http.server.reactive.ServletServerHttpResponse.ResponseBodyProcessor

Field Summary

Inherited from org.springframework.http.server.reactive.AbstractListenerWriteProcessor:: rsWriteLogger

Constructor Summary

Access	Constructor and Description
public	ResponseBodyProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	discardData(DataBuffer the data to be released dataBuffer) Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.discardData. Invoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place.
protected boolean	isDataEmpty(DataBuffer dataBuffer) Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isDataEmpty. Whether the given data item has any content to write.
protected boolean	isWritePossible() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isWritePossible. Whether writing is possible.
protected boolean	write(DataBuffer the item to write dataBuffer) Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.write. Write the given item.
protected void	writingComplete() Overrides org.springframework.http.server.reactive.AbstractListenerWriteProcessor.writingComplete. Invoked after onComplete or onError notification.

Inherited from org.springframework.http.server.reactive.AbstractListenerWriteProcessor:: cancel cancelAndSetCompleted dataReceived getLogPrefix onComplete onError onNext onSubscribe onWritePossible subscribe writingFailed writingPaused

Constructor Detail

ResponseBodyProcessor	back to summary
public ResponseBodyProcessor()

Method Detail

discardData	back to summary
protected void discardData(DataBuffer dataBuffer) Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.discardData. Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.discardData. Invoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place. Parameters dataBuffer:DataBuffer the data to be released Annotations @Override

discardData

back to summary

protected void discardData(DataBuffer dataBuffer)

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.discardData.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.discardData.

Invoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place.

Parameters

dataBuffer:DataBuffer: the data to be released

Annotations

@Override

isDataEmpty	back to summary
protected boolean isDataEmpty(DataBuffer dataBuffer) Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isDataEmpty. Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isDataEmpty. Whether the given data item has any content to write. If false the item is not written. Annotations @Override

isDataEmpty

back to summary

protected boolean isDataEmpty(DataBuffer dataBuffer)

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isDataEmpty.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isDataEmpty.

Whether the given data item has any content to write. If false the item is not written.

Annotations

@Override

isWritePossible	back to summary
protected boolean isWritePossible() Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isWritePossible. Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isWritePossible. Whether writing is possible. Annotations @Override

isWritePossible

back to summary

protected boolean isWritePossible()

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isWritePossible.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.isWritePossible.

Whether writing is possible.

Annotations

@Override

write back to summary

write	back to summary
protected boolean write(DataBuffer dataBuffer) throws IOException Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.write. Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.write. Write the given item. Note Sub-classes are responsible for releasing any data buffer associated with the item, once fully written, if pooled buffers apply to the underlying container. Parameters dataBuffer:DataBuffer the item to write Returns:boolean `true` if the current data item was written completely and a new item requested, or `false` if it was written partially and we'll need more write callbacks before it is fully written Annotations @Override

protected boolean write(DataBuffer dataBuffer) throws IOException

Implements abstract org.springframework.http.server.reactive.AbstractListenerWriteProcessor.write.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.write.

Write the given item.

Note

Sub-classes are responsible for releasing any data buffer associated with the item, once fully written, if pooled buffers apply to the underlying container.

Parameters

dataBuffer:DataBuffer: the item to write

Returns:boolean

true if the current data item was written completely and a new item requested, or false if it was written partially and we'll need more write callbacks before it is fully written

Annotations

@Override

writingComplete	back to summary
protected void writingComplete() Overrides org.springframework.http.server.reactive.AbstractListenerWriteProcessor.writingComplete. Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.writingComplete. Invoked after onComplete or onError notification. The default implementation is a no-op. Annotations @Override

writingComplete

back to summary

protected void writingComplete()

Overrides org.springframework.http.server.reactive.AbstractListenerWriteProcessor.writingComplete.

Doc from org.springframework.http.server.reactive.AbstractListenerWriteProcessor.writingComplete.

Invoked after onComplete or onError notification.

The default implementation is a no-op.

Annotations

@Override

org.springframework.http.server.reactive back to summary

private Class ServletServerHttpResponse.ResponseBodyWriteListener

Class Inheritance

extends Object
implements WriteListener

java.lang.Object
org.springframework.http.server.reactive.ServletServerHttpResponse.ResponseBodyWriteListener

All Implemented Interfaces

jakarta.servlet.WriteListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	ResponseBodyWriteListener()

Method Summary

Modifier and Type	Method and Description
public void	onError(Throwable The throwable that represents the error that occurred ex) Implements jakarta.servlet.WriteListener.onError. Invoked if an error occurs while writing the response.
public void	onWritePossible() Implements jakarta.servlet.WriteListener.onWritePossible. Invoked when it it possible to write data without blocking.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ResponseBodyWriteListener	back to summary
private ResponseBodyWriteListener()

Method Detail

onError

back to summary

public void onError(Throwable ex)

Implements jakarta.servlet.WriteListener.onError.

Doc from jakarta.servlet.WriteListener.onError.

Invoked if an error occurs while writing the response.

Parameters

ex:Throwable: The throwable that represents the error that occurred

Annotations

@Override

onWritePossible back to summary

public void onWritePossible()

Implements jakarta.servlet.WriteListener.onWritePossible.

Doc from jakarta.servlet.WriteListener.onWritePossible.

Invoked when it it possible to write data without blocking. The container will invoke this method the first time for a request as soon as data can be written. Subsequent invocations will only occur if a call to ServletOutputStream#isReady() has returned false and it has since become possible to write data.

Annotations

@Override

pack-priv Class ServletServerHttpResponse

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ServletServerHttpResponse.ResponseAsyncListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ServletServerHttpResponse.ResponseBodyFlushProcessor

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ServletServerHttpResponse.ResponseBodyProcessor

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ServletServerHttpResponse.ResponseBodyWriteListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail