Spring Framework 6.1.4 · org.springframework.http.server.reactive.AbstractServerHttpResponse

Modifier and Type	Class and Description
private static enum	AbstractServerHttpResponse.State COMMITTING -> COMMITTED is the period after doCommit is called but before the response status and headers have been applied to the underlying response during which time pre-commit actions can still make changes to the response status and headers.

Modifier and Type	Field and Description
private final List<Supplier<? extends Mono<Void>>>	commitActions
private final MultiValueMap<String, ResponseCookie>	cookies
private final DataBufferFactory	dataBufferFactory
private final HttpHeaders	headers
private HttpHeaders	readOnlyHeaders
private final AtomicReference<AbstractServerHttpResponse.State>	state
private HttpStatusCode	statusCode

Access	Constructor and Description
public	AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)
public	AbstractServerHttpResponse(DataBufferFactory dataBufferFactory, HttpHeaders headers)

Method Summary

Modifier and Type	Method and Description
public void	addCookie(ResponseCookie the cookie to add cookie) Implements org.springframework.http.server.reactive.ServerHttpResponse.addCookie. Add the given `ResponseCookie`.
protected abstract void	applyCookies() Add cookies from `getHeaders()` to the underlying response.
protected abstract void	applyHeaders() Invoked when the response is getting committed allowing subclasses to make apply header values to the underlying response.
protected abstract void	applyStatusCode() Write the status code to the underlying response.
public void	beforeCommit(Supplier<? extends Mono<Void>> the action to apply action) Implements org.springframework.http.ReactiveHttpOutputMessage.beforeCommit. Register an action to apply just before the HttpOutputMessage is committed.
public final DataBufferFactory	bufferFactory() Implements org.springframework.http.ReactiveHttpOutputMessage.bufferFactory. Return a `DataBufferFactory` that can be used to create the body.
protected Mono<Void>	Returns: a completion publisher doCommit() A variant of `doCommit(Supplier)` for a response without a body.
protected Mono<Void>	Returns: a completion publisher doCommit(Supplier<? extends Mono<Void>> the action to write the response body (may be `null`) writeAction) Apply `beforeCommit` actions, apply the response status and headers/cookies, and write the response body.
public MultiValueMap<String, ResponseCookie>	getCookies() Implements org.springframework.http.server.reactive.ServerHttpResponse.getCookies. Return a mutable map with the cookies to send to the server.
public HttpHeaders	getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Return the headers of this message.
public abstract <T> T	getNativeResponse() Return the underlying server response.
public Integer	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() 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.
public boolean	isCommitted() Implements org.springframework.http.ReactiveHttpOutputMessage.isCommitted. Whether the HttpOutputMessage is committed.
public Mono<Void>	setComplete() Implements org.springframework.http.ReactiveHttpOutputMessage.setComplete. Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via `getHeaders()` to the underlying HTTP message (if not applied already).
public boolean	setRawStatusCode(Integer the status code value statusCode) Overrides default org.springframework.http.server.reactive.ServerHttpResponse.setRawStatusCode. Set the HTTP status code to the given value as an integer.
public boolean	setStatusCode(HttpStatusCode the HTTP status as an `HttpStatusCode` value status) Implements org.springframework.http.server.reactive.ServerHttpResponse.setStatusCode. Set the HTTP status code of the response.
protected void	touchDataBuffer(DataBuffer the buffer to attach a hint to buffer) Allow subclasses to associate a hint with the data buffer if it is a pooled buffer and supports leak tracking.
public final Mono<Void>	writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> the body content publisher body) Implements org.springframework.http.ReactiveHttpOutputMessage.writeAndFlushWith. Use the given `Publisher` of `Publishers` to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each `Publisher<DataBuffer>`.
protected abstract Mono<Void>	writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>> the publisher to write and flush with body) Write to the underlying the response, and flush after each `Publisher<DataBuffer>`.
public final Mono<Void>	writeWith(Publisher<? extends DataBuffer> the body content publisher body) Implements org.springframework.http.ReactiveHttpOutputMessage.writeWith. Use the given `Publisher` to write the body of the message to the underlying HTTP layer.
protected abstract Mono<Void>	writeWithInternal(Publisher<? extends DataBuffer> the publisher to write with body) Write to the underlying the response.

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

