org.springframework.web.ErrorResponseException Maven / Gradle / Ivy
/*
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web;
import java.net.URI;
import org.springframework.core.NestedRuntimeException;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatusCode;
import org.springframework.http.ProblemDetail;
import org.springframework.lang.Nullable;
/**
* {@link RuntimeException} that implements {@link ErrorResponse} to expose
* an HTTP status, response headers, and a body formatted as an RFC 9457
* {@link ProblemDetail}.
*
* The exception can be used as is, or it can be extended as a more specific
* exception that populates the {@link ProblemDetail#setType(URI) type} or
* {@link ProblemDetail#setDetail(String) detail} fields, or potentially adds
* other non-standard properties.
*
* @author Rossen Stoyanchev
* @since 6.0
*/
@SuppressWarnings("serial")
public class ErrorResponseException extends NestedRuntimeException implements ErrorResponse {
private final HttpStatusCode status;
private final HttpHeaders headers = new HttpHeaders();
private final ProblemDetail body;
private final String messageDetailCode;
@Nullable
private final Object[] messageDetailArguments;
/**
* Constructor with an {@link HttpStatusCode}.
*/
public ErrorResponseException(HttpStatusCode status) {
this(status, null);
}
/**
* Constructor with an {@link HttpStatusCode} and an optional cause.
*/
public ErrorResponseException(HttpStatusCode status, @Nullable Throwable cause) {
this(status, ProblemDetail.forStatus(status), cause);
}
/**
* Constructor with a given {@link ProblemDetail} instance, possibly a
* subclass of {@code ProblemDetail} with extended fields.
*/
public ErrorResponseException(HttpStatusCode status, ProblemDetail body, @Nullable Throwable cause) {
this(status, body, cause, null, null);
}
/**
* Constructor with a given {@link ProblemDetail}, and a
* {@link org.springframework.context.MessageSource} code and arguments to
* resolve the detail message with.
* @since 6.0
*/
public ErrorResponseException(
HttpStatusCode status, ProblemDetail body, @Nullable Throwable cause,
@Nullable String messageDetailCode, @Nullable Object[] messageDetailArguments) {
super(null, cause);
this.status = status;
this.body = body;
this.messageDetailCode = initMessageDetailCode(messageDetailCode);
this.messageDetailArguments = messageDetailArguments;
}
private String initMessageDetailCode(@Nullable String messageDetailCode) {
return (messageDetailCode != null ?
messageDetailCode : ErrorResponse.getDefaultDetailMessageCode(getClass(), null));
}
@Override
public HttpStatusCode getStatusCode() {
return this.status;
}
@Override
public HttpHeaders getHeaders() {
return this.headers;
}
/**
* Set the {@link ProblemDetail#setType(URI) type} field of the response body.
* @param type the problem type
*/
public void setType(URI type) {
this.body.setType(type);
}
/**
* Set the {@link ProblemDetail#setTitle(String) title} field of the response body.
* @param title the problem title
*/
public void setTitle(@Nullable String title) {
this.body.setTitle(title);
}
/**
* Set the {@link ProblemDetail#setDetail(String) detail} field of the response body.
* @param detail the problem detail
*/
public void setDetail(@Nullable String detail) {
this.body.setDetail(detail);
}
/**
* Set the {@link ProblemDetail#setInstance(URI) instance} field of the response body.
* @param instance the problem instance
*/
public void setInstance(@Nullable URI instance) {
this.body.setInstance(instance);
}
/**
* Return the body for the response. To customize the body content, use:
*
* - {@link #setType(URI)}
*
- {@link #setTitle(String)}
*
- {@link #setDetail(String)}
*
- {@link #setInstance(URI)}
*
* By default, the status field of {@link 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 {@code ProblemDetail} is returned from an
* {@code @ExceptionHandler} method.
*/
@Override
public final ProblemDetail getBody() {
return this.body;
}
@Override
public String getDetailMessageCode() {
return this.messageDetailCode;
}
@Override
@Nullable
public Object[] getDetailMessageArguments() {
return this.messageDetailArguments;
}
@Override
public String getMessage() {
return this.status + (!this.headers.isEmpty() ? ", headers=" + this.headers : "") + ", " + this.body;
}
}