datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/utils/Poker.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * *\r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * *\r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 \r
  24 package org.onap.dmaap.datarouter.provisioning.utils;\r
  25 \r
  26 import com.att.eelf.configuration.EELFLogger;\r
  27 import com.att.eelf.configuration.EELFManager;\r
  28 import java.io.IOException;\r
  29 import java.net.HttpURLConnection;\r
  30 import java.net.InetAddress;\r
  31 import java.net.MalformedURLException;\r
  32 import java.net.URL;\r
  33 import java.net.UnknownHostException;\r
  34 import java.util.Arrays;\r
  35 import java.util.HashSet;\r
  36 import java.util.Map;\r
  37 import java.util.Set;\r
  38 import java.util.Timer;\r
  39 import java.util.TimerTask;\r
  40 import java.util.TreeSet;\r
  41 import org.json.JSONException;\r
  42 import org.json.JSONObject;\r
  43 import org.json.JSONTokener;\r
  44 \r
  45 import org.onap.dmaap.datarouter.provisioning.ProvRunner;\r
  46 import org.onap.dmaap.datarouter.provisioning.beans.EgressRoute;\r
  47 import org.onap.dmaap.datarouter.provisioning.beans.Feed;\r
  48 import org.onap.dmaap.datarouter.provisioning.beans.Group;\r
  49 import org.onap.dmaap.datarouter.provisioning.beans.IngressRoute;\r
  50 import org.onap.dmaap.datarouter.provisioning.beans.NetworkRoute;\r
  51 import org.onap.dmaap.datarouter.provisioning.beans.Parameters;\r
  52 import org.onap.dmaap.datarouter.provisioning.beans.Subscription;\r
  53 import org.onap.dmaap.datarouter.provisioning.BaseServlet;\r
  54 \r
  55 /**\r
  56  * This class handles the two timers (described in R1 Design Notes), and takes care of issuing the GET to each node of\r
  57  * the URL to "poke".\r
  58  *\r
  59  * @author Robert Eby\r
  60  * @version $Id: Poker.java,v 1.11 2014/01/08 16:13:47 eby Exp $\r
  61  */\r
  62 \r
  63 public class Poker extends TimerTask {\r
  64 \r
  65     /**\r
  66      * Template used to generate the URL to issue the GET against.\r
  67      */\r
  68     private static final String POKE_URL_TEMPLATE = "http://%s/internal/fetchProv";\r
  69 \r
  70     private static final Object lock = new Object();\r
  71     private static final String CARRIAGE_RETURN = "\n],\n";\r
  72 \r
  73     /**\r
  74      * This is a singleton -- there is only one Poker object in the server.\r
  75      */\r
  76     private static Poker poker;\r
  77     private long timer1;\r
  78     private long timer2;\r
  79     private String thisPod;        // DNS name of this machine\r
  80     private EELFLogger logger;\r
  81     private String provString;\r
  82 \r
  83 \r
  84     private Poker() {\r
  85         timer1 = timer2 = 0;\r
  86         logger = EELFManager.getInstance().getLogger("InternalLog");\r
  87         try {\r
  88             thisPod = InetAddress.getLocalHost().getHostName();\r
  89         } catch (UnknownHostException e) {\r
  90             thisPod = "*UNKNOWN_POD*"; // not a major problem\r
  91             logger.info("UnknownHostException: Setting thisPod to \"*UNKNOWN_POD*\"", e);\r
  92         }\r
  93         provString = buildProvisioningString();\r
  94         Timer rolex = new Timer();\r
  95         rolex.scheduleAtFixedRate(this, 0L, 1000L);    // Run once a second to check the timers\r
  96     }\r
  97 \r
  98     /**\r
  99      * Get the singleton Poker object.\r
 100      *\r
 101      * @return the Poker\r
 102      */\r
 103     public static synchronized Poker getPoker() {\r
 104         if (poker == null) {\r
 105             poker = new Poker();\r
 106         }\r
 107         return poker;\r
 108     }\r
 109 \r
 110     /**\r
 111      * This method sets the two timers described in the design notes.\r
 112      *\r
 113      * @param t1 the first timer controls how long to wait after a provisioning request before poking each node This\r
 114      * timer can be reset if it has not "gone off".\r
 115      * @param t2 the second timer set the outer bound on how long to wait.  It cannot be reset.\r
 116      */\r
 117     public void setTimers(long t1, long t2) {\r
 118         synchronized (lock) {\r
 119             if (timer1 == 0 || t1 > timer1) {\r
 120                 timer1 = t1;\r
 121             }\r
 122             if (timer2 == 0) {\r
 123                 timer2 = t2;\r
 124             }\r
 125         }\r
 126         if (logger.isDebugEnabled()) {\r
 127             logger.debug("Poker timers set to " + timer1 + " and " + timer2);\r
 128         }\r
 129 \r
 130 \r
 131     }\r
 132 \r
 133     /**\r
 134      * Return the last provisioning string built.\r
 135      *\r
 136      * @return the last provisioning string built.\r
 137      */\r
 138     public String getProvisioningString() {\r
 139         return provString;\r
 140     }\r
 141 \r
 142     /**\r
 143      * The method to run at the predefined interval (once per second).  This method checks to see if either of the two\r
 144      * timers has expired, and if so, will rebuild the provisioning string, and poke all the nodes and other PODs.  The\r
 145      * timers are then reset to 0.\r
 146      */\r
 147     @Override\r
 148     public void run() {\r
 149         try {\r
 150             if (timer1 > 0) {\r
 151                 long now = System.currentTimeMillis();\r
 152                 boolean fire = false;\r
 153                 synchronized (lock) {\r
 154                     if (now > timer1 || now > timer2) {\r
 155                         timer1 = timer2 = 0;\r
 156                         fire = true;\r
 157                     }\r
 158                 }\r
 159                 if (fire) {\r
 160                     pokeNodes();\r
 161                 }\r
 162             }\r
 163         } catch (Exception e) {\r
 164             logger.warn("PROV0020: Caught exception in Poker: " + e);\r
 165         }\r
 166     }\r
 167 \r
 168     private void pokeNodes() {\r
 169         // Rebuild the prov string\r
 170         provString = buildProvisioningString();\r
 171         // Only the active POD should poke nodes, etc.\r
 172         boolean active = SynchronizerTask.getSynchronizer().isActive();\r
 173         if (active) {\r
 174             // Poke all the DR nodes\r
 175             for (String n : BaseServlet.getNodes()) {\r
 176                 pokeNode(n);\r
 177             }\r
 178             // Poke the pod that is not us\r
 179             for (String n : BaseServlet.getPods()) {\r
 180                 if (n.length() > 0 && !n.equals(thisPod)) {\r
 181                     pokeNode(n);\r
 182                 }\r
 183             }\r
 184         }\r
 185     }\r
 186 \r
 187     private void pokeNode(final String nodename) {\r
 188         logger.debug("PROV0012 Poking node " + nodename + " ...");\r
 189         String nodeUrl = String.format(POKE_URL_TEMPLATE, nodename + ":" + ProvRunner.getProvProperties().get(\r
 190             "org.onap.dmaap.datarouter.provserver.http.port"), "8080");\r
 191         Runnable runn = () -> {\r
 192             try {\r
 193                 URL url = new URL(nodeUrl);\r
 194                 HttpURLConnection conn = (HttpURLConnection) url.openConnection();\r
 195                 conn.setConnectTimeout(60000);    //Fixes for Itrack DATARTR-3, poke timeout\r
 196                 conn.connect();\r
 197                 conn.getContentLength();    // Force the GET through\r
 198                 conn.disconnect();\r
 199             } catch (MalformedURLException e) {\r
 200                 logger.warn(\r
 201                         "PROV0013 MalformedURLException Error poking node at " + nodeUrl + " : " + e\r
 202                                 .getMessage(), e);\r
 203             } catch (IOException e) {\r
 204                 logger.warn("PROV0013 IOException Error poking node at " + nodeUrl + " : " + e\r
 205                         .getMessage(), e);\r
 206             }\r
 207         };\r
 208         runn.run();\r
 209     }\r
 210 \r
 211     private String buildProvisioningString() {\r
 212         StringBuilder sb = new StringBuilder("{\n");\r
 213 \r
 214         // Append Feeds to the string\r
 215         String pfx = "\n";\r
 216         sb.append("\"feeds\": [");\r
 217         for (Feed f : Feed.getAllFeeds()) {\r
 218             sb.append(pfx);\r
 219             sb.append(f.asJSONObject().toString());\r
 220             pfx = ",\n";\r
 221         }\r
 222         sb.append(CARRIAGE_RETURN);\r
 223 \r
 224         //Append groups to the string - Rally:US708115  - 1610\r
 225         pfx = "\n";\r
 226         sb.append("\"groups\": [");\r
 227         for (Group s : Group.getAllgroups()) {\r
 228             sb.append(pfx);\r
 229             sb.append(s.asJSONObject().toString());\r
 230             pfx = ",\n";\r
 231         }\r
 232         sb.append(CARRIAGE_RETURN);\r
 233 \r
 234         // Append Subscriptions to the string\r
 235         pfx = "\n";\r
 236         sb.append("\"subscriptions\": [");\r
 237         for (Subscription s : Subscription.getAllSubscriptions()) {\r
 238             sb.append(pfx);\r
 239             if (s != null) {\r
 240                 sb.append(s.asJSONObject().toString());\r
 241             }\r
 242             pfx = ",\n";\r
 243         }\r
 244         sb.append(CARRIAGE_RETURN);\r
 245 \r
 246         // Append Parameters to the string\r
 247         pfx = "\n";\r
 248         sb.append("\"parameters\": {");\r
 249         Map<String, String> props = Parameters.getParameters();\r
 250         Set<String> ivals = new HashSet<>();\r
 251         String intv = props.get("_INT_VALUES");\r
 252         if (intv != null) {\r
 253             ivals.addAll(Arrays.asList(intv.split("\\|")));\r
 254         }\r
 255         for (String key : new TreeSet<String>(props.keySet())) {\r
 256             String val = props.get(key);\r
 257             sb.append(pfx);\r
 258             sb.append("  \"").append(key).append("\": ");\r
 259             if (ivals.contains(key)) {\r
 260                 // integer value\r
 261                 sb.append(val);\r
 262             } else if (key.endsWith("S")) {\r
 263                 // Split and append array of strings\r
 264                 String[] pp = val.split("\\|");\r
 265                 String p2 = "";\r
 266                 sb.append("[");\r
 267                 for (String t : pp) {\r
 268                     sb.append(p2).append("\"").append(quote(t)).append("\"");\r
 269                     p2 = ",";\r
 270                 }\r
 271                 sb.append("]");\r
 272             } else {\r
 273                 sb.append("\"").append(quote(val)).append("\"");\r
 274             }\r
 275             pfx = ",\n";\r
 276         }\r
 277         sb.append("\n},\n");\r
 278 \r
 279         // Append Routes to the string\r
 280         pfx = "\n";\r
 281         sb.append("\"ingress\": [");\r
 282         for (IngressRoute in : IngressRoute.getAllIngressRoutes()) {\r
 283             sb.append(pfx);\r
 284             sb.append(in.asJSONObject().toString());\r
 285             pfx = ",\n";\r
 286         }\r
 287         sb.append(CARRIAGE_RETURN);\r
 288 \r
 289         pfx = "\n";\r
 290         sb.append("\"egress\": {");\r
 291         for (EgressRoute eg : EgressRoute.getAllEgressRoutes()) {\r
 292             sb.append(pfx);\r
 293             String str = eg.asJSONObject().toString();\r
 294             str = str.substring(1, str.length() - 1);\r
 295             sb.append(str);\r
 296             pfx = ",\n";\r
 297         }\r
 298         sb.append("\n},\n");\r
 299 \r
 300         pfx = "\n";\r
 301         sb.append("\"routing\": [");\r
 302         for (NetworkRoute ne : NetworkRoute.getAllNetworkRoutes()) {\r
 303             sb.append(pfx);\r
 304             sb.append(ne.asJSONObject().toString());\r
 305             pfx = ",\n";\r
 306         }\r
 307         sb.append("\n]");\r
 308         sb.append("\n}");\r
 309 \r
 310         // Convert to string and verify it is valid JSON\r
 311         String tempProvString = sb.toString();\r
 312         try {\r
 313             new JSONObject(new JSONTokener(tempProvString));\r
 314         } catch (JSONException e) {\r
 315             logger.warn("PROV0016: Possible invalid prov string: " + e);\r
 316         }\r
 317         return tempProvString;\r
 318     }\r
 319 \r
 320     private String quote(String str) {\r
 321         StringBuilder sb = new StringBuilder();\r
 322         for (char ch : str.toCharArray()) {\r
 323             if (ch == '\\' || ch == '"') {\r
 324                 sb.append('\\');\r
 325             }\r
 326             sb.append(ch);\r
 327         }\r
 328         return sb.toString();\r
 329     }\r
 330 }\r