X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=ONAP-REST%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fpolicy%2Frest%2FXacmlRest.java;fp=ONAP-REST%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fpolicy%2Frest%2FXACMLRest.java;h=011fb886875a0f40fbf92e4a053e9055c8d34869;hb=refs%2Fchanges%2F96%2F97596%2F1;hp=7cced5667255337999e9939e38406c46cf9a1df5;hpb=766f999081e73b301062f1b96bffb9c52d7e9852;p=policy%2Fengine.git

diff --git a/ONAP-REST/src/main/java/org/onap/policy/rest/XACMLRest.java b/ONAP-REST/src/main/java/org/onap/policy/rest/XacmlRest.java
similarity index 76%
rename from ONAP-REST/src/main/java/org/onap/policy/rest/XACMLRest.java
rename to ONAP-REST/src/main/java/org/onap/policy/rest/XacmlRest.java
index 7cced5667..011fb8868 100644
--- a/ONAP-REST/src/main/java/org/onap/policy/rest/XACMLRest.java
+++ b/ONAP-REST/src/main/java/org/onap/policy/rest/XacmlRest.java
@@ -4,13 +4,14 @@
  * ================================================================================
  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
  * Modified Copyright (C) 2018 Samsung Electronics Co., Ltd.
+ * Modifications Copyright (C) 2019 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.
@@ -21,6 +22,8 @@
 
 package org.onap.policy.rest;
 
+import com.att.research.xacml.util.XACMLProperties;
+
 import java.io.IOException;
 import java.util.Enumeration;
 import java.util.Map;
@@ -35,37 +38,31 @@ import org.apache.commons.logging.LogFactory;
 import org.onap.policy.common.logging.eelf.MessageCodes;
 import org.onap.policy.common.logging.eelf.PolicyLogger;
 
-import com.att.research.xacml.util.XACMLProperties;
-
-
 /**
- * This static class is used by both the PDP and PAP servlet's. It contains some common
- * static functions and objects used by both the servlet's.
- * 
+ * This static class is used by both the PDP and PAP servlet's. It contains some common static functions and objects
+ * used by both the servlet's.
+ *
  *
  */
