More DR unit tests and code cleanup
[dmaap/datarouter.git] / datarouter-node / src / main / java / org / onap / dmaap / datarouter / node / ProvData.java
index 77c5e99..03e952c 100644 (file)
 
 package org.onap.dmaap.datarouter.node;
 
-import java.io.*;
-import java.util.*;
-
-import org.json.*;
-import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
-import org.apache.log4j.Logger;
-
 import com.att.eelf.configuration.EELFLogger;
 import com.att.eelf.configuration.EELFManager;
+import java.io.IOException;
+import java.io.Reader;
+import java.util.ArrayList;
+import org.jetbrains.annotations.Nullable;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeed;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeedSubnet;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeedUser;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvForceEgress;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvForceIngress;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvHop;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvNode;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvParam;
+import org.onap.dmaap.datarouter.node.NodeConfig.ProvSubscription;
+import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;
 
 /**
  * Parser for provisioning data from the provisioning server.
- * <p>
- * The ProvData class uses a Reader for the text configuration from the
- * provisioning server to construct arrays of raw configuration entries.
+ *
+ * <p>The ProvData class uses a Reader for the text configuration from the provisioning server to construct arrays of
+ * raw configuration entries.
  */
 public class ProvData {
-    private static EELFLogger eelflogger = EELFManager.getInstance().getLogger(ProvData.class);
-    private static Logger logger = Logger.getLogger("org.onap.dmaap.datarouter.node.ProvData");
+
+    private static final String FEED_ID = "feedid";
+    private static EELFLogger eelfLogger = EELFManager.getInstance().getLogger(ProvData.class);
     private NodeConfig.ProvNode[] pn;
     private NodeConfig.ProvParam[] pp;
     private NodeConfig.ProvFeed[] pf;
@@ -53,197 +65,39 @@ public class ProvData {
     private NodeConfig.ProvForceEgress[] pfe;
     private NodeConfig.ProvHop[] ph;
 
-    private static String[] gvasa(JSONArray a, int index) {
-        return (gvasa(a.get(index)));
-    }
-
-    private static String[] gvasa(JSONObject o, String key) {
-        return (gvasa(o.opt(key)));
-    }
-
-    private static String[] gvasa(Object o) {
-        if (o instanceof JSONArray) {
-            JSONArray a = (JSONArray) o;
-            Vector<String> v = new Vector<String>();
-            for (int i = 0; i < a.length(); i++) {
-                String s = gvas(a, i);
-                if (s != null) {
-                    v.add(s);
-                }
-            }
-            return (v.toArray(new String[v.size()]));
-        } else {
-            String s = gvas(o);
-            if (s == null) {
-                return (new String[0]);
-            } else {
-                return (new String[]{s});
-            }
-        }
-    }
-
-    private static String gvas(JSONArray a, int index) {
-        return (gvas(a.get(index)));
-    }
-
-    private static String gvas(JSONObject o, String key) {
-        return (gvas(o.opt(key)));
-    }
-
-    private static String gvas(Object o) {
-        if (o instanceof Boolean || o instanceof Number || o instanceof String) {
-            return (o.toString());
-        }
-        return (null);
-    }
-
     /**
-     * Construct raw provisioing data entries from the text (JSON)
-     * provisioning document received from the provisioning server
+     * Construct raw provisioing data entries from the text (JSON) provisioning document received from the provisioning
+     * server.
      *
-     * @param r The reader for the JSON text.
+     * @param reader The reader for the JSON text.
      */
-    public ProvData(Reader r) throws IOException {
-        Vector<NodeConfig.ProvNode> pnv = new Vector<NodeConfig.ProvNode>();
-        Vector<NodeConfig.ProvParam> ppv = new Vector<NodeConfig.ProvParam>();
-        Vector<NodeConfig.ProvFeed> pfv = new Vector<NodeConfig.ProvFeed>();
-        Vector<NodeConfig.ProvFeedUser> pfuv = new Vector<NodeConfig.ProvFeedUser>();
-        Vector<NodeConfig.ProvFeedSubnet> pfsnv = new Vector<NodeConfig.ProvFeedSubnet>();
-        Vector<NodeConfig.ProvSubscription> psv = new Vector<NodeConfig.ProvSubscription>();
-        Vector<NodeConfig.ProvForceIngress> pfiv = new Vector<NodeConfig.ProvForceIngress>();
-        Vector<NodeConfig.ProvForceEgress> pfev = new Vector<NodeConfig.ProvForceEgress>();
-        Vector<NodeConfig.ProvHop> phv = new Vector<NodeConfig.ProvHop>();
+    public ProvData(Reader reader) throws IOException {
+        ArrayList<ProvNode> pnv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvParam> ppv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvFeed> pfv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvFeedUser> pfuv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvFeedSubnet> pfsnv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvSubscription> psv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvForceIngress> pfiv = new ArrayList<>();
+        ArrayList<NodeConfig.ProvForceEgress> pfev = new ArrayList<>();
+        ArrayList<NodeConfig.ProvHop> phv = new ArrayList<>();
         try {
-            JSONTokener jtx = new JSONTokener(r);
+            JSONTokener jtx = new JSONTokener(reader);
             JSONObject jcfg = new JSONObject(jtx);
             char c = jtx.nextClean();
             if (c != '\0') {
                 throw new JSONException("Spurious characters following configuration");
             }
-            r.close();
-            JSONArray jfeeds = jcfg.optJSONArray("feeds");
-            if (jfeeds != null) {
-                for (int fx = 0; fx < jfeeds.length(); fx++) {
-                    JSONObject jfeed = jfeeds.getJSONObject(fx);
-                    String stat = null;
-                    if (jfeed.optBoolean("suspend", false)) {
-                        stat = "Feed is suspended";
-                    }
-                    if (jfeed.optBoolean("deleted", false)) {
-                        stat = "Feed is deleted";
-                    }
-                    String fid = gvas(jfeed, "feedid");
-                    String fname = gvas(jfeed, "name");
-                    String fver = gvas(jfeed, "version");
-                    pfv.add(new NodeConfig.ProvFeed(fid, fname + "//" + fver, stat));
-                    JSONObject jauth = jfeed.optJSONObject("authorization");
-                    if (jauth == null) {
-                        continue;
-                    }
-                    JSONArray jeids = jauth.optJSONArray("endpoint_ids");
-                    if (jeids != null) {
-                        for (int ux = 0; ux < jeids.length(); ux++) {
-                            JSONObject ju = jeids.getJSONObject(ux);
-                            String login = gvas(ju, "id");
-                            String password = gvas(ju, "password");
-                            pfuv.add(new NodeConfig.ProvFeedUser(fid, login, NodeUtils.getAuthHdr(login, password)));
-                        }
-                    }
-                    JSONArray jeips = jauth.optJSONArray("endpoint_addrs");
-                    if (jeips != null) {
-                        for (int ix = 0; ix < jeips.length(); ix++) {
-                            String sn = gvas(jeips, ix);
-                            pfsnv.add(new NodeConfig.ProvFeedSubnet(fid, sn));
-                        }
-                    }
-                }
-            }
-            JSONArray jsubs = jcfg.optJSONArray("subscriptions");
-            if (jsubs != null) {
-                for (int sx = 0; sx < jsubs.length(); sx++) {
-                    JSONObject jsub = jsubs.getJSONObject(sx);
-                    if (jsub.optBoolean("suspend", false)) {
-                        continue;
-                    }
-                    String sid = gvas(jsub, "subid");
-                    String fid = gvas(jsub, "feedid");
-                    JSONObject jdel = jsub.getJSONObject("delivery");
-                    String delurl = gvas(jdel, "url");
-                    String id = gvas(jdel, "user");
-                    String password = gvas(jdel, "password");
-                    boolean monly = jsub.getBoolean("metadataOnly");
-                    boolean use100 = jdel.getBoolean("use100");
-                    boolean privilegedSubscriber = jsub.getBoolean("privilegedSubscriber");
-                    boolean decompress = jsub.getBoolean("decompress");
-                    psv.add(new NodeConfig.ProvSubscription(sid, fid, delurl, id, NodeUtils.getAuthHdr(id, password), monly, use100, privilegedSubscriber, decompress));
-                }
-            }
-            JSONObject jparams = jcfg.optJSONObject("parameters");
-            if (jparams != null) {
-                for (String pname : JSONObject.getNames(jparams)) {
-                    String pvalue = gvas(jparams, pname);
-                    if (pvalue != null) {
-                        ppv.add(new NodeConfig.ProvParam(pname, pvalue));
-                    }
-                }
-                String sfx = gvas(jparams, "PROV_DOMAIN");
-                JSONArray jnodes = jparams.optJSONArray("NODES");
-                if (jnodes != null) {
-                    for (int nx = 0; nx < jnodes.length(); nx++) {
-                        String nn = gvas(jnodes, nx);
-                        if (nn.indexOf('.') == -1) {
-                            nn = nn + "." + sfx;
-                        }
-                        pnv.add(new NodeConfig.ProvNode(nn));
-                    }
-                }
-            }
-            JSONArray jingresses = jcfg.optJSONArray("ingress");
-            if (jingresses != null) {
-                for (int fx = 0; fx < jingresses.length(); fx++) {
-                    JSONObject jingress = jingresses.getJSONObject(fx);
-                    String fid = gvas(jingress, "feedid");
-                    String subnet = gvas(jingress, "subnet");
-                    String user = gvas(jingress, "user");
-                    String[] nodes = gvasa(jingress, "node");
-                    if (fid == null || "".equals(fid)) {
-                        continue;
-                    }
-                    if ("".equals(subnet)) {
-                        subnet = null;
-                    }
-                    if ("".equals(user)) {
-                        user = null;
-                    }
-                    pfiv.add(new NodeConfig.ProvForceIngress(fid, subnet, user, nodes));
-                }
-            }
-            JSONObject jegresses = jcfg.optJSONObject("egress");
-            if (jegresses != null && JSONObject.getNames(jegresses) != null) {
-                for (String esid : JSONObject.getNames(jegresses)) {
-                    String enode = gvas(jegresses, esid);
-                    if (esid != null && enode != null && !"".equals(esid) && !"".equals(enode)) {
-                        pfev.add(new NodeConfig.ProvForceEgress(esid, enode));
-                    }
-                }
-            }
-            JSONArray jhops = jcfg.optJSONArray("routing");
-            if (jhops != null) {
-                for (int fx = 0; fx < jhops.length(); fx++) {
-                    JSONObject jhop = jhops.getJSONObject(fx);
-                    String from = gvas(jhop, "from");
-                    String to = gvas(jhop, "to");
-                    String via = gvas(jhop, "via");
-                    if (from == null || to == null || via == null || "".equals(from) || "".equals(to) || "".equals(via)) {
-                        continue;
-                    }
-                    phv.add(new NodeConfig.ProvHop(from, to, via));
-                }
-            }
+            reader.close();
+            addJSONFeeds(pfv, pfuv, pfsnv, jcfg);
+            addJSONSubs(psv, jcfg);
+            addJSONParams(pnv, ppv, jcfg);
+            addJSONRoutingInformation(pfiv, pfev, phv, jcfg);
         } catch (JSONException jse) {
             NodeUtils.setIpAndFqdnForEelf("ProvData");
-            eelflogger.error(EelfMsgs.MESSAGE_PARSING_ERROR, jse.toString());
-            logger.error("NODE0201 Error parsing configuration data from provisioning server " + jse.toString(), jse);
+            eelfLogger.error(EelfMsgs.MESSAGE_PARSING_ERROR, jse.toString());
+            eelfLogger
+                    .error("NODE0201 Error parsing configuration data from provisioning server " + jse.toString(), jse);
             throw new IOException(jse.toString(), jse);
         }
         pn = pnv.toArray(new NodeConfig.ProvNode[pnv.size()]);
@@ -257,66 +111,294 @@ public class ProvData {
         ph = phv.toArray(new NodeConfig.ProvHop[phv.size()]);
     }
 
+    private static String[] gvasa(JSONObject object, String key) {
+        return (gvasa(object.opt(key)));
+    }
+
+    private static String[] gvasa(Object object) {
+        if (object instanceof JSONArray) {
+            JSONArray jsonArray = (JSONArray) object;
+            ArrayList<String> array = new ArrayList<>();
+            for (int i = 0; i < jsonArray.length(); i++) {
+                String string = gvas(jsonArray, i);
+                if (string != null) {
+                    array.add(string);
+                }
+            }
+            return (array.toArray(new String[array.size()]));
+        } else {
+            String string = gvas(object);
+            if (string == null) {
+                return (new String[0]);
+            } else {
+                return (new String[]{string});
+            }
+        }
+    }
+
+    private static String gvas(JSONArray array, int index) {
+        return (gvas(array.get(index)));
+    }
+
+    private static String gvas(JSONObject object, String key) {
+        return (gvas(object.opt(key)));
+    }
+
+    private static String gvas(Object object) {
+        if (object instanceof Boolean || object instanceof Number || object instanceof String) {
+            return (object.toString());
+        }
+        return (null);
+    }
+
     /**
-     * Get the raw node configuration entries
+     * Get the raw node configuration entries.
      */
     public NodeConfig.ProvNode[] getNodes() {
         return (pn);
     }
 
     /**
-     * Get the raw parameter configuration entries
+     * Get the raw parameter configuration entries.
      */
     public NodeConfig.ProvParam[] getParams() {
         return (pp);
     }
 
     /**
-     * Ge the raw feed configuration entries
+     * Ge the raw feed configuration entries.
      */
     public NodeConfig.ProvFeed[] getFeeds() {
         return (pf);
     }
 
     /**
-     * Get the raw feed user configuration entries
+     * Get the raw feed user configuration entries.
      */
     public NodeConfig.ProvFeedUser[] getFeedUsers() {
         return (pfu);
     }
 
     /**
-     * Get the raw feed subnet configuration entries
+     * Get the raw feed subnet configuration entries.
      */
     public NodeConfig.ProvFeedSubnet[] getFeedSubnets() {
         return (pfsn);
     }
 
     /**
-     * Get the raw subscription entries
+     * Get the raw subscription entries.
      */
     public NodeConfig.ProvSubscription[] getSubscriptions() {
         return (ps);
     }
 
     /**
-     * Get the raw forced ingress entries
+     * Get the raw forced ingress entries.
      */
     public NodeConfig.ProvForceIngress[] getForceIngress() {
         return (pfi);
     }
 
     /**
-     * Get the raw forced egress entries
+     * Get the raw forced egress entries.
      */
     public NodeConfig.ProvForceEgress[] getForceEgress() {
         return (pfe);
     }
 
     /**
-     * Get the raw next hop entries
+     * Get the raw next hop entries.
      */
     public NodeConfig.ProvHop[] getHops() {
         return (ph);
     }
+
+    @Nullable
+    private String getFeedStatus(JSONObject jfeed) {
+        String stat = null;
+        if (jfeed.optBoolean("suspend", false)) {
+            stat = "Feed is suspended";
+        }
+        if (jfeed.optBoolean("deleted", false)) {
+            stat = "Feed is deleted";
+        }
+        return stat;
+    }
+
+    private void addJSONFeeds(ArrayList<ProvFeed> pfv, ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv,
+            JSONObject jcfg) {
+        JSONArray jfeeds = jcfg.optJSONArray("feeds");
+        if (jfeeds != null) {
+            for (int fx = 0; fx < jfeeds.length(); fx++) {
+                addJSONFeed(pfv, pfuv, pfsnv, jfeeds, fx);
+            }
+        }
+    }
+
+    private void addJSONFeed(ArrayList<ProvFeed> pfv, ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv,
+            JSONArray jfeeds, int fx) {
+        JSONObject jfeed = jfeeds.getJSONObject(fx);
+        String stat = getFeedStatus(jfeed);
+        String fid = gvas(jfeed, FEED_ID);
+        String fname = gvas(jfeed, "name");
+        String fver = gvas(jfeed, "version");
+        String createdDate = gvas(jfeed, "created_date");
+        /*
+         * START - AAF changes
+         * TDP EPIC US# 307413
+         * Passing aafInstance to ProvFeed from feeds json passed by prov to identify legacy/AAF feeds
+         */
+        String aafInstance = gvas(jfeed, "aaf_instance");
+        pfv.add(new ProvFeed(fid, fname + "//" + fver, stat, createdDate, aafInstance));
+        /*
+         * END - AAF changes
+         */
+        addJSONFeedAuthArrays(pfuv, pfsnv, jfeed, fid);
+    }
+
+    private void addJSONFeedAuthArrays(ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv, JSONObject jfeed,
+            String fid) {
+        JSONObject jauth = jfeed.optJSONObject("authorization");
+        if (jauth == null) {
+            return;
+        }
+        JSONArray jeids = jauth.optJSONArray("endpoint_ids");
+        if (jeids != null) {
+            for (int ux = 0; ux < jeids.length(); ux++) {
+                JSONObject ju = jeids.getJSONObject(ux);
+                String login = gvas(ju, "id");
+                String password = gvas(ju, "password");
+                pfuv.add(new ProvFeedUser(fid, login, NodeUtils.getAuthHdr(login, password)));
+            }
+        }
+        JSONArray jeips = jauth.optJSONArray("endpoint_addrs");
+        if (jeips != null) {
+            for (int ix = 0; ix < jeips.length(); ix++) {
+                String sn = gvas(jeips, ix);
+                pfsnv.add(new ProvFeedSubnet(fid, sn));
+            }
+        }
+    }
+
+    private void addJSONSubs(ArrayList<ProvSubscription> psv, JSONObject jcfg) {
+        JSONArray jsubs = jcfg.optJSONArray("subscriptions");
+        if (jsubs != null) {
+            for (int sx = 0; sx < jsubs.length(); sx++) {
+                addJSONSub(psv, jsubs, sx);
+            }
+        }
+    }
+
+    private void addJSONSub(ArrayList<ProvSubscription> psv, JSONArray jsubs, int sx) {
+        JSONObject jsub = jsubs.getJSONObject(sx);
+        if (jsub.optBoolean("suspend", false)) {
+            return;
+        }
+        String sid = gvas(jsub, "subid");
+        String fid = gvas(jsub, FEED_ID);
+        JSONObject jdel = jsub.getJSONObject("delivery");
+        String delurl = gvas(jdel, "url");
+        String id = gvas(jdel, "user");
+        String password = gvas(jdel, "password");
+        boolean monly = jsub.getBoolean("metadataOnly");
+        boolean use100 = jdel.getBoolean("use100");
+        boolean privilegedSubscriber = jsub.getBoolean("privilegedSubscriber");
+        boolean decompress = jsub.getBoolean("decompress");
+        boolean followRedirect = jsub.getBoolean("follow_redirect");
+        psv.add(new ProvSubscription(sid, fid, delurl, id, NodeUtils.getAuthHdr(id, password), monly, use100,
+                privilegedSubscriber, followRedirect, decompress));
+    }
+
+    private void addJSONParams(ArrayList<ProvNode> pnv, ArrayList<ProvParam> ppv, JSONObject jcfg) {
+        JSONObject jparams = jcfg.optJSONObject("parameters");
+        if (jparams != null) {
+            for (String pname : JSONObject.getNames(jparams)) {
+                addJSONParam(ppv, jparams, pname);
+            }
+            addJSONNodesToParams(pnv, jparams);
+        }
+    }
+
+    private void addJSONParam(ArrayList<ProvParam> ppv, JSONObject jparams, String pname) {
+        String pvalue = gvas(jparams, pname);
+        if (pvalue != null) {
+            ppv.add(new ProvParam(pname, pvalue));
+        }
+    }
+
+    private void addJSONNodesToParams(ArrayList<ProvNode> pnv, JSONObject jparams) {
+        String sfx = gvas(jparams, "PROV_DOMAIN");
+        JSONArray jnodes = jparams.optJSONArray("NODES");
+        if (jnodes != null) {
+            for (int nx = 0; nx < jnodes.length(); nx++) {
+                String nn = gvas(jnodes, nx);
+                if (nn == null) {
+                    continue;
+                }
+                if (nn.indexOf('.') == -1) {
+                    nn = nn + "." + sfx;
+                }
+                pnv.add(new ProvNode(nn));
+            }
+        }
+    }
+
+    private void addJSONRoutingInformation(ArrayList<ProvForceIngress> pfiv, ArrayList<ProvForceEgress> pfev,
+            ArrayList<ProvHop> phv, JSONObject jcfg) {
+        JSONArray jingresses = jcfg.optJSONArray("ingress");
+        if (jingresses != null) {
+            for (int fx = 0; fx < jingresses.length(); fx++) {
+                addJSONIngressRoute(pfiv, jingresses, fx);
+            }
+        }
+        JSONObject jegresses = jcfg.optJSONObject("egress");
+        if (jegresses != null && JSONObject.getNames(jegresses) != null) {
+            for (String esid : JSONObject.getNames(jegresses)) {
+                addJSONEgressRoute(pfev, jegresses, esid);
+            }
+        }
+        JSONArray jhops = jcfg.optJSONArray("routing");
+        if (jhops != null) {
+            for (int fx = 0; fx < jhops.length(); fx++) {
+                addJSONRoutes(phv, jhops, fx);
+            }
+        }
+    }
+
+    private void addJSONIngressRoute(ArrayList<ProvForceIngress> pfiv, JSONArray jingresses, int fx) {
+        JSONObject jingress = jingresses.getJSONObject(fx);
+        String fid = gvas(jingress, FEED_ID);
+        String subnet = gvas(jingress, "subnet");
+        String user = gvas(jingress, "user");
+        if (fid == null || "".equals(fid)) {
+            return;
+        }
+        if ("".equals(subnet)) {
+            subnet = null;
+        }
+        if ("".equals(user)) {
+            user = null;
+        }
+        String[] nodes = gvasa(jingress, "node");
+        pfiv.add(new ProvForceIngress(fid, subnet, user, nodes));
+    }
+
+    private void addJSONEgressRoute(ArrayList<ProvForceEgress> pfev, JSONObject jegresses, String esid) {
+        String enode = gvas(jegresses, esid);
+        if (esid != null && enode != null && !"".equals(esid) && !"".equals(enode)) {
+            pfev.add(new ProvForceEgress(esid, enode));
+        }
+    }
+
+    private void addJSONRoutes(ArrayList<ProvHop> phv, JSONArray jhops, int fx) {
+        JSONObject jhop = jhops.getJSONObject(fx);
+        String from = gvas(jhop, "from");
+        String to = gvas(jhop, "to");
+        String via = gvas(jhop, "via");
+        if (from == null || to == null || via == null || "".equals(from) || "".equals(to) || "".equals(via)) {
+            return;
+        }
+        phv.add(new ProvHop(from, to, via));
+    }
 }