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
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.
16 * SPDX-License-Identifier: Apache-2.0
17 * ============LICENSE_END=========================================================
20 package org.onap.cps.rest.exceptions;
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.model.ErrorMessage;
27 import org.onap.cps.spi.exceptions.CpsAdminException;
28 import org.onap.cps.spi.exceptions.CpsException;
29 import org.onap.cps.spi.exceptions.DataInUseException;
30 import org.onap.cps.spi.exceptions.DataValidationException;
31 import org.onap.cps.spi.exceptions.ModelValidationException;
32 import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
33 import org.springframework.http.HttpStatus;
34 import org.springframework.http.ResponseEntity;
35 import org.springframework.web.bind.annotation.ExceptionHandler;
36 import org.springframework.web.bind.annotation.RestControllerAdvice;
39 @RestControllerAdvice(assignableTypes = {AdminRestController.class, DataRestController.class})
40 public class CpsRestExceptionHandler {
42 private CpsRestExceptionHandler() {
46 * Default exception handler.
48 * @param exception the exception to handle
49 * @return response with response code 500.
51 @ExceptionHandler public static ResponseEntity<Object> handleInternalServerErrorExceptions(
52 final Exception exception) {
53 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
56 @ExceptionHandler({ModelValidationException.class, DataValidationException.class, CpsAdminException.class})
57 public static ResponseEntity<Object> handleBadRequestExceptions(final CpsException exception) {
58 return buildErrorResponse(HttpStatus.BAD_REQUEST, exception.getMessage(), extractDetails(exception));
61 @ExceptionHandler({NotFoundInDataspaceException.class})
62 public static ResponseEntity<Object> handleNotFoundExceptions(final CpsException exception) {
63 return buildErrorResponse(HttpStatus.NOT_FOUND, exception.getMessage(), extractDetails(exception));
66 @ExceptionHandler({DataInUseException.class})
67 public static ResponseEntity<Object> handleDataInUseException(final CpsException exception) {
68 return buildErrorResponse(HttpStatus.CONFLICT, exception.getMessage(), extractDetails(exception));
71 @ExceptionHandler({CpsException.class})
72 public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final CpsException exception) {
73 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception.getMessage(), extractDetails(exception));
76 private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
77 return buildErrorResponse(status, exception.getMessage(), ExceptionUtils.getStackTrace(exception));
80 private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final String message,
81 final String details) {
82 log.error("An error has occurred : {} Status: {} Details: {}", message, status, details);
83 final ErrorMessage errorMessage = new ErrorMessage();
84 errorMessage.setStatus(status.toString());
85 errorMessage.setMessage(message);
86 errorMessage.setDetails(details);
87 return new ResponseEntity<>(errorMessage, status);
90 private static String extractDetails(final CpsException exception) {
91 return exception.getCause() == null
92 ? exception.getDetails()
93 : ExceptionUtils.getStackTrace(exception.getCause());