1 /*******************************************************************************
2 * ============LICENSE_START==================================================
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
11 * * http://www.apache.org/licenses/LICENSE-2.0
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====================================================
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 ******************************************************************************/
25 package org.onap.dmaap.datarouter.provisioning;
27 import java.io.IOException;
28 import java.io.InvalidObjectException;
29 import java.util.List;
31 import javax.servlet.http.HttpServletRequest;
32 import javax.servlet.http.HttpServletResponse;
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;
41 import com.att.eelf.configuration.EELFLogger;
42 import com.att.eelf.configuration.EELFManager;
44 import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;
47 * This servlet handles provisioning for the <drFeedsURL> 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.
53 @SuppressWarnings("serial")
54 public class DRFeedsServlet extends ProxyServlet {
56 //Adding EELF Logger Rally:US664892
57 private static EELFLogger eelflogger = EELFManager.getInstance()
58 .getLogger(DRFeedsServlet.class);
61 * DELETE on the <drFeedsURL> -- not supported.
64 public void doDelete(HttpServletRequest req, HttpServletResponse resp) {
65 setIpFqdnRequestIDandInvocationIDForEelf("doDelete", req);
66 eelflogger.info(EelfMsgs.ENTRY);
68 eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
69 String message = "DELETE not allowed for the drFeedsURL.";
70 EventLogRecord elr = new EventLogRecord(req);
71 elr.setMessage(message);
72 elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
73 eventlogger.info(elr);
74 sendResponseError(resp, HttpServletResponse.SC_METHOD_NOT_ALLOWED, message, eventlogger);
76 eelflogger.info(EelfMsgs.EXIT);
81 * GET on the <drFeedsURL> -- query the list of feeds already existing in the DB. See the <i>Feeds Collection
82 * Queries</i> section in the <b>Provisioning API</b> document for details on how this method should be invoked.
85 public void doGet(HttpServletRequest req, HttpServletResponse resp) {
86 setIpFqdnRequestIDandInvocationIDForEelf("doGet", req);
87 eelflogger.info(EelfMsgs.ENTRY);
89 eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
90 EventLogRecord elr = new EventLogRecord(req);
91 String message = isAuthorizedForProvisioning(req);
92 if (message != null) {
93 elr.setMessage(message);
94 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
95 eventlogger.info(elr);
96 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
99 if (isProxyServer()) {
100 super.doGet(req, resp);
103 String bhdr = req.getHeader(BEHALF_HEADER);
105 message = "Missing " + BEHALF_HEADER + " header.";
106 elr.setMessage(message);
107 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
108 eventlogger.info(elr);
109 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
113 .getRequestURI(); // Note: I think this should be getPathInfo(), but that doesn't work (Jetty bug?)
114 if (path != null && !path.equals("/")) {
115 message = "Bad URL.";
116 elr.setMessage(message);
117 elr.setResult(HttpServletResponse.SC_NOT_FOUND);
118 eventlogger.info(elr);
119 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
122 // Check with the Authorizer
123 AuthorizationResponse aresp = authz.decide(req);
124 if (!aresp.isAuthorized()) {
125 message = "Policy Engine disallows access.";
126 elr.setMessage(message);
127 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
128 eventlogger.info(elr);
129 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
133 String name = req.getParameter("name");
134 String vers = req.getParameter("version");
135 String publ = req.getParameter("publisher");
136 String subs = req.getParameter("subscriber");
137 if (name != null && vers != null) {
138 // Display a specific feed
139 Feed feed = Feed.getFeedByNameVersion(name, vers);
140 if (feed == null || feed.isDeleted()) {
141 message = "This feed does not exist in the database.";
142 elr.setMessage(message);
143 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
144 eventlogger.info(elr);
145 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
148 elr.setResult(HttpServletResponse.SC_OK);
149 eventlogger.info(elr);
150 resp.setStatus(HttpServletResponse.SC_OK);
151 resp.setContentType(FEEDFULL_CONTENT_TYPE);
153 resp.getOutputStream().print(feed.asJSONObject(true).toString());
154 } catch (IOException ioe) {
155 eventlogger.error("IOException" + ioe.getMessage());
159 // Display a list of URLs
160 List<String> list = null;
162 list = Feed.getFilteredFeedUrlList("name", name);
163 } else if (publ != null) {
164 list = Feed.getFilteredFeedUrlList("publ", publ);
165 } else if (subs != null) {
166 list = Feed.getFilteredFeedUrlList("subs", subs);
168 list = Feed.getFilteredFeedUrlList("all", null);
170 String t = JSONUtilities.createJSONArray(list);
172 elr.setResult(HttpServletResponse.SC_OK);
173 eventlogger.info(elr);
174 resp.setStatus(HttpServletResponse.SC_OK);
175 resp.setContentType(FEEDLIST_CONTENT_TYPE);
177 resp.getOutputStream().print(t);
178 } catch (IOException ioe) {
179 eventlogger.error("IOException" + ioe.getMessage());
183 eelflogger.info(EelfMsgs.EXIT);
188 * PUT on the <drFeedsURL> -- not supported.
191 public void doPut(HttpServletRequest req, HttpServletResponse resp) {
192 setIpFqdnRequestIDandInvocationIDForEelf("doPut", req);
193 eelflogger.info(EelfMsgs.ENTRY);
195 eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_FEEDID, req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
196 String message = "PUT not allowed for the drFeedsURL.";
197 EventLogRecord elr = new EventLogRecord(req);
198 elr.setMessage(message);
199 elr.setResult(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
200 eventlogger.info(elr);
201 sendResponseError(resp, HttpServletResponse.SC_METHOD_NOT_ALLOWED, message, eventlogger);
203 eelflogger.info(EelfMsgs.EXIT);
208 * POST on the <drFeedsURL> -- create a new feed. See the <i>Creating a Feed</i> section in the
209 * <b>Provisioning API</b> document for details on how this method should be invoked.
212 public void doPost(HttpServletRequest req, HttpServletResponse resp) {
213 setIpFqdnRequestIDandInvocationIDForEelf("doPost", req);
214 eelflogger.info(EelfMsgs.ENTRY);
216 eelflogger.info(EelfMsgs.MESSAGE_WITH_BEHALF, req.getHeader(BEHALF_HEADER));
217 EventLogRecord elr = new EventLogRecord(req);
218 String message = isAuthorizedForProvisioning(req);
219 if (message != null) {
220 elr.setMessage(message);
221 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
222 eventlogger.info(elr);
223 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
226 if (isProxyServer()) {
227 super.doPost(req, resp);
230 String bhdr = req.getHeader(BEHALF_HEADER);
232 message = "Missing " + BEHALF_HEADER + " header.";
233 elr.setMessage(message);
234 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
235 eventlogger.info(elr);
236 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
240 .getRequestURI(); // Note: I think this should be getPathInfo(), but that doesn't work (Jetty bug?)
241 if (path != null && !path.equals("/")) {
242 message = "Bad URL.";
243 elr.setMessage(message);
244 elr.setResult(HttpServletResponse.SC_NOT_FOUND);
245 eventlogger.info(elr);
246 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
249 // check content type is FEED_CONTENT_TYPE, version 1.0
250 ContentHeader ch = getContentHeader(req);
251 String ver = ch.getAttribute("version");
252 if (!ch.getType().equals(FEED_BASECONTENT_TYPE) || !(ver.equals("1.0") || ver.equals("2.0"))) {
253 message = "Incorrect content-type";
254 elr.setMessage(message);
255 elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);
256 eventlogger.info(elr);
257 sendResponseError(resp, HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, message, eventlogger);
260 // Check with the Authorizer
261 AuthorizationResponse aresp = authz.decide(req);
262 if (!aresp.isAuthorized()) {
263 message = "Policy Engine disallows access.";
264 elr.setMessage(message);
265 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
266 eventlogger.info(elr);
267 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
270 JSONObject jo = getJSONfromInput(req);
272 message = "Badly formed JSON";
273 elr.setMessage(message);
274 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
275 eventlogger.info(elr);
276 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
279 if (intlogger.isDebugEnabled()) {
280 intlogger.debug(jo.toString());
282 if (++activeFeeds > maxFeeds) {
284 message = "Cannot create feed; the maximum number of feeds has been configured.";
285 elr.setMessage(message);
286 elr.setResult(HttpServletResponse.SC_CONFLICT);
287 eventlogger.info(elr);
288 sendResponseError(resp, HttpServletResponse.SC_CONFLICT, message, eventlogger);
294 } catch (InvalidObjectException e) {
295 message = e.getMessage();
296 elr.setMessage(message);
297 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
298 eventlogger.info(elr);
299 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
302 feed.setPublisher(bhdr); // set from X-ATT-DR-ON-BEHALF-OF header
304 // Check if this feed already exists
305 Feed feed2 = Feed.getFeedByNameVersion(feed.getName(), feed.getVersion());
307 message = "This feed already exists in the database.";
308 elr.setMessage(message);
309 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
310 eventlogger.info(elr);
311 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
315 // Create FEED table entries
316 if (doInsert(feed)) {
318 elr.setResult(HttpServletResponse.SC_CREATED);
319 eventlogger.info(elr);
320 resp.setStatus(HttpServletResponse.SC_CREATED);
321 resp.setContentType(FEEDFULL_CONTENT_TYPE);
322 resp.setHeader("Location", feed.getLinks().getSelf());
324 resp.getOutputStream().print(feed.asLimitedJSONObject().toString());
325 } catch (IOException ioe) {
326 eventlogger.error("IOException" + ioe.getMessage());
328 provisioningDataChanged();
330 // Something went wrong with the INSERT
331 elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
332 eventlogger.info(elr);
333 sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, eventlogger);
336 eelflogger.info(EelfMsgs.EXIT);