commitActions	back to summary
private final List<Supplier<? extends Mono<Void>>> commitActions

dataBufferFactory	back to summary
private final DataBufferFactory dataBufferFactory

headers	back to summary
private final HttpHeaders headers

readOnlyHeaders	back to summary
private HttpHeaders readOnlyHeaders Annotations @Nullable

state	back to summary
private final AtomicReference<AbstractServerHttpResponse.State> state

statusCode	back to summary
private HttpStatusCode statusCode Annotations @Nullable

AbstractServerHttpResponse	back to summary
public AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)

AbstractServerHttpResponse	back to summary
public AbstractServerHttpResponse(DataBufferFactory dataBufferFactory, HttpHeaders headers)

Method Detail

addCookie back to summary

public void addCookie(ResponseCookie cookie)

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

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

Add the given ResponseCookie.

Parameters

cookie:ResponseCookie: the cookie to add

Annotations

@Override

applyCookies	back to summary
protected abstract void applyCookies() Add cookies from `getHeaders()` to the underlying response. This method is called once only.

applyHeaders back to summary

applyHeaders	back to summary
protected abstract void 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.

protected abstract void 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.

applyStatusCode	back to summary
protected abstract void applyStatusCode() Write the status code to the underlying response. This method is called once only.

beforeCommit back to summary

beforeCommit	back to summary
public void beforeCommit(Supplier<? extends Mono<Void>> action) Implements org.springframework.http.ReactiveHttpOutputMessage.beforeCommit. Doc from org.springframework.http.ReactiveHttpOutputMessage.beforeCommit. Register an action to apply just before the HttpOutputMessage is committed. Note the supplied action must be properly deferred, e.g. via `Mono#defer` or `Mono#fromRunnable`, to ensure it's executed in the right order, relative to other actions. Parameters action:Supplier<? extends Mono<Void>> the action to apply Annotations @Override

public void beforeCommit(Supplier<? extends Mono<Void>> action)

Implements org.springframework.http.ReactiveHttpOutputMessage.beforeCommit.

Doc from org.springframework.http.ReactiveHttpOutputMessage.beforeCommit.

Note

the supplied action must be properly deferred, e.g. via Mono#defer or Mono#fromRunnable, to ensure it's executed in the right order, relative to other actions.

Parameters

action:Supplier<? extends Mono<Void>>: the action to apply

Annotations

@Override

bufferFactory back to summary

bufferFactory	back to summary
public final DataBufferFactory bufferFactory() Implements org.springframework.http.ReactiveHttpOutputMessage.bufferFactory. Doc from org.springframework.http.ReactiveHttpOutputMessage.bufferFactory. Return a `DataBufferFactory` that can be used to create the body. Returns:DataBufferFactory a buffer factory Annotations @Override

public final DataBufferFactory bufferFactory()

Implements org.springframework.http.ReactiveHttpOutputMessage.bufferFactory.

Doc from org.springframework.http.ReactiveHttpOutputMessage.bufferFactory.

Return a DataBufferFactory that can be used to create the body.

Returns:DataBufferFactory

a buffer factory

Annotations

@Override

doCommit back to summary

doCommit	back to summary
protected Mono<Void> doCommit() A variant of `doCommit(Supplier)` for a response without a body. Returns:Mono<Void> a completion publisher

protected Mono<Void> doCommit()

A variant of doCommit(Supplier) for a response without a body.

Returns:Mono<Void>: a completion publisher

doCommit back to summary

doCommit	back to summary
protected Mono<Void> doCommit(Supplier<? extends Mono<Void>> writeAction) Apply `beforeCommit` actions, apply the response status and headers/cookies, and write the response body. Parameters writeAction:Supplier<? extends Mono<Void>> the action to write the response body (may be `null`) Returns:Mono<Void> a completion publisher

protected Mono<Void> doCommit(Supplier<? extends Mono<Void>> writeAction)

Apply beforeCommit actions, apply the response status and headers/cookies, and write the response body.

Parameters

writeAction:Supplier<? extends Mono<Void>>: the action to write the response body (may be null)

Returns:Mono<Void>

a completion publisher

getCookies

back to summary

public MultiValueMap<String, ResponseCookie> getCookies()

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

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

