Interface ServerResponse
- All Known Subinterfaces:
EntityResponse<T>,RenderingResponse
public interface ServerResponse
Represents a typed server-side HTTP response, as returned by a handler function or filter function.- Since:
- 5.2
- Author:
- Arjen Poutsma
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceServerResponse.BodyBuilderDefines a builder that adds a body to the response.static interfaceServerResponse.ContextDefines the context used during thewriteTo(HttpServletRequest, HttpServletResponse, Context).static interfaceServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>Defines a builder that adds headers to the response.
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static ServerResponse.BodyBuilderaccepted()Create a builder with a 202 Accepted status.static ServerResponse.BodyBuilderbadRequest()Create a builder with a 400 Bad Request status.MultiValueMap<String,Cookie>cookies()Return the cookies of this response.static ServerResponse.BodyBuildercreated(URI location)Create a builder with a 201 Created status and a location header set to the given URI.static ServerResponse.BodyBuilderfrom(ServerResponse other)Create a builder with the status code and headers of the given response.HttpHeadersheaders()Return the headers of this response.static ServerResponse.HeadersBuilder<?>noContent()Create a builder with a 204 No Content status.static ServerResponse.HeadersBuilder<?>notFound()Create a builder with a 404 Not Found status.static ServerResponse.BodyBuilderok()Create a builder with the status set to 200 OK.static ServerResponse.BodyBuilderpermanentRedirect(URI location)Create a builder with a 308 Permanent Redirect status and a location header set to the given URI.intrawStatusCode()Return the (potentially non-standard) status code of this response.static ServerResponse.BodyBuilderseeOther(URI location)Create a builder with a 303 See Other status and a location header set to the given URI.static ServerResponse.BodyBuilderstatus(int status)Create a builder with the given HTTP status.static ServerResponse.BodyBuilderstatus(HttpStatus status)Create a builder with the given HTTP status.HttpStatusstatusCode()Return the status code of this response.static ServerResponse.BodyBuildertemporaryRedirect(URI location)Create a builder with a 307 Temporary Redirect status and a location header set to the given URI.static ServerResponse.BodyBuilderunprocessableEntity()Create a builder with a 422 Unprocessable Entity status.ModelAndViewwriteTo(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context)Write this response to the given servlet response.
Method Detail
statusCode
HttpStatus statusCode()
Return the status code of this response.- Returns:
- the status as an HttpStatus enum value
- Throws:
IllegalArgumentException- in case of an unknown HTTP status code- See Also:
HttpStatus.valueOf(int)
rawStatusCode
int rawStatusCode()
Return the (potentially non-standard) status code of this response.- Returns:
- the status as an integer
- See Also:
statusCode(),HttpStatus.valueOf(int)
headers
HttpHeaders headers()
Return the headers of this response.
cookies
MultiValueMap<String,Cookie> cookies()
Return the cookies of this response.
writeTo
@Nullable ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context) throws ServletException, IOException
Write this response to the given servlet response.- Parameters:
request- the current requestresponse- the response to write tocontext- the context to use when writing- Returns:
- a
ModelAndViewto render, ornullif handled directly - Throws:
ServletExceptionIOException
from
static ServerResponse.BodyBuilder from(ServerResponse other)
Create a builder with the status code and headers of the given response.- Parameters:
other- the response to copy the status and headers from- Returns:
- the created builder
status
static ServerResponse.BodyBuilder status(HttpStatus status)
Create a builder with the given HTTP status.- Parameters:
status- the response status- Returns:
- the created builder
status
static ServerResponse.BodyBuilder status(int status)
Create a builder with the given HTTP status.- Parameters:
status- the response status- Returns:
- the created builder
ok
static ServerResponse.BodyBuilder ok()
Create a builder with the status set to 200 OK.- Returns:
- the created builder
created
static ServerResponse.BodyBuilder created(URI location)
Create a builder with a 201 Created status and a location header set to the given URI.- Parameters:
location- the location URI- Returns:
- the created builder
accepted
static ServerResponse.BodyBuilder accepted()
Create a builder with a 202 Accepted status.- Returns:
- the created builder
noContent
static ServerResponse.HeadersBuilder<?> noContent()
Create a builder with a 204 No Content status.- Returns:
- the created builder
seeOther
static ServerResponse.BodyBuilder seeOther(URI location)
Create a builder with a 303 See Other status and a location header set to the given URI.- Parameters:
location- the location URI- Returns:
- the created builder
temporaryRedirect
static ServerResponse.BodyBuilder temporaryRedirect(URI location)
Create a builder with a 307 Temporary Redirect status and a location header set to the given URI.- Parameters:
location- the location URI- Returns:
- the created builder
permanentRedirect
static ServerResponse.BodyBuilder permanentRedirect(URI location)
Create a builder with a 308 Permanent Redirect status and a location header set to the given URI.- Parameters:
location- the location URI- Returns:
- the created builder
badRequest
static ServerResponse.BodyBuilder badRequest()
Create a builder with a 400 Bad Request status.- Returns:
- the created builder
notFound
static ServerResponse.HeadersBuilder<?> notFound()
Create a builder with a 404 Not Found status.- Returns:
- the created builder
unprocessableEntity
static ServerResponse.BodyBuilder unprocessableEntity()
Create a builder with a 422 Unprocessable Entity status.- Returns:
- the created builder