-public class XACMLRest {
-    private static final Log logger	= LogFactory.getLog(XACMLRest.class);
+public class XacmlRest {
+    private static final Log logger = LogFactory.getLog(XacmlRest.class);
     private static Properties restProperties = new Properties();
 
-    private XACMLRest(){
+    private XacmlRest() {
         // Empty constructor
     }
+
     /**
-     * This must be called during servlet initialization. It sets up the xacml.?.properties
-     * file as a system property. If the System property is already set, then it does not
-     * do anything. This allows the developer to specify their own xacml.properties file to be
-     * used. They can 1) modify the default properties that comes with the project, or 2) change
-     * the WebInitParam annotation, or 3) specify an alternative path in the web.xml, or 4) set
-     * the Java System property to point to their xacml.properties file.
-     *
-     * The recommended way of overriding the default xacml.properties file is using a Java System
-     * property:
+     * This must be called during servlet initialization. It sets up the xacml.?.properties file as a system property.
+     * If the System property is already set, then it does not do anything. This allows the developer to specify their
+     * own xacml.properties file to be used. They can 1) modify the default properties that comes with the project, or
+     * 2) change the WebInitParam annotation, or 3) specify an alternative path in the web.xml, or 4) set the Java
+     * System property to point to their xacml.properties file.
      *
+     * <p>The recommended way of overriding the default xacml.properties file is using a Java System property:
      * -Dxacml.properties=/opt/app/xacml/etc/xacml.admin.properties
      *
-     * This way one does not change any actual code or files in the project and can leave the
-     * defaults alone.
+     * <p>This way one does not change any actual code or files in the project and can leave the defaults alone.
      *
      * @param config - The servlet config file passed from the javax servlet init() function
      */
@@ -100,7 +97,7 @@ public class XACMLRest {
         Enumeration<String> params = config.getInitParameterNames();
         while (params.hasMoreElements()) {
             String param = params.nextElement();
-            if (! "XACML_PROPERTIES_NAME".equals(param)) {
+            if (!"XACML_PROPERTIES_NAME".equals(param)) {
                 String value = config.getInitParameter(param);
                 PolicyLogger.info(param + "=" + config.getInitParameter(param));
                 restProperties.setProperty(param, value);
@@ -109,15 +106,14 @@ public class XACMLRest {
     }
 
     /**
-     * Reset's the XACMLProperties internal properties object so we start
-     * in a fresh environment. Then adds back in our Servlet init properties that were
-     * passed in the javax Servlet init() call.
+     * Reset's the XACMLProperties internal properties object so we start in a fresh environment. Then adds back in our
+     * Servlet init properties that were passed in the javax Servlet init() call.
      *
-     * This function is primarily used when a new configuration is passed in and the
-     * PDP servlet needs to load a new PDP engine instance.
+     * <p>This function is primarily used when a new configuration is passed in and the PDP servlet needs to load a new
+     * PDP engine instance.
      *
      * @param pipProperties - PIP configuration properties
-     * @param policyProperties  - Policy configuration properties
+     * @param policyProperties - Policy configuration properties
      */
     public static void loadXacmlProperties(Properties policyProperties, Properties pipProperties) {
         try {
@@ -128,7 +124,7 @@ public class XACMLRest {
             //
             // Now load our init properties
             //
-            XACMLProperties.getProperties().putAll(XACMLRest.restProperties);
+            XACMLProperties.getProperties().putAll(XacmlRest.restProperties);
             //
             // Load our policy properties
             //
@@ -142,7 +138,8 @@ public class XACMLRest {
                 XACMLProperties.getProperties().putAll(pipProperties);
             }
         } catch (IOException e) {
-            PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e, "Failed to put init properties into Xacml properties");
+            PolicyLogger.error(MessageCodes.ERROR_PROCESS_FLOW, e,
+                    "Failed to put init properties into Xacml properties");
         }
         //
         // Dump them
@@ -166,12 +163,26 @@ public class XACMLRest {
             return;
         }
 
-        // special-case for receiving heartbeat - don't need to repeatedly output all of the information in multiple lines
-        if ("GET".equals(request.getMethod()) && "hb".equals(request.getParameter("type"))  ) {
+        // special-case for receiving heartbeat - don't need to repeatedly output all of the information in multiple
+        // lines
+        if ("GET".equals(request.getMethod()) && "hb".equals(request.getParameter("type"))) {
             PolicyLogger.debug("GET type=hb : heartbeat received");
             return;
         }
-        logger.debug(request.getMethod() + ":" + request.getRemoteAddr() + " " + request.getRemoteHost() + " " + request.getRemotePort());
+
+        dumpRequestHeadersAttributesContextPath(request);
+
+        dumpRequestBody(request);
+    }
+
+    /**
+     * Dump the headers, attributes, and context path of the request.
+     *
+     * @param request the request to dump
+     */
+    private static void dumpRequestHeadersAttributesContextPath(HttpServletRequest request) {
+        logger.debug(request.getMethod() + ":" + request.getRemoteAddr() + " " + request.getRemoteHost() + " "
+                + request.getRemotePort());
         logger.debug(request.getLocalAddr() + " " + request.getLocalName() + " " + request.getLocalPort());
         Enumeration<String> en = request.getHeaderNames();
         logger.debug("Headers:");
@@ -190,9 +201,20 @@ public class XACMLRest {
             logger.debug(element + ":" + request.getAttribute(element));
         }
         logger.debug("ContextPath: " + request.getContextPath());
+    }
+
+
+    /**
+     * Dump the body of the request.
+     *
+     * @param request the request to act on
+     */
+    private static void dumpRequestBody(HttpServletRequest request) {
         if ("PUT".equals(request.getMethod()) || "POST".equals(request.getMethod())) {
-            // POST and PUT are allowed to have parameters in the content, but in our usage the parameters are always in the Query string.
-            // More importantly, there are cases where the POST and PUT content is NOT parameters (e.g. it might contain a Policy file).
+            // POST and PUT are allowed to have parameters in the content, but in our usage the parameters are always in
+            // the Query string.
+            // More importantly, there are cases where the POST and PUT content is NOT parameters (e.g. it might contain
+            // a Policy file).
             // Unfortunately the request.getParameterMap method reads the content to see if there are any parameters,
             // and once the content is read it cannot be read again.
             // Thus for PUT and POST we must avoid reading the content here so that the main code can read it.
@@ -204,7 +226,7 @@ public class XACMLRest {
                     logger.debug("Content available: " + request.getInputStream().available());
                 }
             } catch (Exception e) {
-                logger.debug("Content: inputStream exception: " + e.getMessage() + ";  (May not be relevant)" +e);
+                logger.debug("Content: inputStream exception: " + e.getMessage() + ";  (May not be relevant)" + e);
             }
         } else {
             logger.debug("Parameters:");