gerrit.onap Code Review - cps.git/blob

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