Top Description Fields Constructors Methods
org.springframework.web.servlet.function

pack-priv abstract Class AbstractServerResponse

extends ErrorHandlingServerResponse
Class Inheritance
Known Direct Subclasses
org.springframework.web.servlet.function.DefaultEntityResponseBuilder.DefaultEntityResponse, org.springframework.web.servlet.function.DefaultRenderingResponseBuilder.DefaultRenderingResponse, org.springframework.web.servlet.function.DefaultServerResponseBuilder.WriteFunctionResponse, org.springframework.web.servlet.function.SseServerResponse
Imports
java.io.IOException, java.util.Collection, .Set, jakarta.servlet.ServletException, jakarta.servlet.http.Cookie, .HttpServletRequest, .HttpServletResponse, org.springframework.http.HttpHeaders, .HttpMethod, .HttpStatusCode, org.springframework.lang.Nullable, org.springframework.util.CollectionUtils, .LinkedMultiValueMap, .MultiValueMap, org.springframework.web.context.request.ServletWebRequest, org.springframework.web.servlet.ModelAndView
Abstract base class for ServerResponse implementations.
Author
Arjen Poutsma
Since
5.3.2

Field Summary

Modifier and TypeField and Description
private final MultiValueMap<String, Cookie>
cookies

private final HttpHeaders
headers

private static final Set<HttpMethod>
SAFE_METHODS

private final HttpStatusCode
statusCode

Inherited from org.springframework.web.servlet.function.ErrorHandlingServerResponse:
logger

Constructor Summary

AccessConstructor and Description
protected
AbstractServerResponse(HttpStatusCode statusCode, HttpHeaders headers, MultiValueMap<String, Cookie> cookies)

Method Summary

Modifier and TypeMethod and Description
public MultiValueMap<String, Cookie>
cookies()

Implements org.springframework.web.servlet.function.ServerResponse.cookies.

Return the cookies of this response.

public final HttpHeaders
headers()

Implements org.springframework.web.servlet.function.ServerResponse.headers.

Return the headers of this response.

public int
rawStatusCode()

Implements org.springframework.web.servlet.function.ServerResponse.rawStatusCode.

Deprecated

Return the status code of this response as integer.

public final HttpStatusCode
statusCode()

Implements org.springframework.web.servlet.function.ServerResponse.statusCode.

Return the status code of this response.

private void
writeCookies(HttpServletResponse servletResponse)

private void
writeHeaders(HttpServletResponse servletResponse)

private void
writeStatusAndHeaders(HttpServletResponse response)

public ModelAndView
writeTo(HttpServletRequest
the current request
request, HttpServletResponse
the response to write to
response, ServerResponse.Context
the context to use when writing
context)

Implements org.springframework.web.servlet.function.ServerResponse.writeTo.

Write this response to the given servlet response.

protected abstract ModelAndView
writeToInternal(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context)

Inherited from org.springframework.web.servlet.function.ErrorHandlingServerResponse:
addErrorHandlererrorResponsehandleError

Field Detail

cookiesback to summary
private final MultiValueMap<String, Cookie> cookies
headersback to summary
private final HttpHeaders headers
SAFE_METHODSback to summary
private static final Set<HttpMethod> SAFE_METHODS
statusCodeback to summary
private final HttpStatusCode statusCode

Constructor Detail

AbstractServerResponseback to summary
protected AbstractServerResponse(HttpStatusCode statusCode, HttpHeaders headers, MultiValueMap<String, Cookie> cookies)

Method Detail

cookiesback to summary
public MultiValueMap<String, Cookie> cookies()

Implements org.springframework.web.servlet.function.ServerResponse.cookies.

Doc from org.springframework.web.servlet.function.ServerResponse.cookies.

Return the cookies of this response.

Annotations
@Override
headersback to summary
public final HttpHeaders headers()

Implements org.springframework.web.servlet.function.ServerResponse.headers.

Doc from org.springframework.web.servlet.function.ServerResponse.headers.

Return the headers of this response.

Annotations
@Override
rawStatusCodeback to summary
public int rawStatusCode()

Implements org.springframework.web.servlet.function.ServerResponse.rawStatusCode.

Doc from org.springframework.web.servlet.function.ServerResponse.rawStatusCode.

Deprecated

Return the status code of this response as integer.

Returns:int

the status as an integer

Annotations
@Override
@Deprecated
statusCodeback to summary
public final HttpStatusCode statusCode()

Implements org.springframework.web.servlet.function.ServerResponse.statusCode.

Doc from org.springframework.web.servlet.function.ServerResponse.statusCode.

Return the status code of this response.

Returns:HttpStatusCode

the status as an HttpStatusCode value

Annotations
@Override
writeCookiesback to summary
private void writeCookies(HttpServletResponse servletResponse)
writeHeadersback to summary
private void writeHeaders(HttpServletResponse servletResponse)
writeStatusAndHeadersback to summary
private void writeStatusAndHeaders(HttpServletResponse response)
writeToback to summary
public ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context) throws ServletException, IOException

Implements org.springframework.web.servlet.function.ServerResponse.writeTo.

Doc from org.springframework.web.servlet.function.ServerResponse.writeTo.

Write this response to the given servlet response.

Parameters
request:HttpServletRequest

the current request

response:HttpServletResponse

the response to write to

context:ServerResponse.Context

the context to use when writing

Returns:ModelAndView

a ModelAndView to render, or null if handled directly

Annotations
@Override
writeToInternalback to summary
protected abstract ModelAndView writeToInternal(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context) throws Exception
Annotations
@Nullable