datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Subscription.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\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
  10  * *\r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * *\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
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 \r
  24 package org.onap.dmaap.datarouter.provisioning.beans;\r
  25 \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 \r
  37 import org.apache.log4j.Logger;\r
  38 import org.json.JSONObject;\r
  39 import org.onap.dmaap.datarouter.provisioning.utils.DB;\r
  40 import org.onap.dmaap.datarouter.provisioning.utils.URLUtilities;\r
  41 \r
  42 import java.util.Properties;\r
  43 \r
  44 /**\r
  45  * The representation of a Subscription.  Subscriptions can be retrieved from the DB, or stored/updated in the DB.\r
  46  *\r
  47  * @author Robert Eby\r
  48  * @version $Id: Subscription.java,v 1.9 2013/10/28 18:06:53 eby Exp $\r
  49  */\r
  50 public class Subscription extends Syncable {\r
  51     private static Logger intlogger = Logger.getLogger("org.onap.dmaap.datarouter.provisioning.internal");\r
  52     private static int next_subid = getMaxSubID() + 1;\r
  53 \r
  54     private int subid;\r
  55     private int feedid;\r
  56     private int groupid; //New field is added - Groups feature Rally:US708115 - 1610\r
  57     private SubDelivery delivery;\r
  58     private boolean metadataOnly;\r
  59     private String subscriber;\r
  60     private SubLinks links;\r
  61     private boolean suspended;\r
  62     private Date last_mod;\r
  63     private Date created_date;\r
  64 \r
  65     public static Subscription getSubscriptionMatching(Subscription sub) {\r
  66         SubDelivery deli = sub.getDelivery();\r
  67         String sql = String.format(\r
  68                 "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",\r
  69                 sub.getFeedid(),\r
  70                 deli.getUrl(),\r
  71                 deli.getUser(),\r
  72                 deli.getPassword(),\r
  73                 deli.isUse100() ? 1 : 0,\r
  74                 sub.isMetadataOnly() ? 1 : 0\r
  75         );\r
  76         List<Subscription> list = getSubscriptionsForSQL(sql);\r
  77         return list.size() > 0 ? list.get(0) : null;\r
  78     }\r
  79 \r
  80     public static Subscription getSubscriptionById(int id) {\r
  81         String sql = "select * from SUBSCRIPTIONS where SUBID = " + id;\r
  82         List<Subscription> list = getSubscriptionsForSQL(sql);\r
  83         return list.size() > 0 ? list.get(0) : null;\r
  84     }\r
  85 \r
  86     public static Collection<Subscription> getAllSubscriptions() {\r
  87         return getSubscriptionsForSQL("select * from SUBSCRIPTIONS");\r
  88     }\r
  89 \r
  90     private static List<Subscription> getSubscriptionsForSQL(String sql) {\r
  91         List<Subscription> list = new ArrayList<Subscription>();\r
  92         try {\r
  93             DB db = new DB();\r
  94             @SuppressWarnings("resource")\r
  95             Connection conn = db.getConnection();\r
  96             Statement stmt = conn.createStatement();\r
  97             ResultSet rs = stmt.executeQuery(sql);\r
  98             while (rs.next()) {\r
  99                 Subscription sub = new Subscription(rs);\r
 100                 list.add(sub);\r
 101             }\r
 102             rs.close();\r
 103             stmt.close();\r
 104             db.release(conn);\r
 105         } catch (SQLException e) {\r
 106             e.printStackTrace();\r
 107         }\r
 108         return list;\r
 109     }\r
 110 \r
 111     public static int getMaxSubID() {\r
 112         int max = 0;\r
 113         try {\r
 114             DB db = new DB();\r
 115             @SuppressWarnings("resource")\r
 116             Connection conn = db.getConnection();\r
 117             Statement stmt = conn.createStatement();\r
 118             ResultSet rs = stmt.executeQuery("select MAX(subid) from SUBSCRIPTIONS");\r
 119             if (rs.next()) {\r
 120                 max = rs.getInt(1);\r
 121             }\r
 122             rs.close();\r
 123             stmt.close();\r
 124             db.release(conn);\r
 125         } catch (SQLException e) {\r
 126             intlogger.info("getMaxSubID: " + e.getMessage());\r
 127             e.printStackTrace();\r
 128         }\r
 129         return max;\r
 130     }\r
 131 \r
 132     public static Collection<String> getSubscriptionUrlList(int feedid) {\r
 133         List<String> list = new ArrayList<String>();\r
 134         String sql = "select SUBID from SUBSCRIPTIONS where FEEDID = " + feedid;\r
 135         try {\r
 136             DB db = new DB();\r
 137             @SuppressWarnings("resource")\r
 138             Connection conn = db.getConnection();\r
 139             Statement stmt = conn.createStatement();\r
 140             ResultSet rs = stmt.executeQuery(sql);\r
 141             while (rs.next()) {\r
 142                 int subid = rs.getInt("SUBID");\r
 143                 list.add(URLUtilities.generateSubscriptionURL(subid));\r
 144             }\r
 145             rs.close();\r
 146             stmt.close();\r
 147             db.release(conn);\r
 148         } catch (SQLException e) {\r
 149             e.printStackTrace();\r
 150         }\r
 151         return list;\r
 152     }\r
 153 \r
 154     /**\r
 155      * Return a count of the number of active subscriptions in the DB.\r
 156      *\r
 157      * @return the count\r
 158      */\r
 159     public static int countActiveSubscriptions() {\r
 160         int count = 0;\r
 161         try {\r
 162             DB db = new DB();\r
 163             @SuppressWarnings("resource")\r
 164             Connection conn = db.getConnection();\r
 165             Statement stmt = conn.createStatement();\r
 166             ResultSet rs = stmt.executeQuery("select count(*) from SUBSCRIPTIONS");\r
 167             if (rs.next()) {\r
 168                 count = rs.getInt(1);\r
 169             }\r
 170             rs.close();\r
 171             stmt.close();\r
 172             db.release(conn);\r
 173         } catch (SQLException e) {\r
 174             intlogger.warn("PROV0008 countActiveSubscriptions: " + e.getMessage());\r
 175             e.printStackTrace();\r
 176         }\r
 177         return count;\r
 178     }\r
 179 \r
 180     public Subscription() {\r
 181         this("", "", "");\r
 182     }\r
 183 \r
 184     public Subscription(String url, String user, String password) {\r
 185         this.subid = -1;\r
 186         this.feedid = -1;\r
 187         this.groupid = -1; //New field is added - Groups feature Rally:US708115 - 1610\r
 188         this.delivery = new SubDelivery(url, user, password, false);\r
 189         this.metadataOnly = false;\r
 190         this.subscriber = "";\r
 191         this.links = new SubLinks();\r
 192         this.suspended = false;\r
 193         this.last_mod = new Date();\r
 194         this.created_date = new Date();\r
 195     }\r
 196 \r
 197     public Subscription(ResultSet rs) throws SQLException {\r
 198         this.subid = rs.getInt("SUBID");\r
 199         this.feedid = rs.getInt("FEEDID");\r
 200         this.groupid = rs.getInt("GROUPID"); //New field is added - Groups feature Rally:US708115 - 1610\r
 201         this.delivery = new SubDelivery(rs);\r
 202         this.metadataOnly = rs.getBoolean("METADATA_ONLY");\r
 203         this.subscriber = rs.getString("SUBSCRIBER");\r
 204         this.links = new SubLinks(rs.getString("SELF_LINK"), URLUtilities.generateFeedURL(feedid), rs.getString("LOG_LINK"));\r
 205         this.suspended = rs.getBoolean("SUSPENDED");\r
 206         this.last_mod = rs.getDate("LAST_MOD");\r
 207         this.created_date = rs.getDate("CREATED_DATE");\r
 208     }\r
 209 \r
 210     public Subscription(JSONObject jo) throws InvalidObjectException {\r
 211         this("", "", "");\r
 212         try {\r
 213             // The JSONObject is assumed to contain a vnd.att-dr.subscription representation\r
 214             this.subid = jo.optInt("subid", -1);\r
 215             this.feedid = jo.optInt("feedid", -1);\r
 216             this.groupid = jo.optInt("groupid", -1); //New field is added - Groups feature Rally:US708115 - 1610\r
 217 \r
 218             JSONObject jdeli = jo.getJSONObject("delivery");\r
 219             String url = jdeli.getString("url");\r
 220             String user = jdeli.getString("user");\r
 221             String password = jdeli.getString("password");\r
 222             boolean use100 = jdeli.getBoolean("use100");\r
 223 \r
 224 \r
 225             //Data Router Subscriber HTTPS Relaxation feature USERSTORYID:US674047.\r
 226             Properties p = (new DB()).getProperties();\r
 227             if (p.get("org.onap.dmaap.datarouter.provserver.https.relaxation").toString().equals("false") && !jo.has("sync")) {\r
 228                 if (!url.startsWith("https://"))\r
 229                     throw new InvalidObjectException("delivery URL is not HTTPS");\r
 230             }\r
 231 \r
 232             if (url.length() > 256)\r
 233                 throw new InvalidObjectException("delivery url field is too long");\r
 234             if (user.length() > 20)\r
 235                 throw new InvalidObjectException("delivery user field is too long");\r
 236             if (password.length() > 32)\r
 237                 throw new InvalidObjectException("delivery password field is too long");\r
 238             this.delivery = new SubDelivery(url, user, password, use100);\r
 239 \r
 240             this.metadataOnly = jo.getBoolean("metadataOnly");\r
 241             this.suspended = jo.optBoolean("suspend", false);\r
 242 \r
 243             this.subscriber = jo.optString("subscriber", "");\r
 244             JSONObject jol = jo.optJSONObject("links");\r
 245             this.links = (jol == null) ? (new SubLinks()) : (new SubLinks(jol));\r
 246         } catch (InvalidObjectException e) {\r
 247             throw e;\r
 248         } catch (Exception e) {\r
 249             throw new InvalidObjectException("invalid JSON: " + e.getMessage());\r
 250         }\r
 251     }\r
 252 \r
 253     public int getSubid() {\r
 254         return subid;\r
 255     }\r
 256 \r
 257     public void setSubid(int subid) {\r
 258         this.subid = subid;\r
 259 \r
 260         // Create link URLs\r
 261         SubLinks sl = getLinks();\r
 262         sl.setSelf(URLUtilities.generateSubscriptionURL(subid));\r
 263         sl.setLog(URLUtilities.generateSubLogURL(subid));\r
 264     }\r
 265 \r
 266     public int getFeedid() {\r
 267         return feedid;\r
 268     }\r
 269 \r
 270     public void setFeedid(int feedid) {\r
 271         this.feedid = feedid;\r
 272 \r
 273         // Create link URLs\r
 274         SubLinks sl = getLinks();\r
 275         sl.setFeed(URLUtilities.generateFeedURL(feedid));\r
 276     }\r
 277 \r
 278     //New getter setters for Groups feature Rally:US708115 - 1610\r
 279     public int getGroupid() {\r
 280         return groupid;\r
 281     }\r
 282 \r
 283     public void setGroupid(int groupid) {\r
 284         this.groupid = groupid;\r
 285     }\r
 286 \r
 287     public SubDelivery getDelivery() {\r
 288         return delivery;\r
 289     }\r
 290 \r
 291     public void setDelivery(SubDelivery delivery) {\r
 292         this.delivery = delivery;\r
 293     }\r
 294 \r
 295     public boolean isMetadataOnly() {\r
 296         return metadataOnly;\r
 297     }\r
 298 \r
 299     public void setMetadataOnly(boolean metadataOnly) {\r
 300         this.metadataOnly = metadataOnly;\r
 301     }\r
 302 \r
 303     public boolean isSuspended() {\r
 304         return suspended;\r
 305     }\r
 306 \r
 307     public void setSuspended(boolean suspended) {\r
 308         this.suspended = suspended;\r
 309     }\r
 310 \r
 311     public String getSubscriber() {\r
 312         return subscriber;\r
 313     }\r
 314 \r
 315     public void setSubscriber(String subscriber) {\r
 316         if (subscriber != null) {\r
 317             if (subscriber.length() > 8)\r
 318                 subscriber = subscriber.substring(0, 8);\r
 319             this.subscriber = subscriber;\r
 320         }\r
 321     }\r
 322 \r
 323     public SubLinks getLinks() {\r
 324         return links;\r
 325     }\r
 326 \r
 327     public void setLinks(SubLinks links) {\r
 328         this.links = links;\r
 329     }\r
 330 \r
 331     @Override\r
 332     public JSONObject asJSONObject() {\r
 333         JSONObject jo = new JSONObject();\r
 334         jo.put("subid", subid);\r
 335         jo.put("feedid", feedid);\r
 336         jo.put("groupid", groupid); //New field is added - Groups feature Rally:US708115 - 1610\r
 337         jo.put("delivery", delivery.asJSONObject());\r
 338         jo.put("metadataOnly", metadataOnly);\r
 339         jo.put("subscriber", subscriber);\r
 340         jo.put("links", links.asJSONObject());\r
 341         jo.put("suspend", suspended);\r
 342         jo.put("last_mod", last_mod.getTime());\r
 343         jo.put("created_date", created_date.getTime());\r
 344         return jo;\r
 345     }\r
 346 \r
 347     public JSONObject asLimitedJSONObject() {\r
 348         JSONObject jo = asJSONObject();\r
 349         jo.remove("subid");\r
 350         jo.remove("feedid");\r
 351         jo.remove("last_mod");\r
 352         return jo;\r
 353     }\r
 354 \r
 355     public JSONObject asJSONObject(boolean hidepasswords) {\r
 356         JSONObject jo = asJSONObject();\r
 357         if (hidepasswords) {\r
 358             jo.remove("subid");    // we no longer hide passwords, however we do hide these\r
 359             jo.remove("feedid");\r
 360             jo.remove("last_mod");\r
 361             jo.remove("created_date");\r
 362         }\r
 363         return jo;\r
 364     }\r
 365 \r
 366     @Override\r
 367     public boolean doInsert(Connection c) {\r
 368         boolean rv = true;\r
 369         PreparedStatement ps = null;\r
 370         try {\r
 371             if (subid == -1) {\r
 372                 // No feed ID assigned yet, so assign the next available one\r
 373                 setSubid(next_subid++);\r
 374             }\r
 375             // In case we insert a feed from synchronization\r
 376             if (subid > next_subid)\r
 377                 next_subid = subid + 1;\r
 378 \r
 379             // Create the SUBSCRIPTIONS row\r
 380             String sql = "insert into SUBSCRIPTIONS (SUBID, FEEDID, DELIVERY_URL, DELIVERY_USER, DELIVERY_PASSWORD, DELIVERY_USE100, METADATA_ONLY, SUBSCRIBER, SUSPENDED, GROUPID) values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";\r
 381             ps = c.prepareStatement(sql, new String[]{"SUBID"});\r
 382             ps.setInt(1, subid);\r
 383             ps.setInt(2, feedid);\r
 384             ps.setString(3, getDelivery().getUrl());\r
 385             ps.setString(4, getDelivery().getUser());\r
 386             ps.setString(5, getDelivery().getPassword());\r
 387             ps.setInt(6, getDelivery().isUse100() ? 1 : 0);\r
 388             ps.setInt(7, isMetadataOnly() ? 1 : 0);\r
 389             ps.setString(8, getSubscriber());\r
 390             ps.setBoolean(9, isSuspended());\r
 391             ps.setInt(10, groupid); //New field is added - Groups feature Rally:US708115 - 1610\r
 392             ps.execute();\r
 393             ps.close();\r
 394 //            ResultSet rs = ps.getGeneratedKeys();\r
 395 //            rs.first();\r
 396 //            setSubid(rs.getInt(1));    // side effect - sets the link URLs\r
 397 //            ps.close();\r
 398 \r
 399             // Update the row to set the URLs\r
 400             sql = "update SUBSCRIPTIONS set SELF_LINK = ?, LOG_LINK = ? where SUBID = ?";\r
 401             ps = c.prepareStatement(sql);\r
 402             ps.setString(1, getLinks().getSelf());\r
 403             ps.setString(2, getLinks().getLog());\r
 404             ps.setInt(3, subid);\r
 405             ps.execute();\r
 406             ps.close();\r
 407         } catch (SQLException e) {\r
 408             rv = false;\r
 409             intlogger.warn("PROV0005 doInsert: " + e.getMessage());\r
 410             e.printStackTrace();\r
 411         } finally {\r
 412             try {\r
 413                 ps.close();\r
 414             } catch (SQLException e) {\r
 415                 e.printStackTrace();\r
 416             }\r
 417         }\r
 418         return rv;\r
 419     }\r
 420 \r
 421     @Override\r
 422     public boolean doUpdate(Connection c) {\r
 423         boolean rv = true;\r
 424         PreparedStatement ps = null;\r
 425         try {\r
 426             String sql = "update SUBSCRIPTIONS set DELIVERY_URL = ?, DELIVERY_USER = ?, DELIVERY_PASSWORD = ?, DELIVERY_USE100 = ?, METADATA_ONLY = ?, SUSPENDED = ?, GROUPID = ? where SUBID = ?";\r
 427             ps = c.prepareStatement(sql);\r
 428             ps.setString(1, delivery.getUrl());\r
 429             ps.setString(2, delivery.getUser());\r
 430             ps.setString(3, delivery.getPassword());\r
 431             ps.setInt(4, delivery.isUse100() ? 1 : 0);\r
 432             ps.setInt(5, isMetadataOnly() ? 1 : 0);\r
 433             ps.setInt(6, suspended ? 1 : 0);\r
 434             ps.setInt(7, groupid); //New field is added - Groups feature Rally:US708115 - 1610\r
 435             ps.setInt(8, subid);\r
 436             ps.executeUpdate();\r
 437         } catch (SQLException e) {\r
 438             rv = false;\r
 439             intlogger.warn("PROV0006 doUpdate: " + e.getMessage());\r
 440             e.printStackTrace();\r
 441         } finally {\r
 442             try {\r
 443                 ps.close();\r
 444             } catch (SQLException e) {\r
 445                 e.printStackTrace();\r
 446             }\r
 447         }\r
 448         return rv;\r
 449     }\r
 450 \r
 451 \r
 452     /**\r
 453      * Rally US708115\r
 454      * Change Ownership of Subscription - 1610\r
 455      */\r
 456     public boolean changeOwnerShip() {\r
 457         boolean rv = true;\r
 458         PreparedStatement ps = null;\r
 459         try {\r
 460 \r
 461             DB db = new DB();\r
 462             @SuppressWarnings("resource")\r
 463             Connection c = db.getConnection();\r
 464             String sql = "update SUBSCRIPTIONS set SUBSCRIBER = ? where SUBID = ?";\r
 465             ps = c.prepareStatement(sql);\r
 466             ps.setString(1, this.subscriber);\r
 467             ps.setInt(2, subid);\r
 468             ps.execute();\r
 469             ps.close();\r
 470         } catch (SQLException e) {\r
 471             rv = false;\r
 472             intlogger.warn("PROV0006 doUpdate: " + e.getMessage());\r
 473             e.printStackTrace();\r
 474         } finally {\r
 475             try {\r
 476                 ps.close();\r
 477             } catch (SQLException e) {\r
 478                 e.printStackTrace();\r
 479             }\r
 480         }\r
 481         return rv;\r
 482     }\r
 483 \r
 484 \r
 485     @Override\r
 486     public boolean doDelete(Connection c) {\r
 487         boolean rv = true;\r
 488         PreparedStatement ps = null;\r
 489         try {\r
 490             String sql = "delete from SUBSCRIPTIONS where SUBID = ?";\r
 491             ps = c.prepareStatement(sql);\r
 492             ps.setInt(1, subid);\r
 493             ps.execute();\r
 494         } catch (SQLException e) {\r
 495             rv = false;\r
 496             intlogger.warn("PROV0007 doDelete: " + e.getMessage());\r
 497             e.printStackTrace();\r
 498         } finally {\r
 499             try {\r
 500                 ps.close();\r
 501             } catch (SQLException e) {\r
 502                 e.printStackTrace();\r
 503             }\r
 504         }\r
 505         return rv;\r
 506     }\r
 507 \r
 508     @Override\r
 509     public String getKey() {\r
 510         return "" + getSubid();\r
 511     }\r
 512 \r
 513     @Override\r
 514     public boolean equals(Object obj) {\r
 515         if (!(obj instanceof Subscription))\r
 516             return false;\r
 517         Subscription os = (Subscription) obj;\r
 518         if (subid != os.subid)\r
 519             return false;\r
 520         if (feedid != os.feedid)\r
 521             return false;\r
 522         if (groupid != os.groupid) //New field is added - Groups feature Rally:US708115 - 1610\r
 523             return false;\r
 524         if (!delivery.equals(os.delivery))\r
 525             return false;\r
 526         if (metadataOnly != os.metadataOnly)\r
 527             return false;\r
 528         if (!subscriber.equals(os.subscriber))\r
 529             return false;\r
 530         if (!links.equals(os.links))\r
 531             return false;\r
 532         if (suspended != os.suspended)\r
 533             return false;\r
 534         return true;\r
 535     }\r
 536 \r
 537     @Override\r
 538     public String toString() {\r
 539         return "SUB: subid=" + subid + ", feedid=" + feedid;\r
 540     }\r
 541 }\r