1 /*******************************************************************************
\r
2 * ============LICENSE_START==================================================
\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
11 * * http://www.apache.org/licenses/LICENSE-2.0
\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
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
\r
22 ******************************************************************************/
\r
25 package org.onap.dmaap.datarouter.provisioning;
\r
27 import static org.onap.dmaap.datarouter.provisioning.utils.HttpServletUtils.sendResponseError;
\r
29 import com.att.eelf.configuration.EELFLogger;
\r
30 import com.att.eelf.configuration.EELFManager;
\r
31 import java.io.IOException;
\r
32 import java.io.InvalidObjectException;
\r
33 import java.net.HttpURLConnection;
\r
34 import java.net.URL;
\r
35 import java.util.ArrayList;
\r
36 import java.util.List;
\r
37 import jakarta.servlet.http.HttpServletRequest;
\r
38 import jakarta.servlet.http.HttpServletResponse;
\r
39 import org.json.JSONException;
\r
40 import org.json.JSONObject;
\r
41 import org.onap.dmaap.datarouter.authz.AuthorizationResponse;
\r
42 import org.onap.dmaap.datarouter.provisioning.beans.EventLogRecord;
\r
43 import org.onap.dmaap.datarouter.provisioning.beans.Subscription;
\r
44 import org.onap.dmaap.datarouter.provisioning.eelf.EelfMsgs;
\r
45 import org.onap.dmaap.datarouter.provisioning.utils.SynchronizerTask;
\r
48 * This servlet handles provisioning for the <subscriptionURL> which is generated by the provisioning server to
\r
49 * handle the inspection, modification, and deletion of a particular subscription to a feed. It supports DELETE to
\r
50 * delete a subscription, GET to retrieve information about the subscription, and PUT to modify the subscription. In DR
\r
51 * 3.0, POST is also supported in order to reset the subscription timers for individual subscriptions.
\r
53 * @author Robert Eby
\r
56 public class SubscriptionServlet extends ProxyServlet {
\r
58 private static final String SUBCNTRL_CONTENT_TYPE = "application/vnd.dmaap-dr.subscription-control";
\r
59 //Adding EELF Logger Rally:US664892
\r
60 private static final EELFLogger eelfLogger = EELFManager.getInstance()
\r
61 .getLogger(SubscriptionServlet.class);
\r
64 * DELETE on the <subscriptionUrl> -- delete a subscription. See the <i>Deleting a Subscription</i> section in
\r
65 * the <b>Provisioning API</b> document for details on how this method should be invoked.
\r
68 public void doDelete(HttpServletRequest req, HttpServletResponse resp) {
\r
69 setIpFqdnRequestIDandInvocationIDForEelf("doDelete", req);
\r
70 eelfLogger.info(EelfMsgs.ENTRY);
\r
72 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,
\r
73 req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
\r
74 EventLogRecord elr = new EventLogRecord(req);
\r
75 String message = isAuthorizedForProvisioning(req);
\r
76 if (message != null) {
\r
77 elr.setMessage(message);
\r
78 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
79 eventlogger.error(elr.toString());
\r
80 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
83 if (isProxyServer()) {
\r
84 super.doDelete(req, resp);
\r
87 String bhdr = req.getHeader(BEHALF_HEADER);
\r
89 message = MISSING_ON_BEHALF;
\r
90 elr.setMessage(message);
\r
91 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
92 eventlogger.error(elr.toString());
\r
93 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
96 int subid = getIdFromPath(req);
\r
99 elr.setMessage(message);
\r
100 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
101 eventlogger.error(elr.toString());
\r
102 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
105 Subscription sub = Subscription.getSubscriptionById(subid);
\r
108 elr.setMessage(message);
\r
109 elr.setResult(HttpServletResponse.SC_NOT_FOUND);
\r
110 eventlogger.error(elr.toString());
\r
111 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
\r
114 // Delete Subscription
\r
115 if (doDelete(sub)) {
\r
118 elr.setResult(HttpServletResponse.SC_NO_CONTENT);
\r
119 eventlogger.info(elr.toString());
\r
120 resp.setStatus(HttpServletResponse.SC_NO_CONTENT);
\r
121 provisioningDataChanged();
\r
123 // Something went wrong with the DELETE
\r
124 elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
\r
125 eventlogger.error(elr.toString());
\r
126 sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, intlogger);
\r
129 eelfLogger.info(EelfMsgs.EXIT);
\r
134 * GET on the <subscriptionUrl> -- get information about a subscription. See the <i>Retreiving Information
\r
135 * about a Subscription</i> section in the <b>Provisioning API</b> document for details on how this method should be
\r
139 public void doGet(HttpServletRequest req, HttpServletResponse resp) {
\r
140 setIpFqdnRequestIDandInvocationIDForEelf("doGet", req);
\r
141 eelfLogger.info(EelfMsgs.ENTRY);
\r
143 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,
\r
144 req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
\r
145 EventLogRecord elr = new EventLogRecord(req);
\r
146 String message = isAuthorizedForProvisioning(req);
\r
147 if (message != null) {
\r
148 elr.setMessage(message);
\r
149 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
150 eventlogger.error(elr.toString());
\r
151 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
154 if (isProxyServer()) {
\r
155 super.doGet(req, resp);
\r
158 String bhdr = req.getHeader(BEHALF_HEADER);
\r
159 if (bhdr == null) {
\r
160 message = MISSING_ON_BEHALF;
\r
161 elr.setMessage(message);
\r
162 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
163 eventlogger.error(elr.toString());
\r
164 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
167 int subid = getIdFromPath(req);
\r
170 elr.setMessage(message);
\r
171 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
172 eventlogger.error(elr.toString());
\r
173 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
176 Subscription sub = Subscription.getSubscriptionById(subid);
\r
179 elr.setMessage(message);
\r
180 elr.setResult(HttpServletResponse.SC_NOT_FOUND);
\r
181 eventlogger.error(elr.toString());
\r
182 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
\r
185 // Check with the Authorizer
\r
186 AuthorizationResponse aresp = authz.decide(req);
\r
187 if (!aresp.isAuthorized()) {
\r
188 message = POLICY_ENGINE;
\r
189 elr.setMessage(message);
\r
190 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
191 eventlogger.error(elr.toString());
\r
192 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
197 elr.setResult(HttpServletResponse.SC_OK);
\r
198 eventlogger.info(elr.toString());
\r
199 resp.setStatus(HttpServletResponse.SC_OK);
\r
200 resp.setContentType(SUBFULL_CONTENT_TYPE);
\r
202 resp.getOutputStream().print(sub.asJSONObject(true).toString());
\r
203 } catch (IOException ioe) {
\r
204 eventlogger.error("PROV0191 SubscriptionServlet.doGet: " + ioe.getMessage(), ioe);
\r
207 eelfLogger.info(EelfMsgs.EXIT);
\r
212 * PUT on the <subscriptionUrl> -- modify a subscription. See the <i>Modifying a Subscription</i> section in
\r
213 * the <b>Provisioning API</b> document for details on how this method should be invoked.
\r
216 public void doPut(HttpServletRequest req, HttpServletResponse resp) {
\r
217 setIpFqdnRequestIDandInvocationIDForEelf("doPut", req);
\r
218 eelfLogger.info(EelfMsgs.ENTRY);
\r
220 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF_AND_SUBID,
\r
221 req.getHeader(BEHALF_HEADER), getIdFromPath(req) + "");
\r
222 EventLogRecord elr = new EventLogRecord(req);
\r
223 String message = isAuthorizedForProvisioning(req);
\r
224 if (message != null) {
\r
225 elr.setMessage(message);
\r
226 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
227 eventlogger.error(elr.toString());
\r
228 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
231 if (isProxyServer()) {
\r
232 super.doPut(req, resp);
\r
235 String bhdr = req.getHeader(BEHALF_HEADER);
\r
236 if (bhdr == null) {
\r
237 message = MISSING_ON_BEHALF;
\r
238 elr.setMessage(message);
\r
239 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
240 eventlogger.error(elr.toString());
\r
241 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
244 int subid = getIdFromPath(req);
\r
247 elr.setMessage(message);
\r
248 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
249 eventlogger.error(elr.toString());
\r
250 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
253 Subscription oldsub = Subscription.getSubscriptionById(subid);
\r
254 if (oldsub == null) {
\r
256 elr.setMessage(message);
\r
257 elr.setResult(HttpServletResponse.SC_NOT_FOUND);
\r
258 eventlogger.error(elr.toString());
\r
259 sendResponseError(resp, HttpServletResponse.SC_NOT_FOUND, message, eventlogger);
\r
262 // check content type is SUB_CONTENT_TYPE, version 1.0
\r
263 ContentHeader ch = getContentHeader(req);
\r
264 String ver = ch.getAttribute("version");
\r
265 if (!ch.getType().equals(SUB_BASECONTENT_TYPE) || !("1.0".equals(ver) || "2.0".equals(ver))) {
\r
266 message = "Incorrect content-type";
\r
267 elr.setMessage(message);
\r
268 elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);
\r
269 eventlogger.error(elr.toString());
\r
270 sendResponseError(resp, HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, message, eventlogger);
\r
273 JSONObject jo = getJSONfromInput(req);
\r
275 message = BAD_JSON;
\r
276 elr.setMessage(message);
\r
277 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
278 eventlogger.error(elr.toString());
\r
279 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
284 sub = new Subscription(jo);
\r
285 } catch (InvalidObjectException e) {
\r
286 message = e.getMessage();
\r
287 elr.setMessage(message);
\r
288 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
289 eventlogger.error(elr.toString(), e);
\r
290 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
293 sub.setSubid(oldsub.getSubid());
\r
294 sub.setFeedid(oldsub.getFeedid());
\r
295 sub.setSubscriber(bhdr); // set from X-DMAAP-DR-ON-BEHALF-OF header
\r
296 //Adding for group feature:Rally US708115
\r
297 String subjectgroup = (req.getHeader("X-DMAAP-DR-ON-BEHALF-OF-GROUP"));
\r
298 if (!oldsub.getSubscriber().equals(sub.getSubscriber()) && subjectgroup == null) {
\r
299 message = "This subscriber must be modified by the same subscriber that created it.";
\r
300 elr.setMessage(message);
\r
301 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
302 eventlogger.error(elr.toString());
\r
303 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
307 // Update SUBSCRIPTIONS table entries
\r
308 if (doUpdate(sub)) {
\r
310 elr.setResult(HttpServletResponse.SC_OK);
\r
311 eventlogger.info(elr.toString());
\r
312 resp.setStatus(HttpServletResponse.SC_OK);
\r
313 resp.setContentType(SUBFULL_CONTENT_TYPE);
\r
315 resp.getOutputStream().print(sub.asLimitedJSONObject().toString());
\r
316 } catch (IOException ioe) {
\r
317 eventlogger.error("PROV0192 SubscriptionServlet.doPut: " + ioe.getMessage(), ioe);
\r
320 /**Change Owner ship of Subscriber. Adding for group feature:Rally US708115*/
\r
321 if (jo.has("changeowner") && subjectgroup != null) {
\r
323 Boolean changeowner = (Boolean) jo.get("changeowner");
\r
324 if (changeowner != null && changeowner.equals(true)) {
\r
325 sub.setSubscriber(req.getHeader(BEHALF_HEADER));
\r
326 sub.changeOwnerShip();
\r
328 } catch (JSONException je) {
\r
329 eventlogger.error("PROV0193 SubscriptionServlet.doPut: " + je.getMessage(), je);
\r
332 /***End of change ownership.*/
\r
334 provisioningDataChanged();
\r
336 // Something went wrong with the UPDATE
\r
337 elr.setResult(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
\r
338 eventlogger.error(elr.toString());
\r
339 sendResponseError(resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR, DB_PROBLEM_MSG, intlogger);
\r
342 eelfLogger.info(EelfMsgs.EXIT);
\r
347 * POST on the <subscriptionUrl> -- control a subscription. See the <i>Resetting a Subscription's Retry
\r
348 * Schedule</i> section in the <b>Provisioning API</b> document for details on how this method should be invoked.
\r
351 public void doPost(HttpServletRequest req, HttpServletResponse resp) {
\r
353 setIpFqdnRequestIDandInvocationIDForEelf("doPost", req);
\r
354 eelfLogger.info(EelfMsgs.ENTRY);
\r
356 eelfLogger.info(EelfMsgs.MESSAGE_WITH_BEHALF, req.getHeader(BEHALF_HEADER));
\r
357 EventLogRecord elr = new EventLogRecord(req);
\r
358 String message = isAuthorizedForProvisioning(req);
\r
359 if (message != null) {
\r
360 elr.setMessage(message);
\r
361 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
362 eventlogger.error(elr.toString());
\r
363 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
366 if (isProxyServer()) {
\r
367 super.doPost(req, resp);
\r
370 String bhdr = req.getHeader(BEHALF_HEADER);
\r
371 if (bhdr == null) {
\r
372 message = MISSING_ON_BEHALF;
\r
373 elr.setMessage(message);
\r
374 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
375 eventlogger.error(elr.toString());
\r
376 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
379 final int subid = getIdFromPath(req);
\r
380 if (subid < 0 || Subscription.getSubscriptionById(subid) == null) {
\r
382 elr.setMessage(message);
\r
383 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
384 eventlogger.error(elr.toString());
\r
385 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
388 // check content type is SUBCNTRL_CONTENT_TYPE, version 1.0
\r
389 ContentHeader ch = getContentHeader(req);
\r
390 String ver = ch.getAttribute("version");
\r
391 if (!ch.getType().equals(SUBCNTRL_CONTENT_TYPE) || !"1.0".equals(ver)) {
\r
392 message = "Incorrect content-type";
\r
393 elr.setMessage(message);
\r
394 elr.setResult(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE);
\r
395 eventlogger.error(elr.toString());
\r
396 sendResponseError(resp, HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, message, eventlogger);
\r
399 // Check with the Authorizer
\r
400 AuthorizationResponse aresp = authz.decide(req);
\r
401 if (!aresp.isAuthorized()) {
\r
402 message = POLICY_ENGINE;
\r
403 elr.setMessage(message);
\r
404 elr.setResult(HttpServletResponse.SC_FORBIDDEN);
\r
405 eventlogger.error(elr.toString());
\r
406 sendResponseError(resp, HttpServletResponse.SC_FORBIDDEN, message, eventlogger);
\r
409 JSONObject jo = getJSONfromInput(req);
\r
411 message = BAD_JSON;
\r
412 elr.setMessage(message);
\r
413 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
414 eventlogger.error(elr.toString());
\r
415 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
419 // Only the active POD sends notifications
\r
420 boolean active = SynchronizerTask.getSynchronizer().isActive();
\r
421 boolean bool = jo.getBoolean("failed");
\r
422 if (active && !bool) {
\r
423 // Notify all nodes to reset the subscription
\r
424 SubscriberNotifyThread thread = new SubscriberNotifyThread();
\r
425 thread.resetSubscription(subid);
\r
429 elr.setResult(HttpServletResponse.SC_ACCEPTED);
\r
430 eventlogger.info(elr.toString());
\r
431 resp.setStatus(HttpServletResponse.SC_ACCEPTED);
\r
432 } catch (JSONException e) {
\r
433 message = BAD_JSON;
\r
434 elr.setMessage(message);
\r
435 elr.setResult(HttpServletResponse.SC_BAD_REQUEST);
\r
436 eventlogger.error(elr.toString(), e);
\r
437 sendResponseError(resp, HttpServletResponse.SC_BAD_REQUEST, message, eventlogger);
\r
440 eelfLogger.info(EelfMsgs.EXIT);
\r
445 * A Thread class used to serially send reset notifications to all nodes in the DR network, when a POST is received
\r
446 * for a subscription.
\r
448 public static class SubscriberNotifyThread extends Thread {
\r
450 static final String URL_TEMPLATE = "http://%s/internal/resetSubscription/%d";
\r
451 private List<String> urls = new ArrayList<>();
\r
453 SubscriberNotifyThread() {
\r
454 setName("SubscriberNotifyThread");
\r
457 void resetSubscription(int subid) {
\r
458 for (String nodename : BaseServlet.getNodes()) {
\r
459 String url = String.format(URL_TEMPLATE, nodename, subid);
\r
465 public void run() {
\r
467 while (!urls.isEmpty()) {
\r
468 String url = urls.remove(0);
\r
469 forceGetThrough(url);
\r
471 } catch (Exception e) {
\r
472 intlogger.warn("PROV0195 Caught exception in SubscriberNotifyThread: " + e.getMessage(), e);
\r
476 private void forceGetThrough(String url) {
\r
478 URL urlObj = new URL(url);
\r
479 HttpURLConnection conn = (HttpURLConnection) urlObj.openConnection();
\r
481 conn.getContentLength(); // Force the GET through
\r
483 } catch (IOException e) {
\r
484 intlogger.info("PROV0194 Error accessing URL: " + url + ": " + e.getMessage(), e);
\r