Code Review / dmaap / datarouter.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Refactor Prov DB handling
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / provisioning / SubscriptionServlet.java
diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscriptionServlet.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscriptionServlet.java
index 63ff84d..1f7c291 100644 (file)
--- a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscriptionServlet.java
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscriptionServlet.java
@@ -24,28 +24,26 @@
 \r
 package org.onap.dmaap.datarouter.provisioning;\r
 \r
+import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;\r
+\r
+import com.att.eelf.configuration.EELFLogger;\r
+import com.att.eelf.configuration.EELFManager;\r
 import java.io.IOException;\r
 import java.io.InvalidObjectException;\r
 import java.net.HttpURLConnection;\r
 import java.net.URL;\r
+import java.util.ArrayList;\r
 import java.util.List;\r
-import java.util.Vector;\r
-\r
 import javax.servlet.http.HttpServletRequest;\r
 import javax.servlet.http.HttpServletResponse;\r
-\r
 import org.json.JSONException;\r
 import org.json.JSONObject;\r
 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;\r
+import org.onap.dmaap.datarouter.provisioning.utils.SynchronizerTask;\r
 import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;\r
 import org.onap.dmaap.datarouter.provisioning.beans.Subscription;\r
 import org.onap.dmaap.datarouter.provisioning.eelf.EelfMsgs;\r
 \r
-import com.att.eelf.configuration.EELFLogger;\r
-import com.att.eelf.configuration.EELFManager;\r
-\r
-import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;\r
-\r
 /**\r
  * This servlet handles provisioning for the <subscriptionURL> which is generated by the provisioning server to\r
  * handle the inspection, modification, and deletion of a particular subscription to a feed. It supports DELETE to\r
@@ -63,6 +61,10 @@ public class SubscriptionServlet extends ProxyServlet {
     private static EELFLogger eelfLogger = EELFManager.getInstance()\r
         .getLogger(SubscriptionServlet.class);\r
 \r
+\r
+\r
+\r
+\r
     /**\r
      * DELETE on the &lt;subscriptionUrl&gt; -- delete a subscription. See the <i>Deleting a Subscription</i> section in\r
      * the <b>Provisioning API</b> document for details on how this method should be invoked.\r
@@ -72,7 +74,8 @@ public class SubscriptionServlet extends ProxyServlet {
         setIpFqdnRequestIDandInvocationIDForEelf("doDelete", req);\r
         eelfLogger.info(EelfMsgs.ENTRY);\r
         try {\r
-            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
+            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,\r
+                    req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
             EventLogRecord elr = new EventLogRecord(req);\r
             String message = isAuthorizedForProvisioning(req);\r
             if (message != null) {\r
@@ -88,7 +91,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             String bhdr = req.getHeader(BEHALF_HEADER);\r
             if (bhdr == null) {\r
-                message = "Missing " + BEHALF_HEADER + " header.";\r
+                message = MISSING_ON_BEHALF;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -97,7 +100,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             int subid = getIdFromPath(req);\r
             if (subid < 0) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -106,7 +109,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             Subscription sub = Subscription.getSubscriptionById(subid);\r
             if (sub == null) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
                 eventlogger.error(elr.toString());\r
@@ -119,10 +122,10 @@ public class SubscriptionServlet extends ProxyServlet {
              * CADI code - check on permissions based on Legacy/AAF users to allow to delete/remove subscription\r
              */\r
             String aafInstance = sub.getAafInstance();\r
