cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java

   1 /*
   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
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.rest.exceptions;
  23
  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.CpsAdminException;
  35 import org.onap.cps.spi.exceptions.CpsException;
  36 import org.onap.cps.spi.exceptions.CpsPathException;
  37 import org.onap.cps.spi.exceptions.DataInUseException;
  38 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  39 import org.onap.cps.spi.exceptions.DataValidationException;
  40 import org.onap.cps.spi.exceptions.ModelValidationException;
  41 import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
  42 import org.springframework.http.HttpMethod;
  43 import org.springframework.http.HttpStatus;
  44 import org.springframework.http.ResponseEntity;
  45 import org.springframework.web.bind.annotation.ExceptionHandler;
  46 import org.springframework.web.bind.annotation.RestControllerAdvice;
  47
  48 @Slf4j
  49 @RestControllerAdvice(assignableTypes = {AdminRestController.class, DataRestController.class,
  50     QueryRestController.class})
  51 @NoArgsConstructor(access = AccessLevel.PACKAGE)
  52 public class CpsRestExceptionHandler {
  53
  54     /**
  55      * Default exception handler.
  56      *
  57      * @param exception the exception to handle
  58      * @return response with response code 500.
  59      */
  60     @ExceptionHandler
  61     public static ResponseEntity<Object> handleInternalServerErrorExceptions(final Exception exception) {
  62         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
  63     }
  64
  65     @ExceptionHandler({ModelValidationException.class, DataValidationException.class, CpsAdminException.class,
  66         CpsPathException.class, ValidationException.class})
  67     public static ResponseEntity<Object> handleBadRequestExceptions(final Exception exception) {
  68         return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
  69     }
  70
  71     @ExceptionHandler({NotFoundInDataspaceException.class, DataNodeNotFoundException.class})
  72     public static ResponseEntity<Object> handleNotFoundExceptions(final Exception exception,
  73         final HttpServletRequest request) {
  74         return buildErrorResponse(HttpMethod.GET.matches(request.getMethod())
  75             ? HttpStatus.NOT_FOUND : HttpStatus.BAD_REQUEST, exception);
  76     }
  77
  78     @ExceptionHandler({DataInUseException.class, AlreadyDefinedException.class})
  79     public static ResponseEntity<Object> handleDataInUseException(final Exception exception) {
  80         return buildErrorResponse(HttpStatus.CONFLICT, exception);
  81     }
  82
  83     @ExceptionHandler({CpsException.class})
  84     public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final Exception exception) {
  85         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
  86     }
  87
  88     private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
  89         if (exception.getCause() != null || !(exception instanceof CpsException)) {
  90             log.error("Exception occurred", exception);
  91         }
  92         final var errorMessage = new ErrorMessage();
  93         errorMessage.setStatus(status.toString());
  94         errorMessage.setMessage(exception.getMessage());
  95         errorMessage.setDetails(exception instanceof CpsException ? ((CpsException) exception).getDetails() :
  96             "Check logs for details.");
  97         return new ResponseEntity<>(errorMessage, status);
  98     }
  99 }