cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/exceptions/NetworkCmProxyRestExceptionHandler.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Pantheon.tech
   4  *  Modifications Copyright (C) 2021-2024 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  *  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.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.rest.exceptions;
  22
  23 import lombok.AccessLevel;
  24 import lombok.NoArgsConstructor;
  25 import lombok.extern.slf4j.Slf4j;
  26 import org.onap.cps.ncmp.api.impl.exception.DmiClientRequestException;
  27 import org.onap.cps.ncmp.api.impl.exception.DmiRequestException;
  28 import org.onap.cps.ncmp.api.impl.exception.InvalidDatastoreException;
  29 import org.onap.cps.ncmp.api.impl.exception.InvalidDmiResourceUrlException;
  30 import org.onap.cps.ncmp.api.impl.exception.NcmpException;
  31 import org.onap.cps.ncmp.api.impl.exception.ServerNcmpException;
  32 import org.onap.cps.ncmp.rest.controller.NetworkCmProxyController;
  33 import org.onap.cps.ncmp.rest.controller.NetworkCmProxyInventoryController;
  34 import org.onap.cps.ncmp.rest.model.DmiErrorMessage;
  35 import org.onap.cps.ncmp.rest.model.DmiErrorMessageDmiResponse;
  36 import org.onap.cps.ncmp.rest.model.ErrorMessage;
  37 import org.onap.cps.spi.exceptions.AlreadyDefinedException;
  38 import org.onap.cps.spi.exceptions.CpsException;
  39 import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
  40 import org.onap.cps.spi.exceptions.DataValidationException;
  41 import org.springframework.http.HttpStatus;
  42 import org.springframework.http.ResponseEntity;
  43 import org.springframework.http.converter.HttpMessageNotReadableException;
  44 import org.springframework.web.bind.annotation.ExceptionHandler;
  45 import org.springframework.web.bind.annotation.RestControllerAdvice;
  46
  47 /**
  48  * Exception handler with error message return.
  49  */
  50 @Slf4j
  51 @RestControllerAdvice(assignableTypes = {NetworkCmProxyController.class, NetworkCmProxyInventoryController.class})
  52 @NoArgsConstructor(access = AccessLevel.PACKAGE)
  53 public class NetworkCmProxyRestExceptionHandler {
  54
  55     private static final String CHECK_LOGS_FOR_DETAILS = "Check logs for details.";
  56
  57     /**
  58      * Default exception handler.
  59      *
  60      * @param exception the exception to handle
  61      * @return response with response code 500.
  62      */
  63     @ExceptionHandler
  64     public static ResponseEntity<Object> handleInternalServerErrorExceptions(final Exception exception) {
  65         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
  66     }
  67
  68     @ExceptionHandler({CpsException.class, ServerNcmpException.class})
  69     public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final Exception exception) {
  70         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
  71     }
  72
  73     @ExceptionHandler({DmiClientRequestException.class})
  74     public static ResponseEntity<Object> handleClientRequestExceptions(
  75             final DmiClientRequestException dmiClientRequestException) {
  76         return wrapDmiErrorResponse(dmiClientRequestException);
  77     }
  78
  79     @ExceptionHandler({DmiRequestException.class, DataValidationException.class, OperationNotSupportedException.class,
  80             HttpMessageNotReadableException.class, InvalidTopicException.class, InvalidDatastoreException.class,
  81             InvalidDmiResourceUrlException.class})
  82     public static ResponseEntity<Object> handleDmiRequestExceptions(final Exception exception) {
  83         return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
  84     }
  85
  86     @ExceptionHandler({AlreadyDefinedException.class})
  87     public static ResponseEntity<Object> handleAlreadyDefinedExceptions(final Exception exception) {
  88         return buildErrorResponse(HttpStatus.CONFLICT, exception);
  89     }
  90
  91     @ExceptionHandler({DataNodeNotFoundException.class})
  92     public static ResponseEntity<Object> handleNotFoundExceptions(final Exception exception) {
  93         return buildErrorResponse(HttpStatus.NOT_FOUND, exception);
  94     }
  95
  96     @ExceptionHandler({PayloadTooLargeException.class})
  97     public static ResponseEntity<Object> handlePayloadTooLargeExceptions(final Exception exception) {
  98         return buildErrorResponse(HttpStatus.PAYLOAD_TOO_LARGE, exception);
  99     }
 100
 101     private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
 102         if (exception.getCause() != null || !(exception instanceof CpsException)) {
 103             log.error("Exception occurred", exception);
 104         }
 105         final var errorMessage = new ErrorMessage();
 106         errorMessage.setStatus(status.toString());
 107         errorMessage.setMessage(exception.getMessage());
 108         if (exception instanceof CpsException) {
 109             errorMessage.setDetails(((CpsException) exception).getDetails());
 110         } else if (exception instanceof NcmpException) {
 111             errorMessage.setDetails(((NcmpException) exception).getDetails());
 112         } else {
 113             errorMessage.setDetails(CHECK_LOGS_FOR_DETAILS);
 114         }
 115         errorMessage.setDetails(
 116                 exception instanceof CpsException ? ((CpsException) exception).getDetails() : CHECK_LOGS_FOR_DETAILS);
 117         return new ResponseEntity<>(errorMessage, status);
 118     }
 119
 120     private static ResponseEntity<Object> wrapDmiErrorResponse(final DmiClientRequestException
 121                                                                        dmiClientRequestException) {
 122         final var dmiErrorMessage = new DmiErrorMessage();
 123         final var dmiErrorResponse = new DmiErrorMessageDmiResponse();
 124         dmiErrorResponse.setHttpCode(dmiClientRequestException.getHttpStatusCode());
 125         dmiErrorResponse.setBody(dmiClientRequestException.getResponseBodyAsString());
 126         dmiErrorMessage.setMessage(dmiClientRequestException.getMessage());
 127         dmiErrorMessage.setDmiResponse(dmiErrorResponse);
 128         return new ResponseEntity<>(dmiErrorMessage, HttpStatus.BAD_GATEWAY);
 129     }
 130 }