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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Pantheon.tech
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  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  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.cps.rest.exceptions;
  21
  22 import lombok.extern.slf4j.Slf4j;
  23 import org.apache.commons.lang3.exception.ExceptionUtils;
  24 import org.onap.cps.rest.controller.AdminRestController;
  25 import org.onap.cps.rest.controller.DataRestController;
  26 import org.onap.cps.rest.controller.QueryRestController;
  27 import org.onap.cps.rest.model.ErrorMessage;
  28 import org.onap.cps.spi.exceptions.CpsAdminException;
  29 import org.onap.cps.spi.exceptions.CpsException;
  30 import org.onap.cps.spi.exceptions.CpsPathException;
  31 import org.onap.cps.spi.exceptions.DataInUseException;
  32 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  33 import org.onap.cps.spi.exceptions.DataValidationException;
  34 import org.onap.cps.spi.exceptions.ModelValidationException;
  35 import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
  36 import org.springframework.http.HttpStatus;
  37 import org.springframework.http.ResponseEntity;
  38 import org.springframework.web.bind.annotation.ExceptionHandler;
  39 import org.springframework.web.bind.annotation.RestControllerAdvice;
  40
  41 @Slf4j
  42 @RestControllerAdvice(assignableTypes = {AdminRestController.class, DataRestController.class,
  43     QueryRestController.class})
  44 public class CpsRestExceptionHandler {
  45
  46     private CpsRestExceptionHandler() {
  47     }
  48
  49     /**
  50      * Default exception handler.
  51      *
  52      * @param exception the exception to handle
  53      * @return response with response code 500.
  54      */
  55     @ExceptionHandler public static ResponseEntity<Object> handleInternalServerErrorExceptions(
  56         final Exception exception) {
  57         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
  58     }
  59
  60     @ExceptionHandler({ModelValidationException.class, DataValidationException.class, CpsAdminException.class,
  61         CpsPathException.class})
  62     public static ResponseEntity<Object> handleBadRequestExceptions(final CpsException exception) {
  63         return buildErrorResponse(HttpStatus.BAD_REQUEST, exception.getMessage(), extractDetails(exception));
  64     }
  65
  66     @ExceptionHandler({NotFoundInDataspaceException.class, DataNodeNotFoundException.class})
  67     public static ResponseEntity<Object> handleNotFoundExceptions(final CpsException exception) {
  68         return buildErrorResponse(HttpStatus.NOT_FOUND, exception.getMessage(), extractDetails(exception));
  69     }
  70
  71     @ExceptionHandler({DataInUseException.class})
  72     public static ResponseEntity<Object> handleDataInUseException(final CpsException exception) {
  73         return buildErrorResponse(HttpStatus.CONFLICT, exception.getMessage(), extractDetails(exception));
  74     }
  75
  76     @ExceptionHandler({CpsException.class})
  77     public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final CpsException exception) {
  78         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception.getMessage(), extractDetails(exception));
  79     }
  80
  81     private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
  82         return buildErrorResponse(status, exception.getMessage(), ExceptionUtils.getStackTrace(exception));
  83     }
  84
  85     private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final String message,
  86         final String details) {
  87         log.error("An error has occurred : {} Status: {} Details: {}", message, status, details);
  88         final ErrorMessage errorMessage = new ErrorMessage();
  89         errorMessage.setStatus(status.toString());
  90         errorMessage.setMessage(message);
  91         errorMessage.setDetails(details);
  92         return new ResponseEntity<>(errorMessage, status);
  93     }
  94
  95     private static String extractDetails(final CpsException exception) {
  96         return exception.getCause() == null
  97             ? exception.getDetails()
  98             : ExceptionUtils.getStackTrace(exception.getCause());
  99     }
 100 }