2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 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
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.rest.exceptions;
23 import lombok.AccessLevel;
24 import lombok.NoArgsConstructor;
25 import lombok.extern.slf4j.Slf4j;
26 import org.onap.cps.ncmp.api.impl.exception.DmiRequestException;
27 import org.onap.cps.ncmp.api.impl.exception.NcmpException;
28 import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException;
29 import org.onap.cps.ncmp.rest.controller.NetworkCmProxyController;
30 import org.onap.cps.ncmp.rest.controller.NetworkCmProxyInventoryController;
31 import org.onap.cps.ncmp.rest.model.ErrorMessage;
32 import org.onap.cps.spi.exceptions.CpsException;
33 import org.onap.cps.spi.exceptions.DataValidationException;
34 import org.springframework.http.HttpStatus;
35 import org.springframework.http.ResponseEntity;
36 import org.springframework.http.converter.HttpMessageNotReadableException;
37 import org.springframework.web.bind.annotation.ExceptionHandler;
38 import org.springframework.web.bind.annotation.RestControllerAdvice;
41 * Exception handler with error message return.
44 @RestControllerAdvice(assignableTypes = {NetworkCmProxyController.class, NetworkCmProxyInventoryController.class})
45 @NoArgsConstructor(access = AccessLevel.PACKAGE)
46 public class NetworkCmProxyRestExceptionHandler {
48 private static final String CHECK_LOGS_FOR_DETAILS = "Check logs for details.";
51 * Default exception handler.
53 * @param exception the exception to handle
54 * @return response with response code 500.
57 public static ResponseEntity<Object> handleInternalServerErrorExceptions(
58 final Exception exception) {
59 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
62 @ExceptionHandler({CpsException.class})
63 public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final CpsException exception) {
64 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
67 @ExceptionHandler({ServerNcmpException.class})
68 public static ResponseEntity<Object> handleServerNcmpExceptions(final ServerNcmpException exception) {
69 return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
72 @ExceptionHandler({DmiRequestException.class})
73 public static ResponseEntity<Object> handleDmiRequestExceptions(final DmiRequestException exception) {
74 return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
77 @ExceptionHandler({DataValidationException.class, HttpMessageNotReadableException.class})
78 public static ResponseEntity<Object> handleDataValidatedExceptions(final Exception exception) {
79 return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
82 private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
83 if (exception.getCause() != null || !(exception instanceof CpsException)) {
84 log.error("Exception occurred", exception);
86 final var errorMessage = new ErrorMessage();
87 errorMessage.setStatus(status.toString());
88 errorMessage.setMessage(exception.getMessage());
89 if (exception instanceof CpsException) {
90 errorMessage.setDetails(((CpsException) exception).getDetails());
91 } else if (exception instanceof NcmpException) {
92 errorMessage.setDetails(((NcmpException) exception).getDetails());
94 errorMessage.setDetails(CHECK_LOGS_FOR_DETAILS);
96 errorMessage.setDetails(exception instanceof CpsException ? ((CpsException) exception).getDetails() :
97 CHECK_LOGS_FOR_DETAILS);
98 return new ResponseEntity<>(errorMessage, status);