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