-            if (aafInstance == null || aafInstance.equals("") || aafInstance.equalsIgnoreCase("legacy")) {\r
+            if (aafInstance == null || "".equals(aafInstance) || "legacy".equalsIgnoreCase(aafInstance)) {\r
                 AuthorizationResponse aresp = authz.decide(req);\r
                 if (!aresp.isAuthorized()) {\r
-                    message = "Policy Engine disallows access.";\r
+                    message = POLICY_ENGINE;\r
                     elr.setMessage(message);\r
                     elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
                     eventlogger.error(elr.toString());\r
@@ -173,7 +176,8 @@ public class SubscriptionServlet extends ProxyServlet {
         setIpFqdnRequestIDandInvocationIDForEelf("doGet", req);\r
         eelfLogger.info(EelfMsgs.ENTRY);\r
         try {\r
-            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
+            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,\r
+                    req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
             EventLogRecord elr = new EventLogRecord(req);\r
             String message = isAuthorizedForProvisioning(req);\r
             if (message != null) {\r
@@ -189,7 +193,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             String bhdr = req.getHeader(BEHALF_HEADER);\r
             if (bhdr == null) {\r
-                message = "Missing " + BEHALF_HEADER + " header.";\r
+                message = MISSING_ON_BEHALF;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -198,7 +202,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             int subid = getIdFromPath(req);\r
             if (subid < 0) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -207,7 +211,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             Subscription sub = Subscription.getSubscriptionById(subid);\r
             if (sub == null) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
                 eventlogger.error(elr.toString());\r
@@ -217,7 +221,7 @@ public class SubscriptionServlet extends ProxyServlet {
             // Check with the Authorizer\r
             AuthorizationResponse aresp = authz.decide(req);\r
             if (!aresp.isAuthorized()) {\r
-                message = "Policy Engine disallows access.";\r
+                message = POLICY_ENGINE;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
                 eventlogger.error(elr.toString());\r
@@ -233,7 +237,7 @@ public class SubscriptionServlet extends ProxyServlet {
             try {\r
                 resp.getOutputStream().print(sub.asJSONObject(true).toString());\r
             } catch (IOException ioe) {\r
-                eventlogger.error("IOException: " + ioe.getMessage());\r
+                eventlogger.error("PROV0191 SubscriptionServlet.doGet: " + ioe.getMessage(), ioe);\r
             }\r
         } finally {\r
             eelfLogger.info(EelfMsgs.EXIT);\r
@@ -249,7 +253,8 @@ public class SubscriptionServlet extends ProxyServlet {
         setIpFqdnRequestIDandInvocationIDForEelf("doPut", req);\r
         eelfLogger.info(EelfMsgs.ENTRY);\r
         try {\r
-            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
+            eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,\r
+                    req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
             EventLogRecord elr = new EventLogRecord(req);\r
             String message = isAuthorizedForProvisioning(req);\r
             if (message != null) {\r
@@ -265,7 +270,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             String bhdr = req.getHeader(BEHALF_HEADER);\r
             if (bhdr == null) {\r
-                message = "Missing " + BEHALF_HEADER + " header.";\r
+                message = MISSING_ON_BEHALF;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -274,7 +279,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             int subid = getIdFromPath(req);\r
             if (subid < 0) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -283,7 +288,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             Subscription oldsub = Subscription.getSubscriptionById(subid);\r
             if (oldsub == null) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
                 eventlogger.error(elr.toString());\r
@@ -293,7 +298,7 @@ public class SubscriptionServlet extends ProxyServlet {
             // check content type is SUB_CONTENT_TYPE, version 1.0\r
             ContentHeader ch = getContentHeader(req);\r
             String ver = ch.getAttribute("version");\r
-            if (!ch.getType().equals(SUB_BASECONTENT_TYPE) || !(ver.equals("1.0") || ver.equals("2.0"))) {\r
+            if (!ch.getType().equals(SUB_BASECONTENT_TYPE) || !("1.0".equals(ver) || "2.0".equals(ver))) {\r
                 message = "Incorrect content-type";\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);\r
@@ -303,7 +308,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             JSONObject jo = getJSONfromInput(req);\r
             if (jo == null) {\r
-                message = "Badly formed JSON";\r
+                message = BAD_JSON;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -320,7 +325,7 @@ public class SubscriptionServlet extends ProxyServlet {
                 message = e.getMessage();\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
-                eventlogger.error(elr.toString());\r
+                eventlogger.error(elr.toString(), e);\r
                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);\r
                 return;\r
             }\r
@@ -331,10 +336,10 @@ public class SubscriptionServlet extends ProxyServlet {
              * CADI code - check on permissions based on Legacy/AAF users to allow to delete/remove subscription\r
              */\r
             String aafInstance = sub.getAafInstance();\r
-            if (aafInstance == null || aafInstance.equals("") || aafInstance.equalsIgnoreCase("legacy")) {\r
+            if (aafInstance == null || "".equals(aafInstance) || "legacy".equalsIgnoreCase(aafInstance)) {\r
                 AuthorizationResponse aresp = authz.decide(req);\r
                 if (!aresp.isAuthorized()) {\r
-                    message = "Policy Engine disallows access.";\r
+                    message = POLICY_ENGINE;\r
                     elr.setMessage(message);\r
                     elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
                     eventlogger.error(elr.toString());\r
@@ -359,8 +364,8 @@ public class SubscriptionServlet extends ProxyServlet {
             sub.setSubid(oldsub.getSubid());\r
             sub.setFeedid(oldsub.getFeedid());\r
             sub.setSubscriber(bhdr);    // set from X-DMAAP-DR-ON-BEHALF-OF header\r
-\r
-            String subjectgroup = (req.getHeader("X-DMAAP-DR-ON-BEHALF-OF-GROUP")); //Adding for group feature:Rally US708115\r
+            //Adding for group feature:Rally US708115\r
+            String subjectgroup = (req.getHeader("X-DMAAP-DR-ON-BEHALF-OF-GROUP"));\r
             if (!oldsub.getSubscriber().equals(sub.getSubscriber()) && subjectgroup == null) {\r
                 message = "This subscriber must be modified by the same subscriber that created it.";\r
                 elr.setMessage(message);\r
@@ -380,10 +385,10 @@ public class SubscriptionServlet extends ProxyServlet {
                 try {\r
                     resp.getOutputStream().print(sub.asLimitedJSONObject().toString());\r
                 } catch (IOException ioe) {\r
-                    eventlogger.error("IOException: " + ioe.getMessage());\r
+                    eventlogger.error("PROV0192 SubscriptionServlet.doPut: " + ioe.getMessage(), ioe);\r
                 }\r
 \r
-                /**Change Owner ship of Subscriber     Adding for group feature:Rally US708115*/\r
+                /**Change Owner ship of Subscriber.     Adding for group feature:Rally US708115*/\r
                 if (jo.has("changeowner") && subjectgroup != null) {\r
                     try {\r
                         Boolean changeowner = (Boolean) jo.get("changeowner");\r
@@ -392,10 +397,10 @@ public class SubscriptionServlet extends ProxyServlet {
                             sub.changeOwnerShip();\r
                         }\r
                     } catch (JSONException je) {\r
-                        eventlogger.error("JSONException: " + je.getMessage());\r
+                        eventlogger.error("PROV0193 SubscriptionServlet.doPut: " + je.getMessage(), je);\r
                     }\r
                 }\r
-                /***End of change ownership*/\r
+                /***End of change ownership.*/\r
 \r
                 provisioningDataChanged();\r
             } else {\r
@@ -435,7 +440,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             String bhdr = req.getHeader(BEHALF_HEADER);\r
             if (bhdr == null) {\r
-                message = "Missing " + BEHALF_HEADER + " header.";\r
+                message = MISSING_ON_BEHALF;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -444,7 +449,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             final int subid = getIdFromPath(req);\r
             if (subid < 0 || Subscription.getSubscriptionById(subid) == null) {\r
-                message = "Missing or bad subscription number.";\r
+                message = BAD_SUB;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -454,7 +459,7 @@ public class SubscriptionServlet extends ProxyServlet {
             // check content type is SUBCNTRL_CONTENT_TYPE, version 1.0\r
             ContentHeader ch = getContentHeader(req);\r
             String ver = ch.getAttribute("version");\r
-            if (!ch.getType().equals(SUBCNTRL_CONTENT_TYPE) || !ver.equals("1.0")) {\r
+            if (!ch.getType().equals(SUBCNTRL_CONTENT_TYPE) || !"1.0".equals(ver)) {\r
                 message = "Incorrect content-type";\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);\r
@@ -465,7 +470,7 @@ public class SubscriptionServlet extends ProxyServlet {
             // Check with the Authorizer\r
             AuthorizationResponse aresp = authz.decide(req);\r
             if (!aresp.isAuthorized()) {\r
-                message = "Policy Engine disallows access.";\r
+                message = POLICY_ENGINE;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
                 eventlogger.error(elr.toString());\r
@@ -474,7 +479,7 @@ public class SubscriptionServlet extends ProxyServlet {
             }\r
             JSONObject jo = getJSONfromInput(req);\r
             if (jo == null) {\r
-                message = "Badly formed JSON";\r
+                message = BAD_JSON;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
                 eventlogger.error(elr.toString());\r
@@ -484,22 +489,22 @@ public class SubscriptionServlet extends ProxyServlet {
             try {\r
                 // Only the active POD sends notifications\r
                 boolean active = SynchronizerTask.getSynchronizer().isActive();\r
-                boolean b = jo.getBoolean("failed");\r
-                if (active && !b) {\r
+                boolean bool = jo.getBoolean("failed");\r
+                if (active && !bool) {\r
                     // Notify all nodes to reset the subscription\r
-                    SubscriberNotifyThread t = new SubscriberNotifyThread();\r
-                    t.resetSubscription(subid);\r
-                    t.start();\r
+                    SubscriberNotifyThread thread = new SubscriberNotifyThread();\r
+                    thread.resetSubscription(subid);\r
+                    thread.start();\r
                 }\r
                 // send response\r
                 elr.setResult(HttpServletResponse.SC_ACCEPTED);\r
                 eventlogger.info(elr.toString());\r
                 resp.setStatus(HttpServletResponse.SC_ACCEPTED);\r
             } catch (JSONException e) {\r
-                message = "Badly formed JSON";\r
+                message = BAD_JSON;\r
                 elr.setMessage(message);\r
                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
-                eventlogger.error(elr.toString());\r
+                eventlogger.error(elr.toString(), e);\r
                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);\r
             }\r
         } finally {\r
@@ -511,38 +516,43 @@ public class SubscriptionServlet extends ProxyServlet {
      * A Thread class used to serially send reset notifications to all nodes in the DR network, when a POST is received\r
      * for a subscription.\r
      */\r
-    public class SubscriberNotifyThread extends Thread {\r
+    public static class SubscriberNotifyThread extends Thread {\r
 \r
-        public static final String URL_TEMPLATE = "http://%s/internal/resetSubscription/%d";\r
-        private List<String> urls = new Vector<String>();\r
+        static final String URL_TEMPLATE = "http://%s/internal/resetSubscription/%d";\r
+        private List<String> urls = new ArrayList<>();\r
 \r
-        public SubscriberNotifyThread() {\r
+        SubscriberNotifyThread() {\r
             setName("SubscriberNotifyThread");\r
         }\r
 \r
-        public void resetSubscription(int subid) {\r
+        void resetSubscription(int subid) {\r
             for (String nodename : BaseServlet.getNodes()) {\r
-                String u = String.format(URL_TEMPLATE, nodename, subid);\r
-                urls.add(u);\r
+                String url = String.format(URL_TEMPLATE, nodename, subid);\r
+                urls.add(url);\r
             }\r
         }\r
 \r
+        @Override\r
         public void run() {\r
             try {\r
                 while (!urls.isEmpty()) {\r
-                    String u = urls.remove(0);\r
-                    try {\r
-                        URL url = new URL(u);\r
-                        HttpURLConnection conn = (HttpURLConnection) url.openConnection();\r
-                        conn.connect();\r
-                        conn.getContentLength();    // Force the GET through\r
-                        conn.disconnect();\r
-                    } catch (IOException e) {\r
-                        intlogger.info("IOException Error accessing URL: " + u + ": " + e.getMessage());\r
-                    }\r
+                    String url = urls.remove(0);\r
+                    forceGetThrough(url);\r
                 }\r
             } catch (Exception e) {\r
-                intlogger.warn("Caught exception in SubscriberNotifyThread: " + e.getMessage());\r
+                intlogger.warn("PROV0195 Caught exception in SubscriberNotifyThread: " + e.getMessage(), e);\r
+            }\r
+        }\r
+\r
+        private void forceGetThrough(String url) {\r
+            try {\r
+                URL urlObj = new URL(url);\r
+                HttpURLConnection conn = (HttpURLConnection) urlObj.openConnection();\r
+                conn.connect();\r
+                conn.getContentLength();    // Force the GET through\r
+                conn.disconnect();\r
+            } catch (IOException e) {\r
+                intlogger.info("PROV0194 Error accessing URL: " + url + ": " + e.getMessage(), e);\r
             }\r
         }\r
     }\r
The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require. The interface to DR is exposed as a RESTful web service known as the DR Publishing and Delivery API