datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/DRFeedsServlet.java

   1 /*******************************************************************************
   2  * ============LICENSE_START==================================================
   3  * * org.onap.dmaap
   4  * * ===========================================================================
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * * ===========================================================================
   7  * * Licensed under the Apache License, Version 2.0 (the "License");
   8  * * you may not use this file except in compliance with the License.
   9  * * You may obtain a copy of the License at
  10  * *
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0
  12  * *
  13  *  * Unless required by applicable law or agreed to in writing, software
  14  * * distributed under the License is distributed on an "AS IS" BASIS,
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * * See the License for the specific language governing permissions and
  17  * * limitations under the License.
  18  * * ============LICENSE_END====================================================
  19  * *
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  * *
  22  ******************************************************************************/
  23
  24
  25 package org.onap.dmaap.datarouter.provisioning;
  26
  27 import java.io.IOException;
  28 import java.io.InvalidObjectException;
  29 import java.util.List;
  30
  31 import javax.servlet.http.HttpServletRequest;
  32 import javax.servlet.http.HttpServletResponse;
  33
  34 import org.json.JSONObject;
  35 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
  36 import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;
  37 import org.onap.dmaap.datarouter.provisioning.beans.Feed;
  38 import org.onap.dmaap.datarouter.provisioning.eelf.EelfMsgs;
  39 import org.onap.dmaap.datarouter.provisioning.utils.JSONUtilities;
  40
  41 import com.att.eelf.configuration.EELFLogger;
  42 import com.att.eelf.configuration.EELFManager;
  43
  44 import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;
  45
  46 /**
  47  * This servlet handles provisioning for the &lt;drFeedsURL&gt; which is the URL on the provisioning server used to
  48  * create new feeds.  It supports POST to create new feeds, and GET to support the Feeds Collection Query function.
  49  *
  50  * @author Robert Eby
  51  * @version $Id$
  52  */
  53 @SuppressWarnings("serial")
  54 public class DRFeedsServlet extends ProxyServlet {
  55
  56     //Adding EELF Logger Rally:US664892
  57     private static EELFLogger eelflogger = EELFManager.getInstance()
  58         .getLogger("org.onap.dmaap.datarouter.provisioning.DRFeedsServlet");
  59
  60     /**
  61      * DELETE on the &lt;drFeedsURL&gt; -- not supported.
  62      */
  63     @Override
  64     public void doDelete(HttpServletRequest req, HttpServletResponse resp) {
  65         setIpAndFqdnForEelf("doDelete");
  66         eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
  67         String message = "DELETE not allowed for the drFeedsURL.";
  68         EventLogRecord elr = new EventLogRecord(req);
  69         elr.setMessage(message);
  70         elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
  71         eventlogger.info(elr);
  72         sendResponseError(resp, HttpServletResponse.SC_METHOD_NOT_ALLOWED, message, eventlogger);
  73     }
  74
  75     /**
  76      * GET on the &lt;drFeedsURL&gt; -- query the list of feeds already existing in the DB. See the <i>Feeds Collection
  77      * Queries</i> section in the <b>Provisioning API</b> document for details on how this method should be invoked.
  78      */
  79     @Override
  80     public void doGet(HttpServletRequest req, HttpServletResponse resp) {
  81         setIpAndFqdnForEelf("doGet");
  82         eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
  83         EventLogRecord elr = new EventLogRecord(req);
  84         String message = isAuthorizedForProvisioning(req);
  85         if (message != null) {
  86             elr.setMessage(message);
  87             elr.setResult(HttpServletResponse.SC_FORBIDDEN);
  88             eventlogger.info(elr);
  89             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
  90             return;
  91         }
  92         if (isProxyServer()) {
  93             super.doGet(req, resp);
  94             return;
  95         }
  96         String bhdr = req.getHeader(BEHALF_HEADER);
  97         if (bhdr == null) {
  98             message = "Missing " + BEHALF_HEADER + " header.";
  99             elr.setMessage(message);
 100             elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 101             eventlogger.info(elr);
 102             sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 103             return;
 104         }
 105         String path = req
 106             .getRequestURI(); // Note: I think this should be getPathInfo(), but that doesn't work (Jetty bug?)
 107         if (path != null && !path.equals("/")) {
 108             message = "Bad URL.";
 109             elr.setMessage(message);
 110             elr.setResult(HttpServletResponse.SC_NOT_FOUND);
 111             eventlogger.info(elr);
 112             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
 113             return;
 114         }
 115         // Check with the Authorizer
 116         AuthorizationResponse aresp = authz.decide(req);
 117         if (!aresp.isAuthorized()) {
 118             message = "Policy Engine disallows access.";
 119             elr.setMessage(message);
 120             elr.setResult(HttpServletResponse.SC_FORBIDDEN);
 121             eventlogger.info(elr);
 122             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
 123             return;
 124         }
 125
 126         String name = req.getParameter("name");
 127         String vers = req.getParameter("version");
 128         String publ = req.getParameter("publisher");
 129         String subs = req.getParameter("subscriber");
 130         if (name != null && vers != null) {
 131             // Display a specific feed
 132             Feed feed = Feed.getFeedByNameVersion(name, vers);
 133             if (feed == null || feed.isDeleted()) {
 134                 message = "This feed does not exist in the database.";
 135                 elr.setMessage(message);
 136                 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 137                 eventlogger.info(elr);
 138                 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 139             } else {
 140                 // send response
 141                 elr.setResult(HttpServletResponse.SC_OK);
 142                 eventlogger.info(elr);
 143                 resp.setStatus(HttpServletResponse.SC_OK);
 144                 resp.setContentType(FEEDFULL_CONTENT_TYPE);
 145                 try {
 146                     resp.getOutputStream().print(feed.asJSONObject(true).toString());
 147                 } catch (IOException ioe) {
 148                     eventlogger.error("IOException" + ioe.getMessage());
 149                 }
 150             }
 151         } else {
 152             // Display a list of URLs
 153             List<String> list = null;
 154             if (name != null) {
 155                 list = Feed.getFilteredFeedUrlList("name", name);
 156             } else if (publ != null) {
 157                 list = Feed.getFilteredFeedUrlList("publ", publ);
 158             } else if (subs != null) {
 159                 list = Feed.getFilteredFeedUrlList("subs", subs);
 160             } else {
 161                 list = Feed.getFilteredFeedUrlList("all", null);
 162             }
 163             String t = JSONUtilities.createJSONArray(list);
 164             // send response
 165             elr.setResult(HttpServletResponse.SC_OK);
 166             eventlogger.info(elr);
 167             resp.setStatus(HttpServletResponse.SC_OK);
 168             resp.setContentType(FEEDLIST_CONTENT_TYPE);
 169             try {
 170                 resp.getOutputStream().print(t);
 171             } catch (IOException ioe) {
 172                 eventlogger.error("IOException" + ioe.getMessage());
 173             }
 174         }
 175     }
 176
 177     /**
 178      * PUT on the &lt;drFeedsURL&gt; -- not supported.
 179      */
 180     @Override
 181     public void doPut(HttpServletRequest req, HttpServletResponse resp) {
 182         setIpAndFqdnForEelf("doPut");
 183         eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
 184         String message = "PUT not allowed for the drFeedsURL.";
 185         EventLogRecord elr = new EventLogRecord(req);
 186         elr.setMessage(message);
 187         elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
 188         eventlogger.info(elr);
 189         sendResponseError(resp, HttpServletResponse.SC_METHOD_NOT_ALLOWED, message, eventlogger);
 190     }
 191
 192     /**
 193      * POST on the &lt;drFeedsURL&gt; -- create a new feed. See the <i>Creating a Feed</i> section in the
 194      * <b>Provisioning API</b> document for details on how this method should be invoked.
 195      */
 196     @Override
 197     public void doPost(HttpServletRequest req, HttpServletResponse resp) {
 198         setIpAndFqdnForEelf("doPost");
 199         eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF, req.getHeader(BEHALF_HEADER));
 200         EventLogRecord elr = new EventLogRecord(req);
 201         String message = isAuthorizedForProvisioning(req);
 202         if (message != null) {
 203             elr.setMessage(message);
 204             elr.setResult(HttpServletResponse.SC_FORBIDDEN);
 205             eventlogger.info(elr);
 206             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
 207             return;
 208         }
 209         if (isProxyServer()) {
 210             super.doPost(req, resp);
 211             return;
 212         }
 213         String bhdr = req.getHeader(BEHALF_HEADER);
 214         if (bhdr == null) {
 215             message = "Missing " + BEHALF_HEADER + " header.";
 216             elr.setMessage(message);
 217             elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 218             eventlogger.info(elr);
 219             sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 220             return;
 221         }
 222         String path = req
 223             .getRequestURI(); // Note: I think this should be getPathInfo(), but that doesn't work (Jetty bug?)
 224         if (path != null && !path.equals("/")) {
 225             message = "Bad URL.";
 226             elr.setMessage(message);
 227             elr.setResult(HttpServletResponse.SC_NOT_FOUND);
 228             eventlogger.info(elr);
 229             sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
 230             return;
 231         }
 232         // check content type is FEED_CONTENT_TYPE, version 1.0
 233         ContentHeader ch = getContentHeader(req);
 234         String ver = ch.getAttribute("version");
 235         if (!ch.getType().equals(FEED_BASECONTENT_TYPE) || !(ver.equals("1.0") || ver.equals("2.0"))) {
 236             message = "Incorrect content-type";
 237             elr.setMessage(message);
 238             elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);
 239             eventlogger.info(elr);
 240             sendResponseError(resp, HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, message, eventlogger);
 241             return;
 242         }
 243         // Check with the Authorizer
 244         AuthorizationResponse aresp = authz.decide(req);
 245         if (!aresp.isAuthorized()) {
 246             message = "Policy Engine disallows access.";
 247             elr.setMessage(message);
 248             elr.setResult(HttpServletResponse.SC_FORBIDDEN);
 249             eventlogger.info(elr);
 250             sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
 251             return;
 252         }
 253         JSONObject jo = getJSONfromInput(req);
 254         if (jo == null) {
 255             message = "Badly formed JSON";
 256             elr.setMessage(message);
 257             elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 258             eventlogger.info(elr);
 259             sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 260             return;
 261         }
 262         if (intlogger.isDebugEnabled()) {
 263             intlogger.debug(jo.toString());
 264         }
 265         if (++activeFeeds > maxFeeds) {
 266             activeFeeds--;
 267             message = "Cannot create feed; the maximum number of feeds has been configured.";
 268             elr.setMessage(message);
 269             elr.setResult(HttpServletResponse.SC_CONFLICT);
 270             eventlogger.info(elr);
 271             sendResponseError(resp, HttpServletResponse.SC_CONFLICT, message, eventlogger);
 272             return;
 273         }
 274         Feed feed = null;
 275         try {
 276             feed = new Feed(jo);
 277         } catch (InvalidObjectException e) {
 278             message = e.getMessage();
 279             elr.setMessage(message);
 280             elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 281             eventlogger.info(elr);
 282             sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 283             return;
 284         }
 285         feed.setPublisher(bhdr);    // set from X-ATT-DR-ON-BEHALF-OF header
 286
 287         // Check if this feed already exists
 288         Feed feed2 = Feed.getFeedByNameVersion(feed.getName(), feed.getVersion());
 289         if (feed2 != null) {
 290             message = "This feed already exists in the database.";
 291             elr.setMessage(message);
 292             elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
 293             eventlogger.info(elr);
 294             sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
 295             return;
 296         }
 297
 298         // Create FEED table entries
 299         if (doInsert(feed)) {
 300             // send response
 301             elr.setResult(HttpServletResponse.SC_CREATED);
 302             eventlogger.info(elr);
 303             resp.setStatus(HttpServletResponse.SC_CREATED);
 304             resp.setContentType(FEEDFULL_CONTENT_TYPE);
 305             resp.setHeader("Location", feed.getLinks().getSelf());
 306             try {
 307                 resp.getOutputStream().print(feed.asLimitedJSONObject().toString());
 308             } catch (IOException ioe) {
 309                 eventlogger.error("IOException" + ioe.getMessage());
 310             }
 311             provisioningDataChanged();
 312         } else {
 313             // Something went wrong with the INSERT
 314             elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
 315             eventlogger.info(elr);
 316             sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, eventlogger);
 317         }
 318     }
 319 }