Package org.springframework.web
Interface ErrorResponse
- All Known Implementing Classes:
AsyncRequestTimeoutException
,ErrorResponseException
,HttpMediaTypeException
,HttpMediaTypeNotAcceptableException
,HttpMediaTypeNotSupportedException
,HttpRequestMethodNotSupportedException
,MethodArgumentNotValidException
,MethodNotAllowedException
,MissingMatrixVariableException
,MissingPathVariableException
,MissingRequestCookieException
,MissingRequestHeaderException
,MissingRequestValueException
,MissingRequestValueException
,MissingServletRequestParameterException
,MissingServletRequestPartException
,NoHandlerFoundException
,NotAcceptableStatusException
,ResponseStatusException
,ServerErrorException
,ServerWebInputException
,ServletRequestBindingException
,UnsatisfiedRequestParameterException
,UnsatisfiedServletRequestParameterException
,UnsupportedMediaTypeStatusException
,WebExchangeBindException
public interface ErrorResponse
Representation of a complete RFC 7807 error response including status,
headers, and an RFC 7808 formatted
ProblemDetail
body. Allows any
exception to expose HTTP error response information.
ErrorResponseException
is a default implementation of this
interface and a convenient base class for other exceptions to use.
ErrorResponse
is supported as a return value from
@ExceptionHandler
methods that render directly to the response, e.g.
by being marked @ResponseBody
, or declared in an
@RestController
or RestControllerAdvice
class.
- Since:
- 6.0
- Author:
- Rossen Stoyanchev
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetBody()
Return the body for the response, formatted as an RFC 7807ProblemDetail
whosestatus
should match the response status.default HttpHeaders
Return headers to use for the response.Return the HTTP status code to use for the response.
-
Method Details
-
getStatusCode
HttpStatusCode getStatusCode()Return the HTTP status code to use for the response. -
getHeaders
Return headers to use for the response. -
getBody
ProblemDetail getBody()Return the body for the response, formatted as an RFC 7807ProblemDetail
whosestatus
should match the response status.
-