Return a mutable map with the cookies to send to the server.

Annotations

@Override

getHeaders back to summary

getHeaders	back to summary
public HttpHeaders getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Doc from org.springframework.http.HttpMessage.getHeaders. Return the headers of this message. Returns:HttpHeaders a corresponding HttpHeaders object (never `null`) Annotations @Override

public HttpHeaders getHeaders()

Implements org.springframework.http.HttpMessage.getHeaders.

Doc from org.springframework.http.HttpMessage.getHeaders.

Return the headers of this message.

Returns:HttpHeaders

a corresponding HttpHeaders object (never null)

Annotations

@Override

getNativeResponse	back to summary
public abstract <T> T getNativeResponse() Return the underlying server response. Note This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module.

getRawStatusCode back to summary

getRawStatusCode	back to summary
public Integer 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 @Deprecated @Override @Nullable

public Integer 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

@Deprecated
@Override
@Nullable

getStatusCode back to summary

getStatusCode	back to summary
public HttpStatusCode 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 @Nullable

public HttpStatusCode getStatusCode()

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

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

Annotations

@Override
@Nullable

isCommitted	back to summary
public boolean isCommitted() Implements org.springframework.http.ReactiveHttpOutputMessage.isCommitted. Doc from org.springframework.http.ReactiveHttpOutputMessage.isCommitted. Whether the HttpOutputMessage is committed. Annotations @Override

isCommitted

back to summary

public boolean isCommitted()

Implements org.springframework.http.ReactiveHttpOutputMessage.isCommitted.

Doc from org.springframework.http.ReactiveHttpOutputMessage.isCommitted.

Whether the HttpOutputMessage is committed.

Annotations

@Override

setComplete back to summary

setComplete	back to summary
public Mono<Void> setComplete() Implements org.springframework.http.ReactiveHttpOutputMessage.setComplete. Doc from org.springframework.http.ReactiveHttpOutputMessage.setComplete. Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via `getHeaders()` to the underlying HTTP message (if not applied already). This method should be automatically invoked at the end of message processing so typically applications should not have to invoke it. If invoked multiple times it should have no side effects. Returns:Mono<Void> a `Mono` that indicates completion or error Annotations @Override

public Mono<Void> setComplete()

Implements org.springframework.http.ReactiveHttpOutputMessage.setComplete.

Doc from org.springframework.http.ReactiveHttpOutputMessage.setComplete.

Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via getHeaders() to the underlying HTTP message (if not applied already).

This method should be automatically invoked at the end of message processing so typically applications should not have to invoke it. If invoked multiple times it should have no side effects.

Returns:Mono<Void>

a Mono that indicates completion or error

Annotations

@Override

setRawStatusCode back to summary

setRawStatusCode	back to summary
public boolean setRawStatusCode(Integer statusCode) Overrides default org.springframework.http.server.reactive.ServerHttpResponse.setRawStatusCode. Doc from org.springframework.http.server.reactive.ServerHttpResponse.setRawStatusCode. Set the HTTP status code to the given value as an integer. Parameters statusCode:Integer the status code value Returns:boolean `false` if the status code change wasn't processed because the HTTP response is committed, `true` if successfully set. Annotations @Override

public boolean setRawStatusCode(Integer statusCode)

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

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

Set the HTTP status code to the given value as an integer.

Parameters

statusCode:Integer: the status code value

Returns:boolean

false if the status code change wasn't processed because the HTTP response is committed, true if successfully set.

Annotations

@Override

setStatusCode back to summary

setStatusCode	back to summary
public boolean setStatusCode(HttpStatusCode status) Implements org.springframework.http.server.reactive.ServerHttpResponse.setStatusCode. Doc from org.springframework.http.server.reactive.ServerHttpResponse.setStatusCode. Set the HTTP status code of the response. Parameters status:HttpStatusCode the HTTP status as an `HttpStatusCode` value Returns:boolean `false` if the status code change wasn't processed because the HTTP response is committed, `true` if successfully set. Annotations @Override

public boolean setStatusCode(HttpStatusCode status)

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

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

Set the HTTP status code of the response.

Parameters

status:HttpStatusCode: the HTTP status as an HttpStatusCode value

Returns:boolean

