1 /*
2 * Copyright 2019-2022 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.bremersee.exception;
18
19 import org.bremersee.exception.model.RestApiException;
20 import org.springframework.lang.Nullable;
21
22 /**
23 * Maps the error response into a {@link RestApiException}.
24 *
25 * @author Christian Bremer
26 */
27 public interface RestApiExceptionMapper {
28
29 /**
30 * Build the exception model from the exception, the requested path and a handler. Typically, the
31 * handler is of type {@link org.springframework.web.method.HandlerMethod}.
32 *
33 * @param exception the exception (required)
34 * @param requestPath the requested path (optional)
35 * @param handler the handler (optional)
36 * @return the rest api exception
37 */
38 RestApiException build(
39 Throwable exception,
40 @Nullable String requestPath,
41 @Nullable Object handler);
42
43 }