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