datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/PublishServlet.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 com.att.eelf.configuration.EELFLogger;\r
  28 import com.att.eelf.configuration.EELFManager;\r
  29 \r
  30 import jakarta.servlet.ServletConfig;\r
  31 import jakarta.servlet.ServletException;\r
  32 import java.io.IOException;\r
  33 import java.util.ArrayList;\r
  34 import java.util.Collection;\r
  35 import java.util.List;\r
  36 import jakarta.servlet.http.HttpServletRequest;\r
  37 import jakarta.servlet.http.HttpServletResponse;\r
  38 \r
  39 import org.apache.commons.lang3.StringUtils;\r
  40 import org.json.JSONArray;\r
  41 import org.json.JSONException;\r
  42 import org.json.JSONObject;\r
  43 import org.json.JSONTokener;\r
  44 import org.onap.dmaap.datarouter.provisioning.utils.Poker;\r
  45 import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;\r
  46 import org.onap.dmaap.datarouter.provisioning.beans.IngressRoute;\r
  47 import org.onap.dmaap.datarouter.provisioning.eelf.EelfMsgs;\r
  48 import org.onap.dmaap.datarouter.provisioning.utils.URLUtilities;\r
  49 \r
  50 /**\r
  51  * This servlet handles redirects for the &lt;publishURL&gt; on the provisioning server, which is generated by the\r
  52  * provisioning server to handle a particular subscriptions to a feed. See the <b>File Publishing and Delivery API</b>\r
  53  * document for details on how these methods should be invoked.\r
  54  *\r
  55  * @author Robert Eby\r
  56  * @version $Id: PublishServlet.java,v 1.8 2014/03/12 19:45:41 eby Exp $\r
  57  */\r
  58 @SuppressWarnings("serial")\r
  59 \r
  60 public class PublishServlet extends BaseServlet {\r
  61 \r
  62     private int nextNode;\r
  63     private String provstring;\r
  64     private List<IngressRoute> irt;\r
  65     //Adding EELF Logger Rally:US664892\r
  66     private static EELFLogger eelfLogger = EELFManager.getInstance()\r
  67             .getLogger(PublishServlet.class);\r
  68     private static final Object lock = new Object();\r
  69 \r
  70 \r
  71     @Override\r
  72     public void init(ServletConfig config) throws ServletException {\r
  73         super.init(config);\r
  74         nextNode = 0;\r
  75         provstring = "";\r
  76         irt = new ArrayList<>();\r
  77 \r
  78     }\r
  79 \r
  80     @Override\r
  81     public void doDelete(HttpServletRequest req, HttpServletResponse resp) {\r
  82         setUpEelfForPublishServlet(req, "doDelete");\r
  83         eelfLogger.info(EelfMsgs.ENTRY);\r
  84         try {\r
  85             eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID,\r
  86                     req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
  87             redirect(req, resp);\r
  88         } finally {\r
  89             eelfLogger.info(EelfMsgs.EXIT);\r
  90         }\r
  91     }\r
  92 \r
  93     @Override\r
  94     public void doGet(HttpServletRequest req, HttpServletResponse resp) {\r
  95         setUpEelfForPublishServlet(req, "doGet");\r
  96         eelfLogger.info(EelfMsgs.ENTRY);\r
  97         try {\r
  98             eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID,\r
  99                     req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
 100             redirect(req, resp);\r
 101         } finally {\r
 102             eelfLogger.info(EelfMsgs.EXIT);\r
 103         }\r
 104     }\r
 105 \r
 106     @Override\r
 107     public void doPut(HttpServletRequest req, HttpServletResponse resp) {\r
 108         setUpEelfForPublishServlet(req, "doPut");\r
 109         eelfLogger.info(EelfMsgs.ENTRY);\r
 110         try {\r
 111             eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID,\r
 112                     req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");\r
 113             redirect(req, resp);\r
 114         } finally {\r
 115             eelfLogger.info(EelfMsgs.EXIT);\r
 116         }\r
 117     }\r
 118 \r
 119     @Override\r
 120     public void doPost(HttpServletRequest req, HttpServletResponse resp) {\r
 121         setUpEelfForPublishServlet(req, "doPost");\r
 122         eelfLogger.info(EelfMsgs.ENTRY);\r
 123         try {\r
 124             eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF, req.getHeader(BEHALF_HEADER));\r
 125             redirect(req, resp);\r
 126         } finally {\r
 127             eelfLogger.info(EelfMsgs.EXIT);\r
 128         }\r
 129 \r
 130     }\r
 131 \r
 132     private void setUpEelfForPublishServlet(HttpServletRequest req, String method) {\r
 133         if (StringUtils.isBlank(req.getHeader("X-ONAP-RequestID"))\r
 134                     || StringUtils.isBlank(req.getHeader("X-InvocationID"))) {\r
 135             setIpFqdnForEelf(method);\r
 136         } else {\r
 137             setIpFqdnRequestIDandInvocationIDForEelf(method, req);\r
 138         }\r
 139     }\r
 140 \r
 141     private void redirect(HttpServletRequest req, HttpServletResponse resp) {\r
 142         try {\r
 143             String[] nodes = getNodes();\r
 144             if (nodes == null || nodes.length == 0) {\r
 145                 resp.sendError(HttpServletResponse.SC_SERVICE_UNAVAILABLE,\r
 146                         "There are no nodes defined in the DR network.");\r
 147             } else {\r
 148                 EventLogRecord elr = new EventLogRecord(req);\r
 149                 int feedid = checkPath(req);\r
 150                 if (feedid < 0) {\r
 151                     String message = (feedid == -1)\r
 152                             ? "Invalid request - Missing or bad feed number."\r
 153                             : "Invalid request - Missing file ID.";\r
 154                     elr.setMessage(message);\r
 155                     elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
 156                     eventlogger.error(elr.toString());\r
 157 \r
 158                     resp.sendError(HttpServletResponse.SC_NOT_FOUND, message);\r
 159                 } else {\r
 160                     // Generate new URL\r
 161                     String nextnode = getRedirectNode(feedid, req);\r
 162                     if (Boolean.TRUE.equals(ProvRunner.getTlsEnabled())) {\r
 163                         nextnode = nextnode + ":" + ProvRunner.getProvProperties().getProperty(\r
 164                             "org.onap.dmaap.datarouter.nodeserver.https.port", "8443");\r
 165                     } else {\r
 166                         nextnode = nextnode + ":" + ProvRunner.getProvProperties().getProperty(\r
 167                             "org.onap.dmaap.datarouter.nodeserver.http.port", "8080");\r
 168                     }\r
 169                     String newurl = URLUtilities.getUrlSecurityOption() + nextnode + "/publish" + req.getPathInfo();\r
 170                     String qs = req.getQueryString();\r
 171                     if (qs != null) {\r
 172                         newurl += "?" + qs;\r
 173                     }\r
 174 \r
 175                     // Log redirect in event log\r
 176                     String message = "Redirected to: " + newurl;\r
 177                     elr.setMessage(message);\r
 178                     elr.setResult(HttpServletResponse.SC_MOVED_PERMANENTLY);\r
 179                     eventlogger.info(elr.toString());\r
 180 \r
 181                     resp.setStatus(HttpServletResponse.SC_MOVED_PERMANENTLY);\r
 182                     resp.setHeader("Location", newurl);\r
 183                 }\r
 184             }\r
 185         } catch (IOException ioe) {\r
 186             intlogger.error("PROV0151 PublishServlet.redirect: " + ioe.getMessage(), ioe);\r
 187         }\r
 188     }\r
 189 \r
 190     private String getRedirectNode(int feedid, HttpServletRequest req) {\r
 191         // Check to see if the IRT needs to be updated\r
 192         Poker pkr = Poker.getPoker();\r
 193         String str = pkr.getProvisioningString();\r
 194         synchronized (lock) {\r
 195             if (irt == null || (str.length() != provstring.length()) || !str.equals(provstring)) {\r
 196                 // Provisioning string has changed -- update the IRT\r
 197                 provstring = str;\r
 198                 JSONObject jo = new JSONObject(new JSONTokener(provstring));\r
 199                 JSONArray ja = jo.getJSONArray("ingress");\r
 200                 List<IngressRoute> newlist = new ArrayList<>();\r
 201                 for (int i = 0; i < ja.length(); i++) {\r
 202                     IngressRoute iroute = new IngressRoute(ja.getJSONObject(i));\r
 203                     newlist.add(iroute);\r
 204                 }\r
 205                 irt = newlist;\r
 206             }\r
 207         }\r
 208 \r
 209         // Look in IRT for next node\r
 210         for (IngressRoute route : irt) {\r
 211             if (route.matches(feedid, req)) {\r
 212                 // pick a node at random from the list\r
 213                 Collection<String> nodes = route.getNodes();\r
 214                 String[] arr = nodes.toArray(new String[0]);\r
 215                 long id = System.currentTimeMillis() % arr.length;\r
 216                 String node = arr[(int) id];\r
 217                 intlogger.info("Redirecting to " + node + " because of route " + route);\r
 218                 return node;\r
 219             }\r
 220         }\r
 221 \r
 222         // No IRT rule matches, do round robin of all active nodes\r
 223         String[] nodes = getNodes();\r
 224         if (nextNode >= nodes.length) {   // The list of nodes may have grown/shrunk\r
 225             nextNode = 0;\r
 226         }\r
 227         return nodes[nextNode++];\r
 228     }\r
 229 \r
 230     private int checkPath(HttpServletRequest req) {\r
 231         String path = req.getPathInfo();\r
 232         if (path == null || path.length() < 2) {\r
 233             return -1;\r
 234         }\r
 235         path = path.substring(1);\r
 236         int ix = path.indexOf('/');\r
 237         if (ix < 0 || ix == path.length() - 1) {\r
 238             return -2;\r
 239         }\r
 240         try {\r
 241             int feedid = Integer.parseInt(path.substring(0, ix));\r
 242             String provData = Poker.getPoker().getProvisioningString();\r
 243             JSONArray feeds = new JSONObject(provData).getJSONArray("feeds");\r
 244             for (int n = 0; n < feeds.length(); ++n) {\r
 245                 if (feeds.getJSONObject(n).getInt("feedid") == feedid) {\r
 246                     return feedid;\r
 247                 }\r
 248             }\r
 249             return -1;\r
 250         } catch (NumberFormatException | JSONException e) {\r
 251             intlogger.debug("PROV0152 PublishServlet.checkPath: " + e.getMessage(), e);\r
 252             return -1;\r
 253         }\r
 254     }\r
 255 }\r