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