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