Package org.springframework.web

Class ErrorResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.web.ErrorResponseException

All Implemented Interfaces:

Serializable, ErrorResponse

Direct Known Subclasses:

ResponseStatusException

public class ErrorResponseException
extends NestedRuntimeException
implements ErrorResponse

RuntimeException that implements ErrorResponse to expose an HTTP status, response headers, and a body formatted as an RFC 7808 ProblemDetail.

The exception can be used as is, or it can be extended as a more specific exception that populates the type or detail fields, or potentially adds other non-standard fields.

Since:

6.0

Author:

Rossen Stoyanchev

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ErrorResponseException(HttpStatusCode status)	Constructor with a HttpStatusCode.
ErrorResponseException(HttpStatusCode status, Throwable cause)	Constructor with a HttpStatusCode and an optional cause.
ErrorResponseException(HttpStatusCode status, ProblemDetail body, Throwable cause)	Constructor with a given ProblemDetail instance, possibly a subclass of ProblemDetail with extended fields.

Method Summary

Modifier and Type	Method	Description
final ProblemDetail	getBody()	Return the body for the response.
HttpHeaders	getHeaders()	Return headers to use for the response.
String	getMessage()	Return the detail message, including the message from the nested exception if there is one.
HttpStatusCode	getStatusCode()	Return the HTTP status code to use for the response.
void	setDetail(String detail)	Set the detail field of the response body.
void	setInstance(URI instance)	Set the instance field of the response body.
void	setTitle(String title)	Set the title field of the response body.
void	setType(URI type)	Set the type field of the response body.

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMostSpecificCause, getRootCause

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ErrorResponseException

public ErrorResponseException(HttpStatusCode status)

Constructor with a HttpStatusCode.

ErrorResponseException

public ErrorResponseException(HttpStatusCode status,
 @Nullable
 Throwable cause)

Constructor with a HttpStatusCode and an optional cause.

ErrorResponseException

public ErrorResponseException(HttpStatusCode status,
 ProblemDetail body,
 @Nullable
 Throwable cause)

Constructor with a given ProblemDetail instance, possibly a subclass of ProblemDetail with extended fields.

Method Details

getStatusCode

public HttpStatusCode getStatusCode()

Description copied from interface: ErrorResponse

Return the HTTP status code to use for the response.

Specified by:

getStatusCode in interface ErrorResponse

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: ErrorResponse

Return headers to use for the response.

Specified by:

getHeaders in interface ErrorResponse

setType

public void setType(URI type)

Set the type field of the response body.

Parameters:

type - the problem type

setTitle

public void setTitle(@Nullable
 String title)

Set the title field of the response body.

Parameters:

title - the problem title

setDetail

public void setDetail(@Nullable
 String detail)

Set the detail field of the response body.

Parameters:

detail - the problem detail

setInstance

public void setInstance(@Nullable
 URI instance)

Set the instance field of the response body.

Parameters:

instance - the problem instance

getBody

public final ProblemDetail getBody()

Return the body for the response. To customize the body content, use:

• setType(URI)
• setTitle(String)
• setDetail(String)
• setInstance(URI)

By default, the status field of ProblemDetail is initialized from the status provided to the constructor, which in turn may also initialize the title field from the status reason phrase, if the status is well-known. The instance field, if not set, is initialized from the request path when a ProblemDetail is returned from an @ExceptionHandler method.

Specified by:

getBody in interface ErrorResponse

getMessage

public String getMessage()

Description copied from class: NestedRuntimeException

Return the detail message, including the message from the nested exception if there is one.

Overrides:

getMessage in class NestedRuntimeException