org.springframework.http.server.reactive

Interface ServerHttpResponse

All Superinterfaces:

HttpMessage, ReactiveHttpOutputMessage

All Known Implementing Classes:

AbstractListenerServerHttpResponse, AbstractServerHttpResponse, JettyHttpHandlerAdapter.JettyServerHttpResponse, MockServerHttpResponse, ReactorServerHttpResponse, RxNettyServerHttpResponse, ServerHttpResponseDecorator, ServletServerHttpResponse, TomcatHttpHandlerAdapter.TomcatServerHttpResponse, UndertowServerHttpResponse

public interface ServerHttpResponse
extends ReactiveHttpOutputMessage

Represents a reactive server-side HTTP response.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze

Method Summary

Modifier and Type	Method and Description
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.
HttpStatus	getStatusCode() Return the HTTP status code or null if not set.
void	registerUrlEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder) Register a URL rewriting function for use with encodeUrl(java.lang.String).
boolean	setStatusCode(HttpStatus status) Set the HTTP status code of the response.

Methods inherited from interface org.springframework.http.ReactiveHttpOutputMessage

beforeCommit, bufferFactory, isCommitted, setComplete, writeAndFlushWith, writeWith

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Method Detail

setStatusCode

boolean setStatusCode(HttpStatus status)

Set the HTTP status code of the response.

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

HttpStatus getStatusCode()

Return the HTTP status code or null if not set.

getCookies

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

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

encodeUrl

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. Doing so enables the registration of URL encoders via 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.

Parameters:

url - the URL to encode

Returns:

the encoded URL or the same

registerUrlEncoder

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

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

Parameters:

encoder - a URL encoding function to use