Fix api sonar bugs - logging exceptions

Fix api sonar bugs by logging exceptions in api controllers

Issue-ID: POLICY-1710
Change-Id: Ie591e0d4709c43f3e91aa7b94a1305d8814bd695
Signed-off-by: Chenfei Gao <cgao@research.att.com>

diff --git a/main/src/main/java/org/onap/policy/api/main/rest/ApiRestController.java b/main/src/main/java/org/onap/policy/api/main/rest/ApiRestController.java
index 1863b23..2431542 100644 (file)
--- a/main/src/main/java/org/onap/policy/api/main/rest/ApiRestController.java
+++ b/main/src/main/java/org/onap/policy/api/main/rest/ApiRestController.java
@@ -59,6 +59,8 @@ import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.base.PfModelRuntimeException;\r
 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;\r
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;\r
+import org.slf4j.Logger;\r
+import org.slf4j.LoggerFactory;\r
 \r
 /**\r
  * Class to provide REST API services.\r
@@ -89,6 +91,8 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
         securityDefinition = @SecurityDefinition(basicAuthDefinitions = { @BasicAuthDefinition(key = "basicAuth") }))\r
 public class ApiRestController {\r
 \r
+    private static final Logger LOGGER = LoggerFactory.getLogger(ApiRestController.class);\r
+\r
     /**\r
      * Retrieves the healthcheck status of the API component.\r
      *\r
@@ -234,6 +238,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes", pfme);\r
             updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -294,6 +299,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}", policyTypeId, pfme);\r
             updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -356,6 +362,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
             updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -416,6 +423,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/latest", policyTypeId, pfme);\r
             updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -476,6 +484,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("POST /policytypes", pfme);\r
             updateApiStatisticsCounter(Target.POLICY_TYPE, Result.FAILURE, HttpMethod.POST);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -540,6 +549,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("DELETE /policytypes/{}/versions/{}", policyTypeId, versionId, pfme);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
                     .entity(pfme.getErrorResponse()).build();\r
@@ -603,6 +613,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -669,6 +680,8 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("/policytypes/{}/versions/{}/policies/{}", policyTypeId, policyTypeVersion, policyId,\r
+                    pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -737,6 +750,8 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
+                    policyTypeVersion, policyId, policyVersion, pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -803,6 +818,8 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/latest", policyTypeId,\r
+                    policyTypeVersion, policyId, pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -869,6 +886,8 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(deployedPolicies).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("GET /policytypes/{}/versions/{}/policies/{}/versions/deployed", policyTypeId,\r
+                    policyTypeVersion, policyId, pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.GET);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -936,6 +955,7 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("POST /policytypes/{}/versions/{}/policies", policyTypeId, policyTypeVersion, pfme);\r
             updateApiStatisticsCounter(Target.POLICY, Result.FAILURE, HttpMethod.POST);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
@@ -1004,6 +1024,8 @@ public class ApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)\r
                     .entity(serviceTemplate).build();\r
         } catch (PfModelException | PfModelRuntimeException pfme) {\r
+            LOGGER.error("DELETE /policytypes/{}/versions/{}/policies/{}/versions/{}", policyTypeId,\r
+                    policyTypeVersion, policyId, policyVersion, pfme);\r
             return addLoggingHeaders(addVersionControlHeaders(\r
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)\r
                     .entity(pfme.getErrorResponse()).build();\r

diff --git a/main/src/main/java/org/onap/policy/api/main/rest/LegacyApiRestController.java b/main/src/main/java/org/onap/policy/api/main/rest/LegacyApiRestController.java
index ed6e1d8..f668881 100644 (file)
--- a/main/src/main/java/org/onap/policy/api/main/rest/LegacyApiRestController.java
+++ b/main/src/main/java/org/onap/policy/api/main/rest/LegacyApiRestController.java
@@ -50,6 +50,8 @@ import org.onap.policy.models.base.PfModelRuntimeException;
 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyInput;
 import org.onap.policy.models.tosca.legacy.concepts.LegacyGuardPolicyOutput;
 import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Class to provide legacy REST API services.
@@ -62,6 +64,8 @@ import org.onap.policy.models.tosca.legacy.concepts.LegacyOperationalPolicy;
 @Consumes("application/json")
 public class LegacyApiRestController {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(LegacyApiRestController.class);
+
     /**
      * Retrieves all versions of a particular guard policy.
      *
@@ -114,6 +118,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policies).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("GET /policytypes/onap.policies.controlloop.Guard/versions/1.0.0/policies/{}",
+                    policyId, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -175,6 +181,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policies).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("GET /policytypes/onap.policies.controlloop.Guard/versions/1.0.0/policies/{}/versions/{}",
+                    policyId, policyVersion, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -233,6 +241,7 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policy).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("POST /policytypes/onap.policies.controlloop.Guard/versions/1.0.0/policies", pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -295,6 +304,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policies).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("DELETE /policytypes/onap.policies.controlloop.Guard/versions/1.0.0/policies/{}/versions/{}",
+                    policyId, policyVersion, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -353,6 +364,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policy).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("GET /policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{}",
+                    policyId, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -414,6 +427,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policy).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("GET /policytypes/onap.policies.controlloop.Operational/versions/1.0.0/"
+                + "policies/{}/versions/{}", policyId, policyVersion, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -472,6 +487,7 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policy).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("POST /policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies", pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();
@@ -535,6 +551,8 @@ public class LegacyApiRestController {
             return addLoggingHeaders(addVersionControlHeaders(Response.status(Response.Status.OK)), requestId)
                     .entity(policy).build();
         } catch (PfModelException | PfModelRuntimeException pfme) {
+            LOGGER.error("DELETE /policytypes/onap.policies.controlloop.Operational/versions/1.0.0/"
+                + "policies/{}/versions/{}", policyId, policyVersion, pfme);
             return addLoggingHeaders(addVersionControlHeaders(
                     Response.status(pfme.getErrorResponse().getResponseCode())), requestId)
                     .entity(pfme.getErrorResponse()).build();