datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/RouteServlet.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 \r
  25 package org.onap.dmaap.datarouter.provisioning;\r
  26 \r
  27 import java.io.IOException;\r
  28 import java.util.Set;\r
  29 \r
  30 import javax.servlet.http.HttpServletRequest;\r
  31 import javax.servlet.http.HttpServletResponse;\r
  32 \r
  33 import org.json.JSONException;\r
  34 import org.json.JSONObject;\r
  35 import org.onap.dmaap.datarouter.provisioning.beans.Deleteable;\r
  36 import org.onap.dmaap.datarouter.provisioning.beans.EgressRoute;\r
  37 import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;\r
  38 import org.onap.dmaap.datarouter.provisioning.beans.IngressRoute;\r
  39 import org.onap.dmaap.datarouter.provisioning.beans.Insertable;\r
  40 import org.onap.dmaap.datarouter.provisioning.beans.NetworkRoute;\r
  41 import org.onap.dmaap.datarouter.provisioning.beans.NodeClass;\r
  42 \r
  43 import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;\r
  44 \r
  45 /**\r
  46  * <p>\r
  47  * This servlet handles requests to URLs under /internal/route/ on the provisioning server.\r
  48  * This part of the URL tree is used to manipulate the Data Router routing tables.\r
  49  * These include:\r
  50  * </p>\r
  51  * <div class="contentContainer">\r
  52  * <table class="packageSummary" border="0" cellpadding="3" cellspacing="0">\r
  53  * <caption><span>URL Path Summary</span><span class="tabEnd">&nbsp;</span></caption>\r
  54  * <tr>\r
  55  *   <th class="colFirst" width="35%">URL Path</th>\r
  56  *   <th class="colOne">Method</th>\r
  57  *   <th class="colLast">Purpose</th>\r
  58  * </tr>\r
  59  * <tr class="altColor">\r
  60  *   <td class="colFirst">/internal/route/</td>\r
  61  *   <td class="colOne">GET</td>\r
  62  *   <td class="colLast">used to GET a full JSON copy of all three routing tables.</td>\r
  63  * </tr>\r
  64  * <tr class="rowColor">\r
  65  *   <td class="colFirst" rowspan="2">/internal/route/ingress/</td>\r
  66  *   <td class="colOne">GET</td>\r
  67  *   <td class="colLast">used to GET a full JSON copy of the ingress routing table (IRT).</td>\r
  68  * </tr>\r
  69  * <tr class="rowColor">\r
  70  *   <td class="colOne">POST</td>\r
  71  *   <td class="colLast">used to create a new entry in the ingress routing table (IRT).</td></tr>\r
  72  * <tr class="altColor">\r
  73  *   <td class="colFirst" rowspan="2">/internal/route/egress/</td>\r
  74  *   <td class="colOne">GET</td>\r
  75  *   <td class="colLast">used to GET a full JSON copy of the egress routing table (ERT).</td>\r
  76  * </tr>\r
  77  * <tr class="altColor">\r
  78  *   <td class="colOne">POST</td>\r
  79  *   <td class="colLast">used to create a new entry in the egress routing table (ERT).</td></tr>\r
  80  * <tr class="rowColor">\r
  81  *   <td class="colFirst" rowspan="2">/internal/route/network/</td>\r
  82  *   <td class="colOne">GET</td>\r
  83  *   <td class="colLast">used to GET a full JSON copy of the network routing table (NRT).</td>\r
  84  * </tr>\r
  85  * <tr class="rowColor">\r
  86  *   <td class="colOne">POST</td>\r
  87  *   <td class="colLast">used to create a new entry in the network routing table (NRT).</td>\r
  88  * </tr>\r
  89  * <tr class="altColor">\r
  90  *   <td class="colFirst">/internal/route/ingress/&lt;feed&gt;/&lt;user&gt;/&lt;subnet&gt;</td>\r
  91  *   <td class="colOne">DELETE</td>\r
  92  *   <td class="colLast">used to DELETE the ingress route corresponding to <i>feed</i>, <i>user</i> and <i>subnet</i>.\r
  93  *   The / in the subnet specified should be replaced with a !, since / cannot be used in a URL.</td>\r
  94  * </tr>\r
  95  * <tr class="rowColor">\r
  96  *   <td class="colFirst">/internal/route/ingress/&lt;seq&gt;</td>\r
  97  *   <td class="colOne">DELETE</td>\r
  98  *   <td class="colLast">used to DELETE all ingress routes with the matching <i>seq</i> sequence number.</td>\r
  99  * </tr>\r
 100  * <tr class="altColor">\r
 101  *   <td class="colFirst">/internal/route/egress/&lt;sub&gt;</td>\r
 102  *   <td class="colOne">DELETE</td>\r
 103  *   <td class="colLast">used to DELETE the egress route the matching <i>sub</i> subscriber number.</td>\r
 104  * </tr>\r
 105  * <tr class="rowColor">\r
 106  *   <td class="colFirst">/internal/route/network/&lt;fromnode&gt;/&lt;tonode&gt;</td>\r
 107  *   <td class="colOne">DELETE</td>\r
 108  *   <td class="colLast">used to DELETE the network route corresponding to <i>fromnode</i>\r
 109  *   and <i>tonode</i>.</td>\r
 110  * </tr>\r
 111  * </table>\r
 112  * <p>\r
 113  * Authorization to use these URLs is a little different than for other URLs on the provisioning server.\r
 114  * For the most part, the IP address that the request comes from should be either:\r
 115  * </p>\r
 116  * <ol>\r
 117  * <li>an IP address of a provisioning server, or</li>\r
 118  * <li>the IP address of a node, or</li>\r
 119  * <li>an IP address from the "<i>special subnet</i>" which is configured with\r
 120  * the PROV_SPECIAL_SUBNET parameter.\r
 121  * </ol>\r
 122  * <p>\r
 123  * All DELETE/GET/POST requests made to this servlet on the standby server are proxied to the\r
 124  * active server (using the {@link ProxyServlet}) if it is up and reachable.\r
 125  * </p>\r
 126  *\r
 127  * @author Robert Eby\r
 128  * @version $Id$\r
 129  */\r
 130 @SuppressWarnings("serial")\r
 131 public class RouteServlet extends ProxyServlet {\r
 132     /**\r
 133      * DELETE route table entries by deleting part of the route table tree.\r
 134      */\r
 135     @Override\r
 136     public void doDelete(HttpServletRequest req, HttpServletResponse resp) {\r
 137         EventLogRecord elr = new EventLogRecord(req);\r
 138         if (!isAuthorizedForInternal(req)) {\r
 139             elr.setMessage("Unauthorized.");\r
 140             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 141             eventlogger.error(elr.toString());\r
 142             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, "Unauthorized.", eventlogger);\r
 143             return;\r
 144         }\r
 145         if (isProxyOK(req) && isProxyServer()) {\r
 146             super.doDelete(req, resp);\r
 147             return;\r
 148         }\r
 149 \r
 150         String path = req.getPathInfo();\r
 151         String[] parts = path.substring(1).split("/");\r
 152         Deleteable[] d = null;\r
 153         if (parts[0].equals("ingress")) {\r
 154             if (parts.length == 4) {\r
 155                 // /internal/route/ingress/<feed>/<user>/<subnet>\r
 156                 try {\r
 157                     int feedid = Integer.parseInt(parts[1]);\r
 158                     IngressRoute er = IngressRoute.getIngressRoute(feedid, parts[2], parts[3].replaceAll("!", "/"));\r
 159                     if (er == null) {\r
 160                         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "The specified ingress route does not exist.", eventlogger);\r
 161                         return;\r
 162                     }\r
 163                     d = new Deleteable[] { er };\r
 164                 } catch (NumberFormatException e) {\r
 165                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid feed ID in 'delete ingress' command.", eventlogger);\r
 166                     return;\r
 167                 }\r
 168             } else if (parts.length == 2) {\r
 169                 // /internal/route/ingress/<seq>\r
 170                 try {\r
 171                     int seq = Integer.parseInt(parts[1]);\r
 172                     Set<IngressRoute> set = IngressRoute.getIngressRoutesForSeq(seq);\r
 173                     d = set.toArray(new Deleteable[0]);\r
 174                 } catch (NumberFormatException e) {\r
 175                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid sequence number in 'delete ingress' command.", eventlogger);\r
 176                     return;\r
 177                 }\r
 178             } else {\r
 179                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete ingress' command.", eventlogger);\r
 180                 return;\r
 181             }\r
 182         } else if (parts[0].equals("egress")) {\r
 183             if (parts.length == 2) {\r
 184                 // /internal/route/egress/<sub>\r
 185                 try {\r
 186                     int subid = Integer.parseInt(parts[1]);\r
 187                     EgressRoute er = EgressRoute.getEgressRoute(subid);\r
 188                     if (er == null) {\r
 189                         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "The specified egress route does not exist.", eventlogger);\r
 190                         return;\r
 191                     }\r
 192                     d = new Deleteable[] { er };\r
 193                 } catch (NumberFormatException e) {\r
 194                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid sub ID in 'delete egress' command.", eventlogger);\r
 195                     return;\r
 196                 }\r
 197             } else {\r
 198                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete egress' command.", eventlogger);\r
 199                 return;\r
 200             }\r
 201         } else if (parts[0].equals("network")) {\r
 202             if (parts.length == 3) {\r
 203                 // /internal/route/network/<from>/<to>\r
 204                 try {//\r
 205                     NetworkRoute nr = new NetworkRoute(\r
 206                         NodeClass.normalizeNodename(parts[1]),\r
 207                         NodeClass.normalizeNodename(parts[2])\r
 208                     );\r
 209                     d = new Deleteable[] { nr };\r
 210                 } catch (IllegalArgumentException e) {\r
 211                     String message = "The specified network route does not exist.";\r
 212                     eventlogger.error(message, e);\r
 213                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);\r
 214                     return;\r
 215                 }\r
 216             } else {\r
 217                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete network' command.", eventlogger);\r
 218                 return;\r
 219             }\r
 220         }\r
 221         if (d == null) {\r
 222             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Bad URL.", eventlogger);\r
 223             return;\r
 224         }\r
 225         boolean rv = true;\r
 226         for (Deleteable dd : d) {\r
 227             rv &= doDelete(dd);\r
 228         }\r
 229         if (rv) {\r
 230             elr.setResult(HttpServletResponse.SC_OK);\r
 231             eventlogger.info(elr.toString());\r
 232             resp.setStatus(HttpServletResponse.SC_OK);\r
 233             provisioningDataChanged();\r
 234             provisioningParametersChanged();\r
 235         } else {\r
 236             // Something went wrong with the DELETE\r
 237             elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);\r
 238             eventlogger.error(elr.toString());\r
 239             sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, eventlogger);\r
 240         }\r
 241     }\r
 242     /**\r
 243      * GET route table entries from the route table tree specified by the URL path.\r
 244      */\r
 245     @Override\r
 246     public void doGet(HttpServletRequest req, HttpServletResponse resp) {\r
 247         EventLogRecord elr = new EventLogRecord(req);\r
 248         if (!isAuthorizedForInternal(req)) {\r
 249             elr.setMessage("Unauthorized.");\r
 250             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 251             eventlogger.error(elr.toString());\r
 252             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, "Unauthorized.", eventlogger);\r
 253             return;\r
 254         }\r
 255         if (isProxyOK(req) && isProxyServer()) {\r
 256             super.doGet(req, resp);\r
 257             return;\r
 258         }\r
 259 \r
 260         String path = req.getPathInfo();\r
 261         if (!path.endsWith("/"))\r
 262             path += "/";\r
 263         if (!path.equals("/") && !path.equals("/ingress/") && !path.equals("/egress/") && !path.equals("/network/")) {\r
 264             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Bad URL.", eventlogger);\r
 265             return;\r
 266         }\r
 267 \r
 268         StringBuilder sb = new StringBuilder("{\n");\r
 269         String px2 = "";\r
 270         if (path.equals("/") || path.equals("/ingress/")) {\r
 271             String pfx = "\n";\r
 272             sb.append("\"ingress\": [");\r
 273             for (IngressRoute in : IngressRoute.getAllIngressRoutes()) {\r
 274                 sb.append(pfx);\r
 275                 sb.append(in.asJSONObject().toString());\r
 276                 pfx = ",\n";\r
 277             }\r
 278             sb.append("\n]");\r
 279             px2 = ",\n";\r
 280         }\r
 281 \r
 282         if (path.equals("/") || path.equals("/egress/")) {\r
 283             String pfx = "\n";\r
 284             sb.append(px2);\r
 285             sb.append("\"egress\": {");\r
 286             for (EgressRoute eg : EgressRoute.getAllEgressRoutes()) {\r
 287                 JSONObject jx = eg.asJSONObject();\r
 288                 for (String key : jx.keySet()) {\r
 289                     sb.append(pfx);\r
 290                     sb.append("  \"").append(key).append("\": ");\r
 291                     try {\r
 292                         sb.append("\"").append(jx.getString(key)).append("\"");\r
 293                     } catch (JSONException je) {\r
 294                         eventlogger.error("PROV0161 RouteServlet.doGet: " + je.getMessage(), je);\r
 295                     }\r
 296                     pfx = ",\n";\r
 297                 }\r
 298             }\r
 299             sb.append("\n}");\r
 300             px2 = ",\n";\r
 301         }\r
 302 \r
 303         if (path.equals("/") || path.equals("/network/")) {\r
 304             String pfx = "\n";\r
 305             sb.append(px2);\r
 306             sb.append("\"routing\": [");\r
 307             for (NetworkRoute ne : NetworkRoute.getAllNetworkRoutes()) {\r
 308                 sb.append(pfx);\r
 309                 sb.append(ne.asJSONObject().toString());\r
 310                 pfx = ",\n";\r
 311             }\r
 312             sb.append("\n]");\r
 313         }\r
 314         sb.append("}\n");\r
 315         resp.setStatus(HttpServletResponse.SC_OK);\r
 316         resp.setContentType("application/json");\r
 317         try {\r
 318             resp.getOutputStream().print(sb.toString());\r
 319         } catch (IOException ioe) {\r
 320             eventlogger.error("PROV0162 RouteServlet.doGet: " + ioe.getMessage(), ioe);\r
 321         }\r
 322     }\r
 323     /**\r
 324      * PUT on &lt;/internal/route/*&gt; -- not supported.\r
 325      */\r
 326     @Override\r
 327     public void doPut(HttpServletRequest req, HttpServletResponse resp) {\r
 328         EventLogRecord elr = new EventLogRecord(req);\r
 329         if (!isAuthorizedForInternal(req)) {\r
 330             elr.setMessage("Unauthorized.");\r
 331             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 332             eventlogger.error(elr.toString());\r
 333             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, "Unauthorized.", eventlogger);\r
 334             return;\r
 335         }\r
 336         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Bad URL.", eventlogger);\r
 337     }\r
 338     /**\r
 339      * POST - modify existing route table entries in the route table tree specified by the URL path.\r
 340      */\r
 341     @Override\r
 342     public void doPost(HttpServletRequest req, HttpServletResponse resp) {\r
 343         EventLogRecord elr = new EventLogRecord(req);\r
 344         if (!isAuthorizedForInternal(req)) {\r
 345             elr.setMessage("Unauthorized.");\r
 346             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 347             eventlogger.error(elr.toString());\r
 348             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, "Unauthorized.", eventlogger);\r
 349             return;\r
 350         }\r
 351         if (isProxyOK(req) && isProxyServer()) {\r
 352             super.doPost(req, resp);\r
 353             return;\r
 354         }\r
 355         String path = req.getPathInfo();\r
 356         Insertable[] ins = null;\r
 357         if (path.startsWith("/ingress/")) {\r
 358             // /internal/route/ingress/?feed=%s&amp;user=%s&amp;subnet=%s&amp;nodepatt=%s\r
 359             try {\r
 360                 // Although it probably doesn't make sense, you can install two identical routes in the IRT\r
 361                 int feedid = Integer.parseInt(req.getParameter("feed"));\r
 362                 String user = req.getParameter("user");\r
 363                 if (user == null)\r
 364                     user = "-";\r
 365                 String subnet = req.getParameter("subnet");\r
 366                 if (subnet == null)\r
 367                     subnet = "-";\r
 368                 String nodepatt = req.getParameter("nodepatt");\r
 369                 String t = req.getParameter("seq");\r
 370                 int seq = (t != null) ? Integer.parseInt(t) : (IngressRoute.getMaxSequence() + 100);\r
 371                 ins = new Insertable[] { new IngressRoute(seq, feedid, user, subnet, NodeClass.lookupNodeNames(nodepatt)) };\r
 372             } catch (Exception e) {\r
 373                 intlogger.info(e.toString(), e);\r
 374                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add ingress' command.", intlogger);\r
 375                 return;\r
 376             }\r
 377         } else if (path.startsWith("/egress/")) {\r
 378             // /internal/route/egress/?sub=%s&amp;node=%s\r
 379             try {\r
 380                 int subid = Integer.parseInt(req.getParameter("sub"));\r
 381                 EgressRoute er = EgressRoute.getEgressRoute(subid);\r
 382                 if (er != null) {\r
 383                     sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "An egress route already exists for that subscriber.", intlogger);\r
 384                     return;\r
 385                 }\r
 386                 String node = NodeClass.normalizeNodename(req.getParameter("node"));\r
 387                 ins = new Insertable[] { new EgressRoute(subid, node) };\r
 388             } catch (Exception e) {\r
 389                 intlogger.info(e.toString(), e);\r
 390                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add egress' command.", intlogger);\r
 391                 return;\r
 392             }\r
 393         } else if (path.startsWith("/network/")) {\r
 394             // /internal/route/network/?from=%s&amp;to=%s&amp;via=%s\r
 395             try {\r
 396                 String nfrom = req.getParameter("from");\r
 397                 String nto   = req.getParameter("to");\r
 398                 String nvia  = req.getParameter("via");\r
 399                 if (nfrom == null || nto == null || nvia == null) {\r
 400                     sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Missing arguments in 'add network' command.", intlogger);\r
 401                     return;\r
 402                 }\r
 403                 nfrom = NodeClass.normalizeNodename(nfrom);\r
 404                 nto   = NodeClass.normalizeNodename(nto);\r
 405                 nvia  = NodeClass.normalizeNodename(nvia);\r
 406                 NetworkRoute nr = new NetworkRoute(nfrom, nto, nvia);\r
 407                 for (NetworkRoute route : NetworkRoute.getAllNetworkRoutes()) {\r
 408                     if (route.getFromnode() == nr.getFromnode() && route.getTonode() == nr.getTonode()) {\r
 409                         sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Network route table already contains a route for " + nfrom + " and " + nto, intlogger);\r
 410                         return;\r
 411                     }\r
 412                 }\r
 413                 ins = new Insertable[] { nr };\r
 414             } catch (IllegalArgumentException e) {\r
 415                 intlogger.info(e.toString(), e);\r
 416                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add network' command.", intlogger);\r
 417                 return;\r
 418             }\r
 419         }\r
 420         if (ins == null) {\r
 421             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Bad URL.", intlogger);\r
 422             return;\r
 423         }\r
 424         boolean rv = true;\r
 425         for (Insertable dd : ins) {\r
 426             rv &= doInsert(dd);\r
 427         }\r
 428         if (rv) {\r
 429             elr.setResult(HttpServletResponse.SC_OK);\r
 430             eventlogger.info(elr.toString());\r
 431             resp.setStatus(HttpServletResponse.SC_OK);\r
 432             provisioningDataChanged();\r
 433             provisioningParametersChanged();\r
 434         } else {\r
 435             // Something went wrong with the INSERT\r
 436             elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);\r
 437             eventlogger.error(elr.toString());\r
 438             sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, intlogger);\r
 439         }\r
 440     }\r
 441 }\r