false if the status code change wasn't processed because the HTTP response is committed, true if successfully set.

Annotations

@Override

touchDataBuffer	back to summary
protected void touchDataBuffer(DataBuffer buffer) Allow subclasses to associate a hint with the data buffer if it is a pooled buffer and supports leak tracking. Parameters buffer:DataBuffer the buffer to attach a hint to Since 5.3.2

touchDataBuffer

back to summary

protected void touchDataBuffer(DataBuffer buffer)

Allow subclasses to associate a hint with the data buffer if it is a pooled buffer and supports leak tracking.

Parameters

buffer:DataBuffer: the buffer to attach a hint to

Since

5.3.2

writeAndFlushWith back to summary

writeAndFlushWith	back to summary
public final Mono<Void> writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body) Implements org.springframework.http.ReactiveHttpOutputMessage.writeAndFlushWith. Doc from org.springframework.http.ReactiveHttpOutputMessage.writeAndFlushWith. Use the given `Publisher` of `Publishers` to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each `Publisher<DataBuffer>`. Parameters body:Publisher<? extends Publisher<? extends DataBuffer>> the body content publisher Returns:Mono<Void> a `Mono` that indicates completion or error Annotations @Override

public final Mono<Void> writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body)

Implements org.springframework.http.ReactiveHttpOutputMessage.writeAndFlushWith.

Doc from org.springframework.http.ReactiveHttpOutputMessage.writeAndFlushWith.

Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.

Parameters

body:Publisher<? extends Publisher<? extends DataBuffer>>: the body content publisher

Returns:Mono<Void>

a Mono that indicates completion or error

Annotations

@Override

writeAndFlushWithInternal back to summary

writeAndFlushWithInternal	back to summary
protected abstract Mono<Void> writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>> body) Write to the underlying the response, and flush after each `Publisher<DataBuffer>`. Parameters body:Publisher<? extends Publisher<? extends DataBuffer>> the publisher to write and flush with

protected abstract Mono<Void> writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>> body)

Write to the underlying the response, and flush after each Publisher<DataBuffer>.

Parameters

body:Publisher<? extends Publisher<? extends DataBuffer>>: the publisher to write and flush with

writeWith back to summary

writeWith	back to summary
public final Mono<Void> writeWith(Publisher<? extends DataBuffer> body) Implements org.springframework.http.ReactiveHttpOutputMessage.writeWith. Doc from org.springframework.http.ReactiveHttpOutputMessage.writeWith. Use the given `Publisher` to write the body of the message to the underlying HTTP layer. Parameters body:Publisher<? extends DataBuffer> the body content publisher Returns:Mono<Void> a `Mono` that indicates completion or error Annotations @Override @SuppressWarnings:unchecked

public final Mono<Void> writeWith(Publisher<? extends DataBuffer> body)

Implements org.springframework.http.ReactiveHttpOutputMessage.writeWith.

Doc from org.springframework.http.ReactiveHttpOutputMessage.writeWith.

Use the given Publisher to write the body of the message to the underlying HTTP layer.

Parameters

body:Publisher<? extends DataBuffer>: the body content publisher

Returns:Mono<Void>

a Mono that indicates completion or error

Annotations

@Override
@SuppressWarnings:unchecked

writeWithInternal	back to summary
protected abstract Mono<Void> writeWithInternal(Publisher<? extends DataBuffer> body) Write to the underlying the response. Parameters body:Publisher<? extends DataBuffer> the publisher to write with

writeWithInternal

back to summary

protected abstract Mono<Void> writeWithInternal(Publisher<? extends DataBuffer> body)

Write to the underlying the response.

Parameters

body:Publisher<? extends DataBuffer>: the publisher to write with

Modifier and Type	Field and Description
public static final AbstractServerHttpResponse.State	COMMIT_ACTION_FAILED
public static final AbstractServerHttpResponse.State	COMMITTED
public static final AbstractServerHttpResponse.State	COMMITTING
public static final AbstractServerHttpResponse.State	NEW

Modifier and Type	Method and Description
public static AbstractServerHttpResponse.State	valueOf(String name)
public static AbstractServerHttpResponse.State[]	values()

public abstract Class AbstractServerHttpResponse

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum AbstractServerHttpResponse.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail