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 static com.att.eelf.configuration.Configuration.MDC_KEY_REQUEST_ID;
28 import static com.att.eelf.configuration.Configuration.MDC_SERVER_FQDN;
29 import static com.att.eelf.configuration.Configuration.MDC_SERVER_IP_ADDRESS;
30 import static com.att.eelf.configuration.Configuration.MDC_SERVICE_NAME;
32 import com.att.eelf.configuration.EELFLogger;
33 import com.att.eelf.configuration.EELFManager;
34 import java.net.InetAddress;
35 import java.net.UnknownHostException;
36 import java.security.GeneralSecurityException;
37 import java.security.cert.X509Certificate;
38 import java.sql.Connection;
39 import java.sql.SQLException;
40 import java.util.ArrayList;
41 import java.util.HashMap;
42 import java.util.HashSet;
43 import java.util.List;
45 import java.util.Properties;
47 import java.util.UUID;
48 import javax.servlet.ServletConfig;
49 import javax.servlet.ServletException;
50 import javax.servlet.http.HttpServlet;
51 import javax.servlet.http.HttpServletRequest;
52 import org.apache.commons.lang3.StringUtils;
53 import org.jetbrains.annotations.Nullable;
54 import org.json.JSONArray;
55 import org.json.JSONException;
56 import org.json.JSONObject;
57 import org.json.JSONTokener;
58 import org.onap.dmaap.datarouter.authz.Authorizer;
59 import org.onap.dmaap.datarouter.authz.impl.ProvAuthorizer;
60 import org.onap.dmaap.datarouter.authz.impl.ProvDataProvider;
61 import org.onap.dmaap.datarouter.provisioning.beans.Deleteable;
62 import org.onap.dmaap.datarouter.provisioning.beans.Feed;
63 import org.onap.dmaap.datarouter.provisioning.beans.Group;
64 import org.onap.dmaap.datarouter.provisioning.beans.Insertable;
65 import org.onap.dmaap.datarouter.provisioning.beans.NodeClass;
66 import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
67 import org.onap.dmaap.datarouter.provisioning.beans.Subscription;
68 import org.onap.dmaap.datarouter.provisioning.beans.Updateable;
69 import org.onap.dmaap.datarouter.provisioning.utils.DB;
70 import org.onap.dmaap.datarouter.provisioning.utils.PasswordProcessor;
71 import org.onap.dmaap.datarouter.provisioning.utils.ThrottleFilter;
76 * This is the base class for all Servlets in the provisioning code. It provides standard constants and some common
80 * @version $Id: BaseServlet.java,v 1.16 2014/03/12 19:45:40 eby Exp $
82 @SuppressWarnings("serial")
83 public class BaseServlet extends HttpServlet implements ProvDataProvider {
85 public static final String BEHALF_HEADER = "X-DMAAP-DR-ON-BEHALF-OF";
87 public static final String EXCLUDE_AAF_HEADER = "X-EXCLUDE-AAF";
89 private static final String AAF_CADI_FEED_TYPE = "org.onap.dmaap.datarouter.provserver.aaf.feed.type";
90 private static final String AAF_CADI_SUB_TYPE = "org.onap.dmaap.datarouter.provserver.aaf.sub.type";
91 private static final String AAF_INSTANCE = "org.onap.dmaap.datarouter.provserver.aaf.instance";
92 private static final String AAF_CADI_FEED = "org.onap.dmaap-dr.feed";
93 private static final String AAF_CADI_SUB = "org.onap.dmaap-dr.sub";
95 static final String CREATE_PERMISSION = "create";
96 static final String EDIT_PERMISSION = "edit";
97 static final String DELETE_PERMISSION = "delete";
98 private static final String PUBLISH_PERMISSION = "publish";
99 private static final String SUSPEND_PERMISSION = "suspend";
100 private static final String RESTORE_PERMISSION = "restore";
101 private static final String SUBSCRIBE_PERMISSION = "subscribe";
102 static final String APPROVE_SUB_PERMISSION = "approveSub";
104 static final String FEED_BASECONTENT_TYPE = "application/vnd.dmaap-dr.feed";
105 public static final String FEED_CONTENT_TYPE = "application/vnd.dmaap-dr.feed; version=2.0";
106 public static final String FEEDFULL_CONTENT_TYPE = "application/vnd.dmaap-dr.feed-full; version=2.0";
107 public static final String FEEDLIST_CONTENT_TYPE = "application/vnd.dmaap-dr.feed-list; version=1.0";
108 static final String SUB_BASECONTENT_TYPE = "application/vnd.dmaap-dr.subscription";
109 public static final String SUB_CONTENT_TYPE = "application/vnd.dmaap-dr.subscription; version=2.0";
110 public static final String SUBFULL_CONTENT_TYPE = "application/vnd.dmaap-dr.subscription-full; version=2.0";
111 static final String SUBLIST_CONTENT_TYPE = "application/vnd.dmaap-dr.subscription-list; version=1.0";
114 //Adding groups functionality, ...1610
115 static final String GROUP_BASECONTENT_TYPE = "application/vnd.dmaap-dr.group";
116 static final String GROUP_CONTENT_TYPE = "application/vnd.dmaap-dr.group; version=2.0";
117 static final String GROUPFULL_CONTENT_TYPE = "application/vnd.dmaap-dr.group-full; version=2.0";
118 public static final String GROUPLIST_CONTENT_TYPE = "application/vnd.dmaap-dr.fegrouped-list; version=1.0";
121 public static final String LOGLIST_CONTENT_TYPE = "application/vnd.dmaap-dr.log-list; version=1.0";
122 public static final String PROVFULL_CONTENT_TYPE1 = "application/vnd.dmaap-dr.provfeed-full; version=1.0";
123 public static final String PROVFULL_CONTENT_TYPE2 = "application/vnd.dmaap-dr.provfeed-full; version=2.0";
124 public static final String CERT_ATTRIBUTE = "javax.servlet.request.X509Certificate";
126 static final String DB_PROBLEM_MSG = "There has been a problem with the DB. It is suggested you try the operation again.";
128 private static final int DEFAULT_MAX_FEEDS = 10000;
129 private static final int DEFAULT_MAX_SUBS = 100000;
130 private static final int DEFAULT_POKETIMER1 = 5;
131 private static final int DEFAULT_POKETIMER2 = 30;
132 private static final String DEFAULT_DOMAIN = "onap";
133 private static final String DEFAULT_PROVSRVR_NAME = "dmaap-dr-prov";
136 static final String MISSING_ON_BEHALF = "Missing X-DMAAP-DR-ON-BEHALF-OF header.";
137 static final String MISSING_FEED = "Missing or bad feed number.";
138 static final String POLICY_ENGINE = "Policy Engine disallows access.";
139 static final String UNAUTHORIZED = "Unauthorized.";
140 static final String BAD_SUB = "Missing or bad subscription number.";
141 static final String BAD_JSON = "Badly formed JSON";
142 static final String BAD_URL = "Bad URL.";
144 public static final String API = "/api/";
145 static final String LOGS = "/logs/";
146 static final String TEXT_CT = "text/plain";
147 static final String INGRESS = "/ingress/";
148 static final String EGRESS = "/egress/";
149 static final String NETWORK = "/network/";
150 static final String GROUPID = "groupid";
151 public static final String FEEDID = "feedid";
152 static final String FEEDIDS = "feedids";
153 static final String SUBID = "subid";
154 static final String EVENT_TYPE = "eventType";
155 static final String OUTPUT_TYPE = "output_type";
156 static final String START_TIME = "start_time";
157 static final String END_TIME = "end_time";
158 static final String REASON_SQL = "reasonSQL";
162 * A boolean to trigger one time "provisioning changed" event on startup.
164 private static boolean startmsgFlag = true;
166 * This POD should require SSL connections from clients; pulled from the DB (PROV_REQUIRE_SECURE).
168 private static boolean requireSecure = true;
170 * This POD should require signed, recognized certificates from clients; pulled from the DB (PROV_REQUIRE_CERT).
172 private static boolean requireCert = true;
174 * The set of authorized addresses and networks; pulled from the DB (PROV_AUTH_ADDRESSES).
176 private static Set<String> authorizedAddressesAndNetworks = new HashSet<>();
178 * The set of authorized names; pulled from the DB (PROV_AUTH_SUBJECTS).
180 private static Set<String> authorizedNames = new HashSet<>();
182 * The FQDN of the initially "active" provisioning server in this Data Router ecosystem.
184 private static String initialActivePod;
186 * The FQDN of the initially "standby" provisioning server in this Data Router ecosystem.
188 private static String initialStandbyPod;
190 * The FQDN of this provisioning server in this Data Router ecosystem.
192 private static String thisPod;
194 * "Timer 1" - used to determine when to notify nodes of provisioning changes.
196 private static long pokeTimer1;
198 * "Timer 2" - used to determine when to notify nodes of provisioning changes.
200 private static long pokeTimer2;
202 * Array of nodes names and/or FQDNs.
204 private static String[] nodes = new String[0];
206 * Array of node IP addresses.
208 private static InetAddress[] nodeAddresses = new InetAddress[0];
210 * Array of POD IP addresses.
212 private static InetAddress[] podAddresses = new InetAddress[0];
214 * The maximum number of feeds allowed; pulled from the DB (PROV_MAXFEED_COUNT).
216 static int maxFeeds = 0;
218 * The maximum number of subscriptions allowed; pulled from the DB (PROV_MAXSUB_COUNT).
220 static int maxSubs = 0;
222 * The current number of feeds in the system.
224 static int activeFeeds = 0;
226 * The current number of subscriptions in the system.
228 static int activeSubs = 0;
231 * The domain used to generate a FQDN from the "bare" node names.
233 private static String provDomain = "web.att.com";
236 * The standard FQDN of the provisioning server in this Data Router ecosystem.
238 private static String provName = "feeds-drtr.web.att.com";
241 * The standard FQDN of the ACTIVE_POD provisioning server in this Data Router ecosystem.
243 private static String activeProvName = "feeds-drtr.web.att.com";
246 * This logger is used to log provisioning events.
248 protected static EELFLogger eventlogger;
250 * This logger is used to log internal events (errors, etc.)
252 protected static EELFLogger intlogger;
254 * Authorizer - interface to the Policy Engine.
256 protected static Authorizer authz;
258 * The Synchronizer used to sync active DB to standby one.
260 private static SynchronizerTask synctask = null;
262 //Data Router Subscriber HTTPS Relaxation feature USERSTORYID:US674047.
263 private InetAddress thishost;
264 private InetAddress loopback;
266 //DMAAP-597 (Tech Dept) REST request source IP auth relaxation to accommodate OOM kubernetes deploy
267 private static String isAddressAuthEnabled = (new DB()).getProperties()
268 .getProperty("org.onap.dmaap.datarouter.provserver.isaddressauthenabled", "false");
270 static String isCadiEnabled = (new DB()).getProperties()
271 .getProperty("org.onap.dmaap.datarouter.provserver.cadi.enabled", "false");
274 * Initialize data common to all the provisioning server servlets.
276 protected BaseServlet() {
277 if (eventlogger == null) {
278 eventlogger = EELFManager.getInstance().getLogger("EventLog");
280 if (intlogger == null) {
281 this.intlogger = EELFManager.getInstance().getLogger("InternalLog");
284 authz = new ProvAuthorizer(this);
287 startmsgFlag = false;
288 provisioningParametersChanged();
290 if (synctask == null) {
291 synctask = SynchronizerTask.getSynchronizer();
293 String name = this.getClass().getName();
294 intlogger.info("PROV0002 Servlet " + name + " started.");
298 public void init(ServletConfig config) throws ServletException {
301 thishost = InetAddress.getLocalHost();
302 loopback = InetAddress.getLoopbackAddress();
303 } catch (UnknownHostException e) {
304 intlogger.info("BaseServlet.init: " + e.getMessage(), e);
308 public static int getIdFromPath(HttpServletRequest req) {
309 String path = req.getPathInfo();
310 if (path == null || path.length() < 2) {
314 return Integer.parseInt(path.substring(1));
315 } catch (NumberFormatException e) {
321 * Read the request's input stream and return a JSONObject from it.
323 * @param req the HTTP request
324 * @return the JSONObject, or null if the stream cannot be parsed
326 JSONObject getJSONfromInput(HttpServletRequest req) {
327 JSONObject jo = null;
329 jo = new JSONObject(new JSONTokener(req.getInputStream()));
330 if (intlogger.isDebugEnabled()) {
331 intlogger.debug("JSON: " + jo.toString());
333 } catch (Exception e) {
334 intlogger.info("Error reading JSON: " + e);
340 * This method encrypt/decrypt the key in the JSON passed by user request inside the authorisation
341 * header object in request before logging the JSON.
343 * @param jo the JSON passed in http request.
344 * @param maskKey the key to be masked in the JSON passed.
345 * @param action whether to mask the key or unmask it in a JSON passed.
346 * @return the JSONObject, or null if the stream cannot be parsed.
348 static JSONObject maskJSON(JSONObject jo, String maskKey, boolean action) {
349 if (!jo.isNull("authorization")) {
350 JSONArray endpointIds = jo.getJSONObject("authorization").getJSONArray("endpoint_ids");
351 for (int index = 0; index < endpointIds.length(); index++) {
352 if ((!endpointIds.getJSONObject(index).isNull(maskKey))) {
353 String password = endpointIds.getJSONObject(index).get(maskKey).toString();
354 processPassword(maskKey, action, endpointIds, index, password);
361 private static void processPassword(String maskKey, boolean action, JSONArray endpointIds, int index,
365 endpointIds.getJSONObject(index).put(maskKey, PasswordProcessor.encrypt(password));
367 endpointIds.getJSONObject(index).put(maskKey, PasswordProcessor.decrypt(password));
369 } catch (JSONException | GeneralSecurityException e) {
370 intlogger.info("Error reading JSON while masking: " + e);
375 * Check if the remote host is authorized to perform provisioning. Is the request secure? Is it coming from an
376 * authorized IP address or network (configured via PROV_AUTH_ADDRESSES)? Does it have a valid client certificate
377 * (configured via PROV_AUTH_SUBJECTS)?
379 * @param request the request
380 * @return an error string, or null if all is OK
382 String isAuthorizedForProvisioning(HttpServletRequest request) {
383 if (!Boolean.parseBoolean(isAddressAuthEnabled)) {
386 // Is the request https?
387 if (requireSecure && !request.isSecure()) {
388 return "Request must be made over an HTTPS connection.";
390 String remoteHostCheck = checkRemoteHostAuthorization(request);
391 if (remoteHostCheck != null) {
392 return remoteHostCheck;
394 // Does remote have a valid certificate?
396 X509Certificate[] certs = (X509Certificate[]) request.getAttribute(CERT_ATTRIBUTE);
397 if (certs == null || certs.length == 0) {
398 return "Client certificate is missing.";
400 // cert[0] is the client cert
401 // see http://www.proto.research.att.com/java/java7/api/javax/net/ssl/SSLSession.html#getPeerCertificates()
402 String name = certs[0].getSubjectX500Principal().getName();
403 if (!authorizedNames.contains(name)) {
404 return "No authorized certificate found.";
412 private String checkRemoteHostAuthorization(HttpServletRequest request) {
413 // Is remote IP authorized?
414 String remote = request.getRemoteAddr();
416 boolean found = false;
417 InetAddress ip = InetAddress.getByName(remote);
418 for (String addrnet : authorizedAddressesAndNetworks) {
419 found |= addressMatchesNetwork(ip, addrnet);
422 return "Unauthorized address: " + remote;
424 } catch (UnknownHostException e) {
425 intlogger.error("PROV0051 BaseServlet.isAuthorizedForProvisioning: " + e.getMessage(), e);
426 return "Unauthorized address: " + remote;
432 * Check if the remote IP address is authorized to see the /internal URL tree.
434 * @param request the HTTP request
435 * @return true iff authorized
437 boolean isAuthorizedForInternal(HttpServletRequest request) {
439 if (!Boolean.parseBoolean(isAddressAuthEnabled)) {
442 InetAddress ip = InetAddress.getByName(request.getRemoteAddr());
443 for (InetAddress node : getNodeAddresses()) {
444 if (ip.equals(node)) {
448 for (InetAddress pod : getPodAddresses()) {
449 if (ip.equals(pod)) {
453 if (ip.equals(thishost)) {
456 if (ip.equals(loopback)) {
459 } catch (UnknownHostException e) {
460 intlogger.error("PROV0052 BaseServlet.isAuthorizedForInternal: " + e.getMessage(), e);
466 * Check if an IP address matches a network address.
468 * @param ip the IP address
469 * @param s the network address; a bare IP address may be matched also
470 * @return true if they intersect
472 private static boolean addressMatchesNetwork(InetAddress ip, String s) {
474 int n = s.indexOf('/');
476 mlen = Integer.parseInt(s.substring(n + 1));
477 s = s.substring(0, n);
480 InetAddress i2 = InetAddress.getByName(s);
481 byte[] b1 = ip.getAddress();
482 byte[] b2 = i2.getAddress();
483 if (b1.length != b2.length) {
488 (byte) 0x00, (byte) 0x80, (byte) 0xC0, (byte) 0xE0,
489 (byte) 0xF0, (byte) 0xF8, (byte) 0xFC, (byte) 0xFE
491 byte mask = masks[mlen % 8];
492 for (n = mlen / 8; n < b1.length; n++) {
498 for (n = 0; n < b1.length; n++) {
499 if (b1[n] != b2[n]) {
503 } catch (UnknownHostException e) {
504 intlogger.error("PROV0053 BaseServlet.addressMatchesNetwork: " + e.getMessage(), e);
511 * Something has changed in the provisioning data. Start the timers that will cause the pre-packaged JSON string to
512 * be regenerated, and cause nodes and the other provisioning server to be notified.
514 static void provisioningDataChanged() {
515 long now = System.currentTimeMillis();
516 Poker p = Poker.getPoker();
517 p.setTimers(now + (pokeTimer1 * 1000L), now + (pokeTimer2 * 1000L));
521 * Something in the parameters has changed, reload all parameters from the DB.
523 static void provisioningParametersChanged() {
524 Map<String, String> map = Parameters.getParameters();
525 requireSecure = getBoolean(map, Parameters.PROV_REQUIRE_SECURE);
526 requireCert = getBoolean(map, Parameters.PROV_REQUIRE_CERT);
527 authorizedAddressesAndNetworks = getSet(map, Parameters.PROV_AUTH_ADDRESSES);
528 authorizedNames = getSet(map, Parameters.PROV_AUTH_SUBJECTS);
529 nodes = getSet(map, Parameters.NODES).toArray(new String[0]);
530 maxFeeds = getInt(map, Parameters.PROV_MAXFEED_COUNT, DEFAULT_MAX_FEEDS);
531 maxSubs = getInt(map, Parameters.PROV_MAXSUB_COUNT, DEFAULT_MAX_SUBS);
532 pokeTimer1 = getInt(map, Parameters.PROV_POKETIMER1, DEFAULT_POKETIMER1);
533 pokeTimer2 = getInt(map, Parameters.PROV_POKETIMER2, DEFAULT_POKETIMER2);
535 // The domain used to generate a FQDN from the "bare" node names
536 provDomain = getString(map, Parameters.PROV_DOMAIN, DEFAULT_DOMAIN);
537 provName = getString(map, Parameters.PROV_NAME, DEFAULT_PROVSRVR_NAME);
538 activeProvName = getString(map, Parameters.PROV_ACTIVE_NAME, provName);
539 initialActivePod = getString(map, Parameters.ACTIVE_POD, "");
540 initialStandbyPod = getString(map, Parameters.STANDBY_POD, "");
542 //Adding new param for static Routing - Rally:US664862-1610
543 String staticRoutingNodes = getString(map, Parameters.STATIC_ROUTING_NODES, "");
544 activeFeeds = Feed.countActiveFeeds();
545 activeSubs = Subscription.countActiveSubscriptions();
547 thisPod = InetAddress.getLocalHost().getHostName();
548 } catch (UnknownHostException e) {
550 intlogger.warn("PROV0014 Cannot determine the name of this provisioning server.", e);
553 // Normalize the nodes, and fill in nodeAddresses
554 InetAddress[] na = new InetAddress[nodes.length];
555 for (int i = 0; i < nodes.length; i++) {
557 na[i] = InetAddress.getByName(nodes[i]);
558 intlogger.debug("PROV0003 DNS lookup: " + nodes[i] + " => " + na[i].toString());
559 } catch (UnknownHostException e) {
561 intlogger.warn("PROV0004 Cannot lookup " + nodes[i] + ": " + e.getMessage(), e);
565 //Reset Nodes arr after - removing static routing Nodes, Rally Userstory - US664862 .
566 List<String> filterNodes = new ArrayList<>();
567 for (String node : nodes) {
568 if (!staticRoutingNodes.contains(node)) {
569 filterNodes.add(node);
572 nodes = filterNodes.toArray(new String[0]);
575 NodeClass.setNodes(nodes); // update NODES table
577 // Normalize the PODs, and fill in podAddresses
578 String[] pods = getPods();
579 na = new InetAddress[pods.length];
580 for (int i = 0; i < pods.length; i++) {
582 na[i] = InetAddress.getByName(pods[i]);
583 intlogger.debug("PROV0003 DNS lookup: " + pods[i] + " => " + na[i].toString());
584 } catch (UnknownHostException e) {
586 intlogger.warn("PROV0004 Cannot lookup " + pods[i] + ": " + e.getMessage(), e);
591 // Update ThrottleFilter
592 ThrottleFilter.configure();
594 // Check if we are active or standby POD
595 if (!isInitialActivePOD() && !isInitialStandbyPOD()) {
596 intlogger.warn("PROV0015 This machine is neither the active nor the standby POD.");
600 public static String getProvName() {
604 static String getActiveProvName() {
605 return activeProvName;
609 * Get an array of all node names in the DR network.
611 * @return an array of Strings
613 public static String[] getNodes() {
618 * Get an array of all node InetAddresses in the DR network.
620 * @return an array of InetAddresses
622 private static InetAddress[] getNodeAddresses() {
623 return nodeAddresses;
627 * Get an array of all POD names in the DR network.
629 * @return an array of Strings
631 public static String[] getPods() {
632 return new String[]{initialActivePod, initialStandbyPod};
636 * Get an array of all POD InetAddresses in the DR network.
638 * @return an array of InetAddresses
640 private static InetAddress[] getPodAddresses() {
645 * Gets the FQDN of the initially ACTIVE_POD provisioning server (POD). Note: this used to be called isActivePOD(),
646 * however, that is a misnomer, as the active status could shift to the standby POD without these parameters
647 * changing. Hence, the function names have been changed to more accurately reflect their purpose.
651 public static boolean isInitialActivePOD() {
652 return thisPod.equals(initialActivePod);
656 * Gets the FQDN of the initially STANDBY_POD provisioning server (POD). Note: this used to be called isStandbyPOD(),
657 * however, that is a misnomer, as the standby status could shift to the active POD without these parameters
658 * changing. Hence, the function names have been changed to more accurately reflect their purpose.
662 public static boolean isInitialStandbyPOD() {
663 return thisPod.equals(initialStandbyPod);
667 * INSERT an {@link Insertable} bean into the database.
669 * @param bean the bean representing a row to insert
670 * @return true if the INSERT was successful
672 protected boolean doInsert(Insertable bean) {
675 Connection conn = null;
677 conn = db.getConnection();
678 rv = bean.doInsert(conn);
679 } catch (SQLException e) {
681 intlogger.warn("PROV0005 doInsert: " + e.getMessage(), e);
691 * UPDATE an {@link Updateable} bean in the database.
693 * @param bean the bean representing a row to update
694 * @return true if the UPDATE was successful
696 protected boolean doUpdate(Updateable bean) {
699 Connection conn = null;
701 conn = db.getConnection();
702 rv = bean.doUpdate(conn);
703 } catch (SQLException e) {
705 intlogger.warn("PROV0006 doUpdate: " + e.getMessage(), e);
715 * DELETE an {@link Deleteable} bean from the database.
717 * @param bean the bean representing a row to delete
718 * @return true if the DELETE was successful
720 protected boolean doDelete(Deleteable bean) {
723 Connection conn = null;
725 conn = db.getConnection();
726 rv = bean.doDelete(conn);
727 } catch (SQLException e) {
729 intlogger.warn("PROV0007 doDelete: " + e.getMessage(), e);
738 private static boolean getBoolean(Map<String, String> map, String name) {
739 String s = map.get(name);
740 return "true".equalsIgnoreCase(s);
743 private static String getString(Map<String, String> map, String name, String dflt) {
744 String s = map.get(name);
745 return (s != null) ? s : dflt;
748 private static int getInt(Map<String, String> map, String name, int dflt) {
750 String s = map.get(name);
751 return Integer.parseInt(s);
752 } catch (NumberFormatException e) {
757 private static Set<String> getSet(Map<String, String> map, String name) {
758 Set<String> set = new HashSet<>();
759 String s = map.get(name);
761 String[] pp = s.split("\\|");
763 for (String t : pp) {
764 String t2 = t.trim();
765 if (t2.length() > 0) {
775 * A class used to encapsulate a Content-type header, separating out the "version" attribute (which defaults to
778 public class ContentHeader {
781 private Map<String, String> map = new HashMap<>();
787 ContentHeader(String t, String v) {
789 map.put("version", v);
792 public String getType() {
796 String getAttribute(String key) {
797 String s = map.get(key);
806 * Get the ContentHeader from an HTTP request.
808 * @param req the request
809 * @return the header, encapsulated in a ContentHeader object
811 ContentHeader getContentHeader(HttpServletRequest req) {
812 ContentHeader ch = new ContentHeader();
813 String s = req.getHeader("Content-Type");
815 String[] pp = s.split(";");
816 ch.type = pp[0].trim();
817 for (int i = 1; i < pp.length; i++) {
818 int ix = pp[i].indexOf('=');
820 String k = pp[i].substring(0, ix).trim();
821 String v = pp[i].substring(ix + 1).trim();
824 ch.map.put(pp[i].trim(), "");
831 // Methods for the Policy Engine classes - ProvDataProvider interface
833 public String getFeedOwner(String feedId) {
835 int n = Integer.parseInt(feedId);
836 Feed f = Feed.getFeedById(n);
838 return f.getPublisher();
840 } catch (NumberFormatException e) {
847 public String getFeedClassification(String feedId) {
849 int n = Integer.parseInt(feedId);
850 Feed f = Feed.getFeedById(n);
852 return f.getAuthorization().getClassification();
854 } catch (NumberFormatException e) {
861 public String getSubscriptionOwner(String subId) {
863 int n = Integer.parseInt(subId);
864 Subscription s = Subscription.getSubscriptionById(n);
866 return s.getSubscriber();
868 } catch (NumberFormatException e) {
875 * @Method - isUserMemberOfGroup - Rally:US708115
876 * @Params - group object and user to check if exists in given group
877 * @return - boolean value /true/false
879 private boolean isUserMemberOfGroup(Group group, String user) {
881 String groupDetails = group.getMembers().replace("]", "").replace("[", "");
882 String[] s = groupDetails.split("},");
884 for (String value : s) {
887 jsonObj = new JSONObject(value + "}");
888 if (jsonObj.get("id").equals(user)) {
891 } catch (JSONException e) {
892 intlogger.error("JSONException: " + e.getMessage(), e);
900 * @Method - getGroupByFeedGroupId- Rally:US708115
901 * @Params - User to check in group and feedid which is assigned the group.
902 * @return - string value groupid/null
905 public String getGroupByFeedGroupId(String owner, String feedId) {
907 Feed f = Feed.getFeedById(Integer.parseInt(feedId));
909 int groupid = f.getGroupid();
911 Group group = Group.getGroupById(groupid);
912 if (group != null && isUserMemberOfGroup(group, owner)) {
913 return group.getAuthid();
917 } catch (NumberFormatException e) {
924 * @Method - getGroupBySubGroupId - Rally:US708115
925 * @Params - User to check in group and subid which is assigned the group.
926 * @return - string value groupid/null
929 public String getGroupBySubGroupId(String owner, String subId) {
931 int n = Integer.parseInt(subId);
932 Subscription s = Subscription.getSubscriptionById(n);
934 int groupid = s.getGroupid();
936 Group group = Group.getGroupById(groupid);
937 if (group != null && isUserMemberOfGroup(group, owner)) {
938 return group.getAuthid();
942 } catch (NumberFormatException e) {
949 * @Method - setIpFqdnRequestIDandInvocationIDForEelf
950 * @Params - method, prints method name in EELF log.
951 * @Params- Req, Request used to get RequestId and InvocationId
953 void setIpFqdnRequestIDandInvocationIDForEelf(String method, HttpServletRequest req) {
954 setIpFqdnForEelf(method);
955 setMDC(req, "X-ONAP-RequestID", MDC_KEY_REQUEST_ID);
956 setMDC(req, "X-InvocationID", "InvocationId");
959 private void setMDC(HttpServletRequest req, String headerName, String keyName) {
960 String mdcId = req.getHeader(headerName);
961 if (StringUtils.isBlank(mdcId)) {
962 mdcId = UUID.randomUUID().toString();
964 MDC.put(keyName, mdcId);
968 * @Method - setIpFqdnRequestIdForEelf - Rally:US664892
969 * @Params - method, prints method name in EELF log.
971 void setIpFqdnForEelf(String method) {
973 MDC.put(MDC_SERVICE_NAME, method);
975 MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getHostName());
976 MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
977 } catch (Exception e) {
978 intlogger.error("Exception: " + e.getMessage(), e);
984 * AAF changes: TDP EPIC US# 307413
985 * @Method - getFeedPermission - Forming permission string for feed part to check AAF access in CADI Framework
986 * @Params - aafInstance Passing aafInstance as it's used in permission string
987 * @Params - userAction Passing CONST values to set different actions in permission string
989 String getFeedPermission(String aafInstance, String userAction) {
991 Properties props = (new DB()).getProperties();
992 String type = props.getProperty(AAF_CADI_FEED_TYPE, AAF_CADI_FEED);
994 switch (userAction) {
995 case CREATE_PERMISSION:
996 action = CREATE_PERMISSION;
998 case EDIT_PERMISSION:
999 action = EDIT_PERMISSION;
1001 case DELETE_PERMISSION:
1002 action = DELETE_PERMISSION;
1004 case PUBLISH_PERMISSION:
1005 action = PUBLISH_PERMISSION;
1007 case SUSPEND_PERMISSION:
1008 action = SUSPEND_PERMISSION;
1010 case RESTORE_PERMISSION:
1011 action = RESTORE_PERMISSION;
1016 if (aafInstance == null || "".equals(aafInstance)) {
1017 aafInstance = props.getProperty(AAF_INSTANCE, "org.onap.dmaap-dr.NoInstanceDefined");
1019 return type + "|" + aafInstance + "|" + action;
1020 } catch (Exception e) {
1021 intlogger.error("PROV7005 BaseServlet.getFeedPermission: " + e.getMessage(), e);
1027 * AAF changes: TDP EPIC US# 307413
1028 * @Method - getSubscriberPermission - Forming permission string for subscription part to check AAF access in CADI Framework
1029 * @Params - aafInstance Passing aafInstance as it's used in permission string
1030 * @Params - userAction Passing CONST values to set different actions in permission string
1032 String getSubscriberPermission(String aafInstance, String userAction) {
1034 Properties props = (new DB()).getProperties();
1035 String type = props.getProperty(AAF_CADI_SUB_TYPE, AAF_CADI_SUB);
1037 switch (userAction) {
1038 case SUBSCRIBE_PERMISSION:
1039 action = SUBSCRIBE_PERMISSION;
1040 type = props.getProperty(AAF_CADI_FEED_TYPE, AAF_CADI_FEED);
1042 case EDIT_PERMISSION:
1043 action = EDIT_PERMISSION;
1045 case DELETE_PERMISSION:
1046 action = DELETE_PERMISSION;
1048 case RESTORE_PERMISSION:
1049 action = RESTORE_PERMISSION;
1051 case SUSPEND_PERMISSION:
1052 action = SUSPEND_PERMISSION;
1054 case PUBLISH_PERMISSION:
1055 action = PUBLISH_PERMISSION;
1057 case APPROVE_SUB_PERMISSION:
1058 action = APPROVE_SUB_PERMISSION;
1059 type = props.getProperty(AAF_CADI_FEED_TYPE, AAF_CADI_FEED);
1064 if (aafInstance == null || "".equals(aafInstance)) {
1065 aafInstance = props.getProperty(AAF_INSTANCE, "org.onap.dmaap-dr.NoInstanceDefined");
1067 return type + "|" + aafInstance + "|" + action;
1068 } catch (Exception e) {
1069 intlogger.error("PROV7005 BaseServlet.getSubscriberPermission: " + e.getMessage(), e);