2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Pantheon.tech
4 * Modifications Copyright (C) 2021-2023 Nordix Foundation
5 * Modifications Copyright (C) 2022 TechMahindra Ltd.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.cps.rest.exceptions;
25 import jakarta.servlet.http.HttpServletRequest;
26 import jakarta.validation.ValidationException;
27 import lombok.AccessLevel;
28 import lombok.NoArgsConstructor;
29 import lombok.extern.slf4j.Slf4j;
30 import org.onap.cps.rest.controller.AdminRestController;
31 import org.onap.cps.rest.controller.DataRestController;
32 import org.onap.cps.rest.controller.QueryRestController;
33 import org.onap.cps.rest.model.ErrorMessage;
34 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
35 import org.onap.cps.spi.exceptions.CpsAdminException;
36 import org.onap.cps.spi.exceptions.CpsException;
37 import org.onap.cps.spi.exceptions.CpsPathException;
38 import org.onap.cps.spi.exceptions.DataInUseException;
39 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
40 import org.onap.cps.spi.exceptions.DataValidationException;
41 import org.onap.cps.spi.exceptions.ModelValidationException;
42 import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
43 import org.springframework.http.HttpMethod;
44 import org.springframework.http.HttpStatus;
45 import org.springframework.http.ResponseEntity;
46 import org.springframework.http.converter.HttpMessageNotReadableException;
47 import org.springframework.web.bind.annotation.ExceptionHandler;
48 import org.springframework.web.bind.annotation.RestControllerAdvice;
51 @RestControllerAdvice(assignableTypes = {AdminRestController.class, DataRestController.class,
52 QueryRestController.class})
53 @NoArgsConstructor(access = AccessLevel.PACKAGE)
54 public class CpsRestExceptionHandler {
57 * Default exception handler.
59 * @param exception the exception to handle
60 * @return response with response code 500.
63 public static ResponseEntity<Object> handleInternalServerErrorExceptions(final Exception exception) {
64 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
67 @ExceptionHandler({ModelValidationException.class, DataValidationException.class, CpsAdminException.class,
68 CpsPathException.class, ValidationException.class, HttpMessageNotReadableException.class})
69 public static ResponseEntity<Object> handleBadRequestExceptions(final Exception exception) {
70 return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
73 @ExceptionHandler({NotFoundInDataspaceException.class, DataNodeNotFoundException.class})
74 public static ResponseEntity<Object> handleNotFoundExceptions(final Exception exception,
75 final HttpServletRequest request) {
76 return buildErrorResponse(HttpMethod.GET.matches(request.getMethod())
77 ? HttpStatus.NOT_FOUND : HttpStatus.BAD_REQUEST, exception);
80 @ExceptionHandler({DataInUseException.class, AlreadyDefinedException.class})
81 public static ResponseEntity<Object> handleDataInUseException(final Exception exception) {
82 return buildErrorResponse(HttpStatus.CONFLICT, exception);
85 @ExceptionHandler({CpsException.class})
86 public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final Exception exception) {
87 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
90 private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
91 if (exception.getCause() != null || !(exception instanceof CpsException)) {
92 log.error("Exception occurred", exception);
94 final var errorMessage = new ErrorMessage();
95 errorMessage.setStatus(status.toString());
96 errorMessage.setMessage(exception.getMessage());
97 errorMessage.setDetails(exception instanceof CpsException ? ((CpsException) exception).getDetails() :
98 "Check logs for details.");
99 return new ResponseEntity<>(errorMessage, status);