Update project structure to org.onap
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / provisioning / SubscribeServlet.java
diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscribeServlet.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/SubscribeServlet.java
new file mode 100644 (file)
index 0000000..7196780
--- /dev/null
@@ -0,0 +1,288 @@
+/*******************************************************************************\r
+ * ============LICENSE_START==================================================\r
+ * * org.onap.dmaap\r
+ * * ===========================================================================\r
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * * ===========================================================================\r
+ * * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * * you may not use this file except in compliance with the License.\r
+ * * You may obtain a copy of the License at\r
+ * * \r
+ *  *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * * \r
+ *  * Unless required by applicable law or agreed to in writing, software\r
+ * * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * * See the License for the specific language governing permissions and\r
+ * * limitations under the License.\r
+ * * ============LICENSE_END====================================================\r
+ * *\r
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+ * *\r
+ ******************************************************************************/\r
+\r
+\r
+package org.onap.dmaap.datarouter.provisioning;\r
+\r
+import java.io.IOException;\r
+import java.io.InvalidObjectException;\r
+import java.util.Collection;\r
+\r
+import javax.servlet.http.HttpServletRequest;\r
+import javax.servlet.http.HttpServletResponse;\r
+\r
+import org.json.JSONObject;\r
+import org.onap.dmaap.datarouter.authz.AuthorizationResponse;\r
+import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;\r
+import org.onap.dmaap.datarouter.provisioning.beans.Feed;\r
+import org.onap.dmaap.datarouter.provisioning.beans.Subscription;\r
+import org.onap.dmaap.datarouter.provisioning.eelf.EelfMsgs;\r
+import org.onap.dmaap.datarouter.provisioning.utils.JSONUtilities;\r
+\r
+import com.att.eelf.configuration.EELFLogger;\r
+import com.att.eelf.configuration.EELFManager;\r
+\r
+/**\r
+ * This servlet handles provisioning for the <subscribeURL> which is generated by the provisioning\r
+ * server to handle the creation and inspection of subscriptions to a specific feed.\r
+ *\r
+ * @author Robert Eby\r
+ * @version $Id$\r
+ */\r
+@SuppressWarnings("serial")\r
+public class SubscribeServlet extends ProxyServlet {\r
+       \r
+       //Adding EELF Logger Rally:US664892  \r
+    private static EELFLogger eelflogger = EELFManager.getInstance().getLogger("org.onap.dmaap.datarouter.provisioning.SubscribeServlet");\r
+\r
+       /**\r
+        * DELETE on the <subscribeUrl> -- not supported.\r
+        */\r
+       @Override\r
+       public void doDelete(HttpServletRequest req, HttpServletResponse resp) throws IOException {\r
+               setIpAndFqdnForEelf("doDelete");\r
+               eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER),getIdFromPath(req)+"");\r
+               String message = "DELETE not allowed for the subscribeURL.";\r
+               EventLogRecord elr = new EventLogRecord(req);\r
+               elr.setMessage(message);\r
+               elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);\r
+               eventlogger.info(elr);\r
+               resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, message);\r
+       }\r
+       /**\r
+        * GET on the <subscribeUrl> -- get the list of subscriptions to a feed.\r
+        * See the <i>Subscription Collection Query</i> section in the <b>Provisioning API</b>\r
+        * document for details on how this method should be invoked.\r
+        */\r
+       @Override\r
+       public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {\r
+               setIpAndFqdnForEelf("doGet");\r
+               eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER),getIdFromPath(req)+"");\r
+               EventLogRecord elr = new EventLogRecord(req);\r
+               String message = isAuthorizedForProvisioning(req);\r
+               if (message != null) {\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);\r
+                       return;\r
+               }\r
+               if (isProxyServer()) {\r
+                       super.doGet(req, resp);\r
+                       return;\r
+               }\r
+               String bhdr = req.getHeader(BEHALF_HEADER);\r
+               if (bhdr == null) {\r
+                       message = "Missing "+BEHALF_HEADER+" header.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               int feedid = getIdFromPath(req);\r
+               if (feedid < 0) {\r
+                       message = "Missing or bad feed number.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               Feed feed = Feed.getFeedById(feedid);\r
+               if (feed == null || feed.isDeleted()) {\r
+                       message = "Missing or bad feed number.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_NOT_FOUND, message);\r
+                       return;\r
+               }\r
+               // Check with the Authorizer\r
+               AuthorizationResponse aresp = authz.decide(req);\r
+               if (! aresp.isAuthorized()) {\r
+                       message = "Policy Engine disallows access.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);\r
+                       return;\r
+               }\r
+\r
+               // Display a list of URLs\r
+               Collection<String> list = Subscription.getSubscriptionUrlList(feedid);\r
+               String t = JSONUtilities.createJSONArray(list);\r
+\r
+               // send response\r
+               elr.setResult(HttpServletResponse.SC_OK);\r
+               eventlogger.info(elr);\r
+               resp.setStatus(HttpServletResponse.SC_OK);\r
+               resp.setContentType(SUBLIST_CONTENT_TYPE);\r
+               resp.getOutputStream().print(t);\r
+       }\r
+       /**\r
+        * PUT on the &lt;subscribeUrl&gt; -- not supported.\r
+        */\r
+       @Override\r
+       public void doPut(HttpServletRequest req, HttpServletResponse resp) throws IOException {\r
+               setIpAndFqdnForEelf("doPut");\r
+               eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID, req.getHeader(BEHALF_HEADER),getIdFromPath(req)+"");\r
+               String message = "PUT not allowed for the subscribeURL.";\r
+               EventLogRecord elr = new EventLogRecord(req);\r
+               elr.setMessage(message);\r
+               elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);\r
+               eventlogger.info(elr);\r
+               resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, message);\r
+       }\r
+       /**\r
+        * POST on the &lt;subscribeUrl&gt; -- create a new subscription to a feed.\r
+        * See the <i>Creating a Subscription</i> section in the <b>Provisioning API</b>\r
+        * document for details on how this method should be invoked.\r
+        */\r
+       @Override\r
+       public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {\r
+               setIpAndFqdnForEelf("doPost");\r
+               eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF, req.getHeader(BEHALF_HEADER));\r
+               EventLogRecord elr = new EventLogRecord(req);\r
+               String message = isAuthorizedForProvisioning(req);\r
+               if (message != null) {\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);\r
+                       return;\r
+               }\r
+               if (isProxyServer()) {\r
+                       super.doPost(req, resp);\r
+                       return;\r
+               }\r
+               String bhdr = req.getHeader(BEHALF_HEADER);\r
+               if (bhdr == null) {\r
+                       message = "Missing "+BEHALF_HEADER+" header.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               int feedid = getIdFromPath(req);\r
+               if (feedid < 0) {\r
+                       message = "Missing or bad feed number.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               Feed feed = Feed.getFeedById(feedid);\r
+               if (feed == null || feed.isDeleted()) {\r
+                       message = "Missing or bad feed number.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_NOT_FOUND);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_NOT_FOUND, message);\r
+                       return;\r
+               }\r
+               // Check with the Authorizer\r
+               AuthorizationResponse aresp = authz.decide(req);\r
+               if (! aresp.isAuthorized()) {\r
+                       message = "Policy Engine disallows access.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_FORBIDDEN);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_FORBIDDEN, message);\r
+                       return;\r
+               }\r
+\r
+               // check content type is SUB_CONTENT_TYPE, version 1.0\r
+               ContentHeader ch = getContentHeader(req);\r
+               String ver = ch.getAttribute("version");\r
+               if (!ch.getType().equals(SUB_BASECONTENT_TYPE) || !(ver.equals("1.0") || ver.equals("2.0"))) {\r
+                       intlogger.debug("Content-type is: "+req.getHeader("Content-Type"));\r
+                       message = "Incorrect content-type";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, message);\r
+                       return;\r
+               }\r
+               JSONObject jo = getJSONfromInput(req);\r
+               if (jo == null) {\r
+                       message = "Badly formed JSON";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               if (intlogger.isDebugEnabled())\r
+                       intlogger.debug(jo.toString());\r
+               if (++active_subs > max_subs) {\r
+                       active_subs--;\r
+                       message = "Cannot create subscription; the maximum number of subscriptions has been configured.";\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_CONFLICT);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_CONFLICT, message);\r
+                       return;\r
+               }\r
+               Subscription sub = null;\r
+               try {\r
+                       sub = new Subscription(jo);\r
+               } catch (InvalidObjectException e) {\r
+                       active_subs--;\r
+                       message = e.getMessage();\r
+                       elr.setMessage(message);\r
+                       elr.setResult(HttpServletResponse.SC_BAD_REQUEST);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_BAD_REQUEST, message);\r
+                       return;\r
+               }\r
+               sub.setFeedid(feedid);\r
+               sub.setSubscriber(bhdr);        // set from X-ATT-DR-ON-BEHALF-OF header\r
+\r
+               // Check if this subscription already exists; not an error (yet), just warn\r
+               Subscription sub2 = Subscription.getSubscriptionMatching(sub);\r
+               if (sub2 != null)\r
+                       intlogger.warn("PROV0011 Creating a duplicate subscription: new subid="+sub.getSubid()+", old subid="+sub2.getSubid());\r
+\r
+               // Create SUBSCRIPTIONS table entries\r
+               if (doInsert(sub)) {\r
+                       // send response\r
+                       elr.setResult(HttpServletResponse.SC_CREATED);\r
+                       eventlogger.info(elr);\r
+                       resp.setStatus(HttpServletResponse.SC_CREATED);\r
+                       resp.setContentType(SUBFULL_CONTENT_TYPE);\r
+                       resp.setHeader("Location", sub.getLinks().getSelf());\r
+                       resp.getOutputStream().print(sub.asLimitedJSONObject().toString());\r
+\r
+                       provisioningDataChanged();\r
+               } else {\r
+                       // Something went wrong with the INSERT\r
+                       active_subs--;\r
+                       elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);\r
+                       eventlogger.info(elr);\r
+                       resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG);\r
+               }\r
+       }\r
+}\r