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
24 package org.onap.dmaap.datarouter.provisioning.beans;
\r
26 import java.io.InvalidObjectException;
\r
27 import java.sql.Connection;
\r
28 import java.sql.PreparedStatement;
\r
29 import java.sql.ResultSet;
\r
30 import java.sql.SQLException;
\r
31 import java.sql.Statement;
\r
32 import java.util.ArrayList;
\r
33 import java.util.Collection;
\r
34 import java.util.Date;
\r
35 import java.util.List;
\r
36 import java.util.Properties;
\r
38 import com.att.eelf.configuration.EELFLogger;
\r
39 import com.att.eelf.configuration.EELFManager;
\r
40 import org.json.JSONObject;
\r
41 import org.onap.dmaap.datarouter.provisioning.utils.DB;
\r
42 import org.onap.dmaap.datarouter.provisioning.utils.URLUtilities;
\r
46 * The representation of a Subscription. Subscriptions can be retrieved from the DB, or stored/updated in the DB.
\r
48 * @author Robert Eby
\r
49 * @version $Id: Subscription.java,v 1.9 2013/10/28 18:06:53 eby Exp $
\r
51 public class Subscription extends Syncable {
\r
53 private static final String SQLEXCEPTION = "SQLException: ";
\r
54 private static final String SUBID_KEY = "subid";
\r
55 private static final String SUBID_COL = "SUBID";
\r
56 private static final String FEEDID_KEY = "feedid";
\r
57 private static final String GROUPID_KEY = "groupid";
\r
58 private static final String LAST_MOD_KEY = "last_mod";
\r
59 private static final String CREATED_DATE = "created_date";
\r
60 private static EELFLogger intlogger = EELFManager.getInstance().getLogger("InternalLog");
\r
61 private static int nextSubid = getMaxSubID() + 1;
\r
65 private int groupid; //New field is added - Groups feature Rally:US708115 - 1610
\r
66 private SubDelivery delivery;
\r
67 private boolean followRedirect;
\r
68 private boolean metadataOnly;
\r
69 private String subscriber;
\r
70 private SubLinks links;
\r
71 private boolean suspended;
\r
72 private Date lastMod;
\r
73 private Date createdDate;
\r
74 private boolean privilegedSubscriber;
\r
75 private String aafInstance;
\r
76 private boolean decompress;
\r
78 public static Subscription getSubscriptionMatching(Subscription sub) {
\r
79 SubDelivery deli = sub.getDelivery();
\r
80 String sql = String.format(
\r
81 "select * from SUBSCRIPTIONS where FEEDID = %d and DELIVERY_URL = \"%s\" and DELIVERY_USER = \"%s\" and DELIVERY_PASSWORD = \"%s\" and DELIVERY_USE100 = %d and METADATA_ONLY = %d and FOLLOW_REDIRECTS = %d",
\r
86 deli.isUse100() ? 1 : 0,
\r
87 sub.isMetadataOnly() ? 1 : 0,
\r
88 sub.isFollowRedirect() ? 1 :0
\r
90 List<Subscription> list = getSubscriptionsForSQL(sql);
\r
91 return !list.isEmpty() ? list.get(0) : null;
\r
94 public static Subscription getSubscriptionById(int id) {
\r
95 String sql = "select * from SUBSCRIPTIONS where SUBID = " + id;
\r
96 List<Subscription> list = getSubscriptionsForSQL(sql);
\r
97 return !list.isEmpty() ? list.get(0) : null;
\r
100 public static Collection<Subscription> getAllSubscriptions() {
\r
101 return getSubscriptionsForSQL("select * from SUBSCRIPTIONS");
\r
104 private static List<Subscription> getSubscriptionsForSQL(String sql) {
\r
105 List<Subscription> list = new ArrayList<>();
\r
108 @SuppressWarnings("resource")
\r
109 Connection conn = db.getConnection();
\r
110 try (Statement stmt = conn.createStatement()) {
\r
111 try (ResultSet rs = stmt.executeQuery(sql)) {
\r
112 while (rs.next()) {
\r
113 Subscription sub = new Subscription(rs);
\r
119 } catch (SQLException e) {
\r
120 intlogger.error("PROV0001 getSubscriptionsForSQL: " + e.toString(), e);
\r
125 public static int getMaxSubID() {
\r
129 @SuppressWarnings("resource")
\r
130 Connection conn = db.getConnection();
\r
131 try (Statement stmt = conn.createStatement()) {
\r
132 try (ResultSet rs = stmt.executeQuery("select MAX(subid) from SUBSCRIPTIONS")) {
\r
134 max = rs.getInt(1);
\r
139 } catch (SQLException e) {
\r
140 intlogger.info("getMaxSubID: " + e.getMessage(), e);
\r
145 public static Collection<String> getSubscriptionUrlList(int feedid) {
\r
146 List<String> list = new ArrayList<>();
\r
147 String sql = "select SUBID from SUBSCRIPTIONS where FEEDID = ?";
\r
151 @SuppressWarnings("resource")
\r
152 Connection conn = db.getConnection();
\r
153 try (PreparedStatement stmt = conn.prepareStatement(sql)) {
\r
154 stmt.setString(1, String.valueOf(feedid));
\r
155 try (ResultSet rs = stmt.executeQuery()) {
\r
156 while (rs.next()) {
\r
157 int subid = rs.getInt(SUBID_COL);
\r
158 list.add(URLUtilities.generateSubscriptionURL(subid));
\r
163 } catch (SQLException e) {
\r
164 intlogger.error(SQLEXCEPTION + e.getMessage(), e);
\r
170 * Return a count of the number of active subscriptions in the DB.
\r
172 * @return the count
\r
174 public static int countActiveSubscriptions() {
\r
178 @SuppressWarnings("resource")
\r
179 Connection conn = db.getConnection();
\r
180 try (Statement stmt = conn.createStatement()) {
\r
181 try (ResultSet rs = stmt.executeQuery("select count(*) from SUBSCRIPTIONS")) {
\r
183 count = rs.getInt(1);
\r
188 } catch (SQLException e) {
\r
189 intlogger.warn("PROV0008 countActiveSubscriptions: " + e.getMessage(), e);
\r
194 public Subscription() {
\r
198 public Subscription(String url, String user, String password) {
\r
201 this.groupid = -1; //New field is added - Groups feature Rally:US708115 - 1610
\r
202 this.delivery = new SubDelivery(url, user, password, false);
\r
203 this.metadataOnly = false;
\r
204 this.followRedirect = false;
\r
205 this.subscriber = "";
\r
206 this.links = new SubLinks();
\r
207 this.suspended = false;
\r
208 this.lastMod = new Date();
\r
209 this.createdDate = new Date();
\r
210 this.privilegedSubscriber = false;
\r
211 this.aafInstance = "";
\r
212 this.decompress = false;
\r
215 public Subscription(ResultSet rs) throws SQLException {
\r
216 this.subid = rs.getInt(SUBID_COL);
\r
217 this.feedid = rs.getInt("FEEDID");
\r
218 this.groupid = rs.getInt("GROUPID"); //New field is added - Groups feature Rally:US708115 - 1610
\r
219 this.delivery = new SubDelivery(rs);
\r
220 this.metadataOnly = rs.getBoolean("METADATA_ONLY");
\r
221 this.followRedirect = rs.getBoolean("FOLLOW_REDIRECTS");
\r
222 this.subscriber = rs.getString("SUBSCRIBER");
\r
223 this.links = new SubLinks(rs.getString("SELF_LINK"), URLUtilities.generateFeedURL(feedid), rs.getString("LOG_LINK"));
\r
224 this.suspended = rs.getBoolean("SUSPENDED");
\r
225 this.lastMod = rs.getDate("LAST_MOD");
\r
226 this.createdDate = rs.getDate("CREATED_DATE");
\r
227 this.privilegedSubscriber = rs.getBoolean("PRIVILEGED_SUBSCRIBER");
\r
228 this.aafInstance = rs.getString("AAF_INSTANCE");
\r
229 this.decompress = rs.getBoolean("DECOMPRESS");
\r
232 public Subscription(JSONObject jo) throws InvalidObjectException {
\r
235 // The JSONObject is assumed to contain a vnd.dmaap-dr.subscription representation
\r
236 this.subid = jo.optInt(SUBID_KEY, -1);
\r
237 this.feedid = jo.optInt(FEEDID_KEY, -1);
\r
238 this.groupid = jo.optInt(GROUPID_KEY, -1); //New field is added - Groups feature Rally:US708115 - 1610
\r
239 this.aafInstance = jo.optString("aaf_instance", "legacy");
\r
240 if(!(aafInstance.equalsIgnoreCase("legacy"))){
\r
241 if (aafInstance.length() > 255)
\r
242 throw new InvalidObjectException("aaf_instance field is too long");
\r
244 JSONObject jdeli = jo.getJSONObject("delivery");
\r
245 String url = jdeli.getString("url");
\r
246 String user = jdeli.getString("user");
\r
247 String password = jdeli.getString("password");
\r
248 boolean use100 = jdeli.getBoolean("use100");
\r
250 //Data Router Subscriber HTTPS Relaxation feature USERSTORYID:US674047.
\r
251 Properties p = (new DB()).getProperties();
\r
252 if (!url.startsWith("https://") && isHttpsRelaxationFalseAndHasSyncKey(jo, p)) {
\r
253 throw new InvalidObjectException("delivery URL is not HTTPS");
\r
256 if (url.length() > 256) {
\r
257 throw new InvalidObjectException("delivery url field is too long");
\r
259 if (user.length() > 60) {
\r
260 throw new InvalidObjectException("delivery user field is too long");
\r
262 if (password.length() > 32) {
\r
263 throw new InvalidObjectException("delivery password field is too long");
\r
265 this.delivery = new SubDelivery(url, user, password, use100);
\r
266 this.metadataOnly = jo.getBoolean("metadataOnly");
\r
267 this.followRedirect = jo.optBoolean("follow_redirect", false);
\r
268 this.suspended = jo.optBoolean("suspend", false);
\r
269 this.privilegedSubscriber = jo.optBoolean("privilegedSubscriber", false);
\r
270 this.decompress = jo.optBoolean("decompress", false);
\r
271 this.subscriber = jo.optString("subscriber", "");
\r
272 JSONObject jol = jo.optJSONObject("links");
\r
273 this.links = (jol == null) ? (new SubLinks()) : (new SubLinks(jol));
\r
274 } catch (InvalidObjectException e) {
\r
276 } catch (Exception e) {
\r
277 intlogger.warn("Invalid JSON: " + e.getMessage(), e);
\r
278 throw new InvalidObjectException("Invalid JSON: " + e.getMessage());
\r
282 private boolean isHttpsRelaxationFalseAndHasSyncKey(JSONObject jo, Properties p) {
\r
283 return p.get("org.onap.dmaap.datarouter.provserver.https.relaxation").toString().equals("false") && !jo
\r
287 public int getSubid() {
\r
291 public void setSubid(int subid) {
\r
292 this.subid = subid;
\r
294 // Create link URLs
\r
295 SubLinks sl = getLinks();
\r
296 sl.setSelf(URLUtilities.generateSubscriptionURL(subid));
\r
297 sl.setLog(URLUtilities.generateSubLogURL(subid));
\r
300 public int getFeedid() {
\r
304 public void setFeedid(int feedid) {
\r
305 this.feedid = feedid;
\r
307 // Create link URLs
\r
308 SubLinks sl = getLinks();
\r
309 sl.setFeed(URLUtilities.generateFeedURL(feedid));
\r
311 public String getAafInstance() {
\r
312 return aafInstance;
\r
315 public void setAafInstance(String aafInstance) {
\r
316 this.aafInstance = aafInstance;
\r
319 //New getter setters for Groups feature Rally:US708115 - 1610
\r
320 public int getGroupid() {
\r
324 public void setGroupid(int groupid) {
\r
325 this.groupid = groupid;
\r
328 public SubDelivery getDelivery() {
\r
332 public void setDelivery(SubDelivery delivery) {
\r
333 this.delivery = delivery;
\r
336 public boolean isMetadataOnly() {
\r
337 return metadataOnly;
\r
340 public void setMetadataOnly(boolean metadataOnly) {
\r
341 this.metadataOnly = metadataOnly;
\r
344 private boolean isFollowRedirect() {
\r
345 return followRedirect;
\r
347 public void setFollowRedirect(boolean followRedirect) {
\r
348 this.followRedirect = followRedirect;
\r
351 boolean isSuspended() {
\r
355 public void setSuspended(boolean suspended) {
\r
356 this.suspended = suspended;
\r
359 public boolean isPrivilegedSubscriber() {
\r
360 return privilegedSubscriber;
\r
363 public void setPrivilegedSubscriber(boolean privilegedSubscriber) {
\r
364 this.privilegedSubscriber = privilegedSubscriber;
\r
367 public String getSubscriber() {
\r
371 public void setSubscriber(String subscriber) {
\r
372 if (subscriber != null) {
\r
373 if (subscriber.length() > 8) {
\r
374 subscriber = subscriber.substring(0, 8);
\r
376 this.subscriber = subscriber;
\r
380 public SubLinks getLinks() {
\r
384 void setLinks(SubLinks links) {
\r
385 this.links = links;
\r
388 public boolean isDecompress() {
\r
392 public void setDecompress(boolean decompress) {
\r
393 this.decompress = decompress;
\r
397 public JSONObject asJSONObject() {
\r
398 JSONObject jo = new JSONObject();
\r
399 jo.put(SUBID_KEY, subid);
\r
400 jo.put(FEEDID_KEY, feedid);
\r
401 jo.put(GROUPID_KEY, groupid); //New field is added - Groups feature Rally:US708115 - 1610
\r
402 jo.put("delivery", delivery.asJSONObject());
\r
403 jo.put("metadataOnly", metadataOnly);
\r
404 jo.put("follow_redirect", followRedirect);
\r
405 jo.put("subscriber", subscriber);
\r
406 jo.put("links", links.asJSONObject());
\r
407 jo.put("suspend", suspended);
\r
408 jo.put(LAST_MOD_KEY, lastMod.getTime());
\r
409 jo.put(CREATED_DATE, createdDate.getTime());
\r
410 jo.put("privilegedSubscriber", privilegedSubscriber);
\r
411 jo.put("aaf_instance", aafInstance);
\r
412 jo.put("decompress", decompress);
\r
416 public JSONObject asLimitedJSONObject() {
\r
417 JSONObject jo = asJSONObject();
\r
418 jo.remove(SUBID_KEY);
\r
419 jo.remove(FEEDID_KEY);
\r
420 jo.remove(LAST_MOD_KEY);
\r
424 public JSONObject asJSONObject(boolean hidepasswords) {
\r
425 JSONObject jo = asJSONObject();
\r
426 if (hidepasswords) {
\r
427 jo.remove(SUBID_KEY); // we no longer hide passwords, however we do hide these
\r
428 jo.remove(FEEDID_KEY);
\r
429 jo.remove(LAST_MOD_KEY);
\r
430 jo.remove(CREATED_DATE);
\r
436 public boolean doInsert(Connection c) {
\r
438 PreparedStatement ps = null;
\r
441 // No feed ID assigned yet, so assign the next available one
\r
442 setSubid(nextSubid++);
\r
444 // In case we insert a feed from synchronization
\r
445 if (subid > nextSubid) {
\r
446 nextSubid = subid + 1;
\r
449 // Create the SUBSCRIPTIONS row
\r
450 String sql = "insert into SUBSCRIPTIONS (SUBID, FEEDID, DELIVERY_URL, DELIVERY_USER, DELIVERY_PASSWORD, DELIVERY_USE100, METADATA_ONLY, SUBSCRIBER, SUSPENDED, GROUPID, PRIVILEGED_SUBSCRIBER, FOLLOW_REDIRECTS, DECOMPRESS, AAF_INSTANCE) values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
\r
451 ps = c.prepareStatement(sql, new String[]{SUBID_COL});
\r
452 ps.setInt(1, subid);
\r
453 ps.setInt(2, feedid);
\r
454 ps.setString(3, getDelivery().getUrl());
\r
455 ps.setString(4, getDelivery().getUser());
\r
456 ps.setString(5, getDelivery().getPassword());
\r
457 ps.setInt(6, getDelivery().isUse100() ? 1 : 0);
\r
458 ps.setInt(7, isMetadataOnly() ? 1 : 0);
\r
459 ps.setString(8, getSubscriber());
\r
460 ps.setBoolean(9, isSuspended());
\r
461 ps.setInt(10, groupid); //New field is added - Groups feature Rally:US708115 - 1610
\r
462 ps.setBoolean(11, isPrivilegedSubscriber());
\r
463 ps.setInt(12, isFollowRedirect() ? 1 : 0);
\r
464 ps.setBoolean(13, isDecompress());
\r
465 ps.setString(14, getAafInstance());
\r
468 // Update the row to set the URLs
\r
469 sql = "update SUBSCRIPTIONS set SELF_LINK = ?, LOG_LINK = ? where SUBID = ?";
\r
470 ps = c.prepareStatement(sql);
\r
471 ps.setString(1, getLinks().getSelf());
\r
472 ps.setString(2, getLinks().getLog());
\r
473 ps.setInt(3, subid);
\r
476 } catch (SQLException e) {
\r
478 intlogger.warn("PROV0005 doInsert: " + e.getMessage(), e);
\r
484 } catch (SQLException e) {
\r
485 intlogger.error(SQLEXCEPTION + e.getMessage(), e);
\r
492 public boolean doUpdate(Connection c) {
\r
494 PreparedStatement ps = null;
\r
496 String sql = "update SUBSCRIPTIONS set DELIVERY_URL = ?, DELIVERY_USER = ?, DELIVERY_PASSWORD = ?, DELIVERY_USE100 = ?, METADATA_ONLY = ?, SUSPENDED = ?, GROUPID = ?, PRIVILEGED_SUBSCRIBER = ?, FOLLOW_REDIRECTS = ?, DECOMPRESS = ? where SUBID = ?";
\r
497 ps = c.prepareStatement(sql);
\r
498 ps.setString(1, delivery.getUrl());
\r
499 ps.setString(2, delivery.getUser());
\r
500 ps.setString(3, delivery.getPassword());
\r
501 ps.setInt(4, delivery.isUse100() ? 1 : 0);
\r
502 ps.setInt(5, isMetadataOnly() ? 1 : 0);
\r
503 ps.setInt(6, suspended ? 1 : 0);
\r
504 ps.setInt(7, groupid); //New field is added - Groups feature Rally:US708115 - 1610
\r
505 ps.setInt(8, privilegedSubscriber ? 1 : 0);
\r
506 ps.setInt(9, isFollowRedirect() ? 1 : 0);
\r
507 ps.setInt(10, isDecompress() ? 1 : 0);
\r
508 ps.setInt(11, subid);
\r
509 ps.executeUpdate();
\r
510 } catch (SQLException e) {
\r
512 intlogger.warn("PROV0006 doUpdate: " + e.getMessage(), e);
\r
518 } catch (SQLException e) {
\r
519 intlogger.error(SQLEXCEPTION + e.getMessage(), e);
\r
527 * Rally US708115 Change Ownership of Subscription - 1610
\r
529 public boolean changeOwnerShip() {
\r
531 PreparedStatement ps = null;
\r
535 @SuppressWarnings("resource")
\r
536 Connection c = db.getConnection();
\r
537 String sql = "update SUBSCRIPTIONS set SUBSCRIBER = ? where SUBID = ?";
\r
538 ps = c.prepareStatement(sql);
\r
539 ps.setString(1, this.subscriber);
\r
540 ps.setInt(2, subid);
\r
543 } catch (SQLException e) {
\r
545 intlogger.warn("PROV0006 doUpdate: " + e.getMessage(), e);
\r
551 } catch (SQLException e) {
\r
552 intlogger.error(SQLEXCEPTION + e.getMessage(), e);
\r
560 public boolean doDelete(Connection c) {
\r
562 PreparedStatement ps = null;
\r
564 String sql = "delete from SUBSCRIPTIONS where SUBID = ?";
\r
565 ps = c.prepareStatement(sql);
\r
566 ps.setInt(1, subid);
\r
568 } catch (SQLException e) {
\r
570 intlogger.warn("PROV0007 doDelete: " + e.getMessage(), e);
\r
576 } catch (SQLException e) {
\r
577 intlogger.error(SQLEXCEPTION + e.getMessage(), e);
\r
584 public String getKey() {
\r
585 return "" + getSubid();
\r
589 public boolean equals(Object obj) {
\r
590 if (!(obj instanceof Subscription)) {
\r
593 Subscription os = (Subscription) obj;
\r
594 if (subid != os.subid) {
\r
597 if (feedid != os.feedid) {
\r
600 if (groupid != os.groupid) //New field is added - Groups feature Rally:US708115 - 1610
\r
604 if (!delivery.equals(os.delivery)) {
\r
607 if (metadataOnly != os.metadataOnly) {
\r
610 if (followRedirect != os.followRedirect) {
\r
613 if (!subscriber.equals(os.subscriber)) {
\r
616 if (!links.equals(os.links)) {
\r
619 if (suspended != os.suspended) {
\r
622 if (!aafInstance.equals(os.aafInstance)) {
\r
629 public int hashCode() {
\r
630 return super.hashCode();
\r
634 public String toString() {
\r
635 return "SUB: subid=" + subid + ", feedid=" + feedid;
\r