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