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