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     /**\r
 134      * DELETE route table entries by deleting part of the route table tree.\r
 135      */\r
 136     @Override\r
 137     public void doDelete(HttpServletRequest req, HttpServletResponse resp) {\r
 138         EventLogRecord elr = new EventLogRecord(req);\r
 139         if (!isAuthorizedForInternal(req)) {\r
 140             elr.setMessage(UNAUTHORIZED);\r
 141             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 142             eventlogger.error(elr.toString());\r
 143             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, UNAUTHORIZED, eventlogger);\r
 144             return;\r
 145         }\r
 146         if (isProxyOK(req) && isProxyServer()) {\r
 147             super.doDelete(req, resp);\r
 148             return;\r
 149         }\r
 150 \r
 151         String path = req.getPathInfo();\r
 152         String[] parts = path.substring(1).split("/");\r
 153         Deleteable[] d = null;\r
 154         if ("ingress".equals(parts[0])) {\r
 155             if (parts.length == 4) {\r
 156                 // /internal/route/ingress/<feed>/<user>/<subnet>\r
 157                 try {\r
 158                     int feedid = Integer.parseInt(parts[1]);\r
 159                     IngressRoute er = IngressRoute.getIngressRoute(feedid, parts[2], parts[3].replaceAll("!", "/"));\r
 160                     if (er == null) {\r
 161                         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "The specified ingress route does not exist.", eventlogger);\r
 162                         return;\r
 163                     }\r
 164                     d = new Deleteable[] { er };\r
 165                 } catch (NumberFormatException e) {\r
 166                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid feed ID in 'delete ingress' command.", eventlogger);\r
 167                     return;\r
 168                 }\r
 169             } else if (parts.length == 2) {\r
 170                 // /internal/route/ingress/<seq>\r
 171                 try {\r
 172                     int seq = Integer.parseInt(parts[1]);\r
 173                     Set<IngressRoute> set = IngressRoute.getIngressRoutesForSeq(seq);\r
 174                     d = set.toArray(new Deleteable[0]);\r
 175                 } catch (NumberFormatException e) {\r
 176                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid sequence number in 'delete ingress' command.", eventlogger);\r
 177                     return;\r
 178                 }\r
 179             } else {\r
 180                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete ingress' command.", eventlogger);\r
 181                 return;\r
 182             }\r
 183         } else if ("egress".equals(parts[0])) {\r
 184             if (parts.length == 2) {\r
 185                 // /internal/route/egress/<sub>\r
 186                 try {\r
 187                     int subid = Integer.parseInt(parts[1]);\r
 188                     EgressRoute er = EgressRoute.getEgressRoute(subid);\r
 189                     if (er == null) {\r
 190                         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "The specified egress route does not exist.", eventlogger);\r
 191                         return;\r
 192                     }\r
 193                     d = new Deleteable[] { er };\r
 194                 } catch (NumberFormatException e) {\r
 195                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid sub ID in 'delete egress' command.", eventlogger);\r
 196                     return;\r
 197                 }\r
 198             } else {\r
 199                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete egress' command.", eventlogger);\r
 200                 return;\r
 201             }\r
 202         } else if ("network".equals(parts[0])) {\r
 203             if (parts.length == 3) {\r
 204                 // /internal/route/network/<from>/<to>\r
 205                 try {//\r
 206                     NetworkRoute nr = new NetworkRoute(\r
 207                         NodeClass.normalizeNodename(parts[1]),\r
 208                         NodeClass.normalizeNodename(parts[2])\r
 209                     );\r
 210                     d = new Deleteable[] { nr };\r
 211                 } catch (IllegalArgumentException e) {\r
 212                     String message = "The specified network route does not exist.";\r
 213                     eventlogger.error(message, e);\r
 214                     sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);\r
 215                     return;\r
 216                 }\r
 217             } else {\r
 218                 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, "Invalid number of arguments in 'delete network' command.", eventlogger);\r
 219                 return;\r
 220             }\r
 221         }\r
 222         if (d == null) {\r
 223             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, BAD_URL, eventlogger);\r
 224             return;\r
 225         }\r
 226         boolean rv = true;\r
 227         for (Deleteable dd : d) {\r
 228             rv &= doDelete(dd);\r
 229         }\r
 230         if (rv) {\r
 231             elr.setResult(HttpServletResponse.SC_OK);\r
 232             eventlogger.info(elr.toString());\r
 233             resp.setStatus(HttpServletResponse.SC_OK);\r
 234             provisioningDataChanged();\r
 235             provisioningParametersChanged();\r
 236         } else {\r
 237             // Something went wrong with the DELETE\r
 238             elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);\r
 239             eventlogger.error(elr.toString());\r
 240             sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, eventlogger);\r
 241         }\r
 242     }\r
 243     /**\r
 244      * GET route table entries from the route table tree specified by the URL path.\r
 245      */\r
 246     @Override\r
 247     public void doGet(HttpServletRequest req, HttpServletResponse resp) {\r
 248         EventLogRecord elr = new EventLogRecord(req);\r
 249         if (!isAuthorizedForInternal(req)) {\r
 250             elr.setMessage(UNAUTHORIZED);\r
 251             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 252             eventlogger.error(elr.toString());\r
 253             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, UNAUTHORIZED, eventlogger);\r
 254             return;\r
 255         }\r
 256         if (isProxyOK(req) && isProxyServer()) {\r
 257             super.doGet(req, resp);\r
 258             return;\r
 259         }\r
 260 \r
 261         String path = req.getPathInfo();\r
 262         if (!path.endsWith("/"))\r
 263             path += "/";\r
 264         if (!"/".equals(path) && !INGRESS.equals(path) && !EGRESS.equals(path) && !NETWORK.equals(path)) {\r
 265             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, BAD_URL, eventlogger);\r
 266             return;\r
 267         }\r
 268 \r
 269         StringBuilder sb = new StringBuilder("{\n");\r
 270         String px2 = "";\r
 271         if ("/".equals(path) || INGRESS.equals(path)) {\r
 272             String pfx = "\n";\r
 273             sb.append("\"ingress\": [");\r
 274             for (IngressRoute in : IngressRoute.getAllIngressRoutes()) {\r
 275                 sb.append(pfx);\r
 276                 sb.append(in.asJSONObject().toString());\r
 277                 pfx = ",\n";\r
 278             }\r
 279             sb.append("\n]");\r
 280             px2 = ",\n";\r
 281         }\r
 282 \r
 283         if ("/".equals(path) || EGRESS.equals(path)) {\r
 284             String pfx = "\n";\r
 285             sb.append(px2);\r
 286             sb.append("\"egress\": {");\r
 287             for (EgressRoute eg : EgressRoute.getAllEgressRoutes()) {\r
 288                 JSONObject jx = eg.asJSONObject();\r
 289                 for (String key : jx.keySet()) {\r
 290                     sb.append(pfx);\r
 291                     sb.append("  \"").append(key).append("\": ");\r
 292                     try {\r
 293                         sb.append("\"").append(jx.getString(key)).append("\"");\r
 294                     } catch (JSONException je) {\r
 295                         eventlogger.error("PROV0161 RouteServlet.doGet: " + je.getMessage(), je);\r
 296                     }\r
 297                     pfx = ",\n";\r
 298                 }\r
 299             }\r
 300             sb.append("\n}");\r
 301             px2 = ",\n";\r
 302         }\r
 303 \r
 304         if ("/".equals(path) || NETWORK.equals(path)) {\r
 305             String pfx = "\n";\r
 306             sb.append(px2);\r
 307             sb.append("\"routing\": [");\r
 308             for (NetworkRoute ne : NetworkRoute.getAllNetworkRoutes()) {\r
 309                 sb.append(pfx);\r
 310                 sb.append(ne.asJSONObject().toString());\r
 311                 pfx = ",\n";\r
 312             }\r
 313             sb.append("\n]");\r
 314         }\r
 315         sb.append("}\n");\r
 316         resp.setStatus(HttpServletResponse.SC_OK);\r
 317         resp.setContentType("application/json");\r
 318         try {\r
 319             resp.getOutputStream().print(sb.toString());\r
 320         } catch (IOException ioe) {\r
 321             eventlogger.error("PROV0162 RouteServlet.doGet: " + ioe.getMessage(), ioe);\r
 322         }\r
 323     }\r
 324     /**\r
 325      * PUT on &lt;/internal/route/*&gt; -- not supported.\r
 326      */\r
 327     @Override\r
 328     public void doPut(HttpServletRequest req, HttpServletResponse resp) {\r
 329         EventLogRecord elr = new EventLogRecord(req);\r
 330         if (!isAuthorizedForInternal(req)) {\r
 331             elr.setMessage(UNAUTHORIZED);\r
 332             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 333             eventlogger.error(elr.toString());\r
 334             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, UNAUTHORIZED, eventlogger);\r
 335             return;\r
 336         }\r
 337         sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, BAD_URL, eventlogger);\r
 338     }\r
 339     /**\r
 340      * POST - modify existing route table entries in the route table tree specified by the URL path.\r
 341      */\r
 342     @Override\r
 343     public void doPost(HttpServletRequest req, HttpServletResponse resp) {\r
 344         EventLogRecord elr = new EventLogRecord(req);\r
 345         if (!isAuthorizedForInternal(req)) {\r
 346             elr.setMessage(UNAUTHORIZED);\r
 347             elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
 348             eventlogger.error(elr.toString());\r
 349             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, UNAUTHORIZED, eventlogger);\r
 350             return;\r
 351         }\r
 352         if (isProxyOK(req) && isProxyServer()) {\r
 353             super.doPost(req, resp);\r
 354             return;\r
 355         }\r
 356         String path = req.getPathInfo();\r
 357         Insertable[] ins = null;\r
 358         if (path.startsWith(INGRESS)) {\r
 359             // /internal/route/ingress/?feed=%s&amp;user=%s&amp;subnet=%s&amp;nodepatt=%s\r
 360             try {\r
 361                 // Although it probably doesn't make sense, you can install two identical routes in the IRT\r
 362                 int feedid = Integer.parseInt(req.getParameter("feed"));\r
 363                 String user = req.getParameter("user");\r
 364                 if (user == null)\r
 365                     user = "-";\r
 366                 String subnet = req.getParameter("subnet");\r
 367                 if (subnet == null)\r
 368                     subnet = "-";\r
 369                 String nodepatt = req.getParameter("nodepatt");\r
 370                 String t = req.getParameter("seq");\r
 371                 int seq = (t != null) ? Integer.parseInt(t) : (IngressRoute.getMaxSequence() + 100);\r
 372                 ins = new Insertable[] { new IngressRoute(seq, feedid, user, subnet, NodeClass.lookupNodeNames(nodepatt)) };\r
 373             } catch (Exception e) {\r
 374                 intlogger.info(e.toString(), e);\r
 375                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add ingress' command.", intlogger);\r
 376                 return;\r
 377             }\r
 378         } else if (path.startsWith(EGRESS)) {\r
 379             // /internal/route/egress/?sub=%s&amp;node=%s\r
 380             try {\r
 381                 int subid = Integer.parseInt(req.getParameter("sub"));\r
 382                 EgressRoute er = EgressRoute.getEgressRoute(subid);\r
 383                 if (er != null) {\r
 384                     sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "An egress route already exists for that subscriber.", intlogger);\r
 385                     return;\r
 386                 }\r
 387                 String node = NodeClass.normalizeNodename(req.getParameter("node"));\r
 388                 ins = new Insertable[] { new EgressRoute(subid, node) };\r
 389             } catch (Exception e) {\r
 390                 intlogger.info(e.toString(), e);\r
 391                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add egress' command.", intlogger);\r
 392                 return;\r
 393             }\r
 394         } else if (path.startsWith(NETWORK)) {\r
 395             // /internal/route/network/?from=%s&amp;to=%s&amp;via=%s\r
 396             try {\r
 397                 String nfrom = req.getParameter("from");\r
 398                 String nto   = req.getParameter("to");\r
 399                 String nvia  = req.getParameter("via");\r
 400                 if (nfrom == null || nto == null || nvia == null) {\r
 401                     sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Missing arguments in 'add network' command.", intlogger);\r
 402                     return;\r
 403                 }\r
 404                 nfrom = NodeClass.normalizeNodename(nfrom);\r
 405                 nto   = NodeClass.normalizeNodename(nto);\r
 406                 nvia  = NodeClass.normalizeNodename(nvia);\r
 407                 NetworkRoute nr = new NetworkRoute(nfrom, nto, nvia);\r
 408                 for (NetworkRoute route : NetworkRoute.getAllNetworkRoutes()) {\r
 409                     if (route.getFromnode() == nr.getFromnode() && route.getTonode() == nr.getTonode()) {\r
 410                         sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Network route table already contains a route for " + nfrom + " and " + nto, intlogger);\r
 411                         return;\r
 412                     }\r
 413                 }\r
 414                 ins = new Insertable[] { nr };\r
 415             } catch (IllegalArgumentException e) {\r
 416                 intlogger.info(e.toString(), e);\r
 417                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, "Invalid arguments in 'add network' command.", intlogger);\r
 418                 return;\r
 419             }\r
 420         }\r
 421         if (ins == null) {\r
 422             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, BAD_URL, intlogger);\r
 423             return;\r
 424         }\r
 425         boolean rv = true;\r
 426         for (Insertable dd : ins) {\r
 427             rv &= doInsert(dd);\r
 428         }\r
 429         if (rv) {\r
 430             elr.setResult(HttpServletResponse.SC_OK);\r
 431             eventlogger.info(elr.toString());\r
 432             resp.setStatus(HttpServletResponse.SC_OK);\r
 433             provisioningDataChanged();\r
 434             provisioningParametersChanged();\r
 435         } else {\r
 436             // Something went wrong with the INSERT\r
 437             elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);\r
 438             eventlogger.error(elr.toString());\r
 439             sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, intlogger);\r
 440         }\r
 441     }\r
 442 }\r