org.springframework.http.server.reactive

Class ServerHttpResponseDecorator

java.lang.Object

org.springframework.http.server.reactive.ServerHttpResponseDecorator

All Implemented Interfaces:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse

public class ServerHttpResponseDecorator
extends java.lang.Object
implements ServerHttpResponse

Wraps another ServerHttpResponse and delegates all methods to it. Sub-classes can override specific methods selectively.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private ServerHttpResponse	delegate

Constructor Summary

Constructors

Constructor and Description
ServerHttpResponseDecorator(ServerHttpResponse delegate)

Method Summary

Modifier and Type	Method and Description
void	beforeCommit(java.util.function.Supplier<? extends <any>> action) Register an action to apply just before the HttpOutputMessage is committed.
DataBufferFactory	bufferFactory() Return a DataBufferFactory that can be used to create the body.
java.lang.String	encodeUrl(java.lang.String url) A mechanism for URL rewriting that applications and libraries such as HTML template libraries to use consistently for all URLs emitted by the application.
MultiValueMap<java.lang.String,ResponseCookie>	getCookies() Return a mutable map with the cookies to send to the server.
ServerHttpResponse	getDelegate()
HttpHeaders	getHeaders() Return the headers of this message.
HttpStatus	getStatusCode() Return the HTTP status code or null if not set.
boolean	isCommitted() Whether the HttpOutputMessage is committed.
void	registerUrlEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder) Register a URL rewriting function for use with ServerHttpResponse.encodeUrl(java.lang.String).
<any>	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 HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).
boolean	setStatusCode(HttpStatus status) Set the HTTP status code of the response.
java.lang.String	toString()
<any>	writeAndFlushWith(<any> body) Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.
<any>	writeWith(<any> body) Use the given Publisher to write the body of the message to the underlying HTTP layer.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

private final ServerHttpResponse delegate

Constructor Detail

ServerHttpResponseDecorator

public ServerHttpResponseDecorator(ServerHttpResponse delegate)

Method Detail

getDelegate

public ServerHttpResponse getDelegate()

setStatusCode

public boolean setStatusCode(HttpStatus status)

Description copied from interface: ServerHttpResponse

Set the HTTP status code of the response.

Specified by:

setStatusCode in interface ServerHttpResponse

Parameters:

status - the HTTP status as an HttpStatus enum value

Returns:

false if the status code has not been set because the HTTP response is already committed, true if it has been set correctly.

getStatusCode

public HttpStatus getStatusCode()

Description copied from interface: ServerHttpResponse

Return the HTTP status code or null if not set.

Specified by:

getStatusCode in interface ServerHttpResponse

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: HttpMessage

Return the headers of this message.

Specified by:

getHeaders in interface HttpMessage

Returns:

a corresponding HttpHeaders object (never null)

getCookies

public MultiValueMap<java.lang.String,ResponseCookie> getCookies()

Description copied from interface: ServerHttpResponse

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

Specified by:

getCookies in interface ServerHttpResponse

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Description copied from interface: ServerHttpResponse

A mechanism for URL rewriting that applications and libraries such as HTML template libraries to use consistently for all URLs emitted by the application. Doing so enables the registration of URL encoders via ServerHttpResponse.registerUrlEncoder(java.util.function.Function<java.lang.String, java.lang.String>) that can insert an id for authentication, a nonce for CSRF protection, a version for a static resource, etc.

Specified by:

encodeUrl in interface ServerHttpResponse

Parameters:

url - the URL to encode

Returns:

the encoded URL or the same

registerUrlEncoder

public void registerUrlEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder)

Description copied from interface: ServerHttpResponse

Register a URL rewriting function for use with ServerHttpResponse.encodeUrl(java.lang.String). The function must return an encoded URL or the same URL.

Specified by:

registerUrlEncoder in interface ServerHttpResponse

Parameters:

encoder - a URL encoding function to use

bufferFactory

public DataBufferFactory bufferFactory()

Description copied from interface: ReactiveHttpOutputMessage

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

Specified by:

bufferFactory in interface ReactiveHttpOutputMessage

Returns:

a buffer factory

See Also:

#writeWith(Publisher)

beforeCommit

public void beforeCommit(java.util.function.Supplier<? extends <any>> action)

Description copied from interface: ReactiveHttpOutputMessage

Register an action to apply just before the HttpOutputMessage is committed.

Specified by:

beforeCommit in interface ReactiveHttpOutputMessage

Parameters:

action - the action to apply

isCommitted

public boolean isCommitted()

Description copied from interface: ReactiveHttpOutputMessage

Whether the HttpOutputMessage is committed.

Specified by:

isCommitted in interface ReactiveHttpOutputMessage

writeWith

public <any> writeWith(<any> body)

Description copied from interface: ReactiveHttpOutputMessage

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

Specified by:

writeWith in interface ReactiveHttpOutputMessage

Parameters:

body - the body content publisher

Returns:

a Mono that indicates completion or error

writeAndFlushWith

public <any> writeAndFlushWith(<any> body)

Description copied from interface: ReactiveHttpOutputMessage

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

Specified by:

writeAndFlushWith in interface ReactiveHttpOutputMessage

Parameters:

body - the body content publisher

Returns:

a Mono that indicates completion or error

setComplete

public <any> setComplete()

Description copied from interface: ReactiveHttpOutputMessage

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

Specified by:

setComplete in interface ReactiveHttpOutputMessage

Returns:

a Mono that indicates completion or error

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object