org.springframework.http.server.reactive

Interface ServerHttpResponse

All Superinterfaces:

HttpMessage, ReactiveHttpOutputMessage

All Known Implementing Classes:

AbstractListenerServerHttpResponse, AbstractServerHttpResponse, HttpHeadResponseDecorator, MockServerHttpResponse, ServerHttpResponseDecorator

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
void	addCookie(ResponseCookie cookie) Add the given ResponseCookie.
MultiValueMap<String,ResponseCookie>	getCookies() Return a mutable map with the cookies to send to the server.
HttpStatus	getStatusCode() Return the status code set via setStatusCode(org.springframework.http.HttpStatus), or if the status has not been set, return the default status code from the underlying server response.
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(@Nullable
                      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 successfully set.

getStatusCode

@Nullable
HttpStatus getStatusCode()

Return the status code set via setStatusCode(org.springframework.http.HttpStatus), or if the status has not been set, return the default status code from the underlying server response. The return value may be null if the status code value is outside the HttpStatus enum range, or if the underlying server response does not have a default value.

getCookies

MultiValueMap<String,ResponseCookie> getCookies()

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

addCookie

void addCookie(ResponseCookie cookie)

Add the given ResponseCookie.

Parameters:

cookie - the cookie to add

Throws:

IllegalStateException - if the response has already been committed