Improve logging in NCMP

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

diff --git a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java
old mode 100644 (file)
new mode 100755 (executable)
index 9cf4935..52af81c
--- a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java
+++ b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java
@@ -1,12 +1,14 @@
 /*
- * ============LICENSE_START=======================================================
+ *  ============LICENSE_START=======================================================
  *  Copyright (C) 2020 Pantheon.tech
+ *  Modifications Copyright (C) 2021-2022 Nordix Foundation
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
  *
  *        http://www.apache.org/licenses/LICENSE-2.0
+ *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -19,19 +21,31 @@
 
 package org.onap.cps.rest.exceptions;
 
-import org.apache.commons.lang3.exception.ExceptionUtils;
-import org.hibernate.exception.ConstraintViolationException;
-import org.onap.cps.exceptions.CpsException;
-import org.onap.cps.exceptions.CpsNotFoundException;
-import org.onap.cps.exceptions.CpsValidationException;
-import org.onap.cps.rest.controller.CpsRestController;
-import org.springframework.dao.EmptyResultDataAccessException;
+import javax.servlet.http.HttpServletRequest;
+import javax.validation.ValidationException;
+import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.rest.controller.AdminRestController;
+import org.onap.cps.rest.controller.DataRestController;
+import org.onap.cps.rest.controller.QueryRestController;
+import org.onap.cps.rest.model.ErrorMessage;
+import org.onap.cps.spi.exceptions.AlreadyDefinedException;
+import org.onap.cps.spi.exceptions.CpsAdminException;
+import org.onap.cps.spi.exceptions.CpsException;
+import org.onap.cps.spi.exceptions.CpsPathException;
+import org.onap.cps.spi.exceptions.DataInUseException;
+import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
+import org.onap.cps.spi.exceptions.DataValidationException;
+import org.onap.cps.spi.exceptions.ModelValidationException;
+import org.onap.cps.spi.exceptions.NotFoundInDataspaceException;
+import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
-@RestControllerAdvice(assignableTypes = {CpsRestController.class})
+@Slf4j
+@RestControllerAdvice(assignableTypes = {AdminRestController.class, DataRestController.class,
+    QueryRestController.class})
 public class CpsRestExceptionHandler {
 
     /**
@@ -41,58 +55,47 @@ public class CpsRestExceptionHandler {
      * @return response with response code 500.
      */
     @ExceptionHandler
-    public ResponseEntity<Object> handleInternalErrorException(Exception exception) {
+    public static ResponseEntity<Object> handleInternalServerErrorExceptions(final Exception exception) {
         return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
     }
 
-    /*
-        TODO: Rid off extra dependencies.
-
-        Generic exception handler and CpsException (incl. children) are the only
-        exceptions to be handled here. All the other exceptions which require a special
-        treatment should be rethrown as CpsException in the place of occurrence ->
-        e.g. persistence exceptions are to be handled in cps-ri module.
-     */
-
-    @ExceptionHandler({ConstraintViolationException.class})
-    public ResponseEntity<Object> handleBadRequestException(Exception exception) {
+    @ExceptionHandler({ModelValidationException.class, DataValidationException.class, CpsAdminException.class,
+        CpsPathException.class})
+    public static ResponseEntity<Object> handleBadRequestExceptions(final CpsException exception) {
         return buildErrorResponse(HttpStatus.BAD_REQUEST, exception);
     }
 
-    @ExceptionHandler({EmptyResultDataAccessException.class})
-    public ResponseEntity<Object> handleNotFoundException(Exception exception) {
-        return buildErrorResponse(HttpStatus.NOT_FOUND, exception);
+    @ExceptionHandler({ValidationException.class})
+    public static ResponseEntity<Object> handleBadRequestExceptions(final ValidationException validationException) {
+        return buildErrorResponse(HttpStatus.BAD_REQUEST, validationException);
     }
 
-    @ExceptionHandler({CpsException.class})
-    public ResponseEntity<Object> handleCpsException(CpsException exception) {
-        return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception.getMessage(), extractDetails(exception));
+    @ExceptionHandler({NotFoundInDataspaceException.class, DataNodeNotFoundException.class})
+    public static ResponseEntity<Object> handleNotFoundExceptions(final CpsException exception,
+        final HttpServletRequest request) {
+        return buildErrorResponse(HttpMethod.GET.matches(request.getMethod())
+            ? HttpStatus.NOT_FOUND : HttpStatus.BAD_REQUEST, exception);
     }
 
-    @ExceptionHandler({CpsValidationException.class})
-    public ResponseEntity<Object> handleCpsValidationException(CpsException exception) {
-        return buildErrorResponse(HttpStatus.BAD_REQUEST, exception.getMessage(), extractDetails(exception));
+    @ExceptionHandler({DataInUseException.class, AlreadyDefinedException.class})
+    public static ResponseEntity<Object> handleDataInUseException(final CpsException exception) {
+        return buildErrorResponse(HttpStatus.CONFLICT, exception);
     }
 
-    @ExceptionHandler({CpsNotFoundException.class})
-    public ResponseEntity<Object> handleCpsNotFoundException(CpsException exception) {
-        return buildErrorResponse(HttpStatus.NOT_FOUND, exception.getMessage(), extractDetails(exception));
-    }
-
-    private static ResponseEntity<Object> buildErrorResponse(HttpStatus status, Exception exception) {
-        return buildErrorResponse(status, exception.getMessage(), ExceptionUtils.getStackTrace(exception));
-    }
-
-    private static ResponseEntity<Object> buildErrorResponse(HttpStatus status, String message, String details) {
-        return new ResponseEntity<>(
-            ErrorMessage.builder().status(status.toString()).message(message).details(details).build(),
-            status
-        );
+    @ExceptionHandler({CpsException.class})
+    public static ResponseEntity<Object> handleAnyOtherCpsExceptions(final CpsException exception) {
+        return buildErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception);
     }
 
-    private static String extractDetails(CpsException exception) {
-        return exception.getCause() == null
-            ? exception.getDetails()
-            : ExceptionUtils.getStackTrace(exception.getCause());
+    private static ResponseEntity<Object> buildErrorResponse(final HttpStatus status, final Exception exception) {
+        if (exception.getCause() != null || !(exception instanceof CpsException)) {
+            log.error("Exception occurred", exception);
+        }
+        final var errorMessage = new ErrorMessage();
+        errorMessage.setStatus(status.toString());
+        errorMessage.setMessage(exception.getMessage());
+        errorMessage.setDetails(exception instanceof CpsException ? ((CpsException) exception).getDetails() :
+            "Check logs for details.");
+        return new ResponseEntity<>(errorMessage, status);
     }
 }