Update project structure to org.onap
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / provisioning / beans / Subscription.java
diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Subscription.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Subscription.java
new file mode 100644 (file)
index 0000000..7e9f2ca
--- /dev/null
@@ -0,0 +1,511 @@
+/*******************************************************************************\r
+ * ============LICENSE_START==================================================\r
+ * * org.onap.dmaap\r
+ * * ===========================================================================\r
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * * ===========================================================================\r
+ * * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * * you may not use this file except in compliance with the License.\r
+ * * You may obtain a copy of the License at\r
+ * * \r
+ *  *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * * \r
+ *  * Unless required by applicable law or agreed to in writing, software\r
+ * * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * * See the License for the specific language governing permissions and\r
+ * * limitations under the License.\r
+ * * ============LICENSE_END====================================================\r
+ * *\r
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+ * *\r
+ ******************************************************************************/\r
+\r
+package org.onap.dmaap.datarouter.provisioning.beans;\r
+\r
+import java.io.InvalidObjectException;\r
+import java.sql.Connection;\r
+import java.sql.PreparedStatement;\r
+import java.sql.ResultSet;\r
+import java.sql.SQLException;\r
+import java.sql.Statement;\r
+import java.util.ArrayList;\r
+import java.util.Collection;\r
+import java.util.Date;\r
+import java.util.List;\r
+\r
+import org.apache.log4j.Logger;\r
+import org.json.JSONObject;\r
+import org.onap.dmaap.datarouter.provisioning.utils.DB;\r
+import org.onap.dmaap.datarouter.provisioning.utils.URLUtilities;\r
+\r
+import java.util.Properties;\r
+\r
+/**\r
+ * The representation of a Subscription.  Subscriptions can be retrieved from the DB, or stored/updated in the DB.\r
+ * @author Robert Eby\r
+ * @version $Id: Subscription.java,v 1.9 2013/10/28 18:06:53 eby Exp $\r
+ */\r
+public class Subscription extends Syncable {\r
+       private static Logger intlogger = Logger.getLogger("org.onap.dmaap.datarouter.provisioning.internal");\r
+       private static int next_subid = getMaxSubID() + 1;\r
+\r
+       private int subid;\r
+       private int feedid;\r
+       private int groupid; //New field is added - Groups feature Rally:US708115 - 1610\r
+       private SubDelivery delivery;\r
+       private boolean metadataOnly;\r
+       private String subscriber;\r
+       private SubLinks links;\r
+       private boolean suspended;\r
+       private Date last_mod;\r
+       private Date created_date;\r
+\r
+       public static Subscription getSubscriptionMatching(Subscription sub) {\r
+               SubDelivery deli = sub.getDelivery();\r
+               String sql = String.format(\r
+                       "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
+                       sub.getFeedid(),\r
+                       deli.getUrl(),\r
+                       deli.getUser(),\r
+                       deli.getPassword(),\r
+                       deli.isUse100() ? 1 : 0,\r
+                       sub.isMetadataOnly() ? 1 : 0\r
+               );\r
+               List<Subscription> list = getSubscriptionsForSQL(sql);\r
+               return list.size() > 0 ? list.get(0) : null;\r
+       }\r
+       public static Subscription getSubscriptionById(int id) {\r
+               String sql = "select * from SUBSCRIPTIONS where SUBID = " + id;\r
+               List<Subscription> list = getSubscriptionsForSQL(sql);\r
+               return list.size() > 0 ? list.get(0) : null;\r
+       }\r
+       public static Collection<Subscription> getAllSubscriptions() {\r
+               return getSubscriptionsForSQL("select * from SUBSCRIPTIONS");\r
+       }\r
+       private static List<Subscription> getSubscriptionsForSQL(String sql) {\r
+               List<Subscription> list = new ArrayList<Subscription>();\r
+               try {\r
+                       DB db = new DB();\r
+                       @SuppressWarnings("resource")\r
+                       Connection conn = db.getConnection();\r
+                       Statement  stmt = conn.createStatement();\r
+                       ResultSet rs = stmt.executeQuery(sql);\r
+                       while (rs.next()) {\r
+                               Subscription sub = new Subscription(rs);\r
+                               list.add(sub);\r
+                       }\r
+                       rs.close();\r
+                       stmt.close();\r
+                       db.release(conn);\r
+               } catch (SQLException e) {\r
+                       e.printStackTrace();\r
+               }\r
+               return list;\r
+       }\r
+       public static int getMaxSubID() {\r
+               int max = 0;\r
+               try {\r
+                       DB db = new DB();\r
+                       @SuppressWarnings("resource")\r
+                       Connection conn = db.getConnection();\r
+                       Statement  stmt = conn.createStatement();\r
+                       ResultSet rs = stmt.executeQuery("select MAX(subid) from SUBSCRIPTIONS");\r
+                       if (rs.next()) {\r
+                               max = rs.getInt(1);\r
+                       }\r
+                       rs.close();\r
+                       stmt.close();\r
+                       db.release(conn);\r
+               } catch (SQLException e) {\r
+                       intlogger.info("getMaxSubID: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               }\r
+               return max;\r
+       }\r
+       public static Collection<String> getSubscriptionUrlList(int feedid) {\r
+               List<String> list = new ArrayList<String>();\r
+               String sql = "select SUBID from SUBSCRIPTIONS where FEEDID = "+feedid;\r
+               try {\r
+                       DB db = new DB();\r
+                       @SuppressWarnings("resource")\r
+                       Connection conn = db.getConnection();\r
+                       Statement  stmt = conn.createStatement();\r
+                       ResultSet  rs = stmt.executeQuery(sql);\r
+                       while (rs.next()) {\r
+                               int subid = rs.getInt("SUBID");\r
+                               list.add(URLUtilities.generateSubscriptionURL(subid));\r
+                       }\r
+                       rs.close();\r
+                       stmt.close();\r
+                       db.release(conn);\r
+               } catch (SQLException e) {\r
+                       e.printStackTrace();\r
+               }\r
+               return list;\r
+       }\r
+       /**\r
+        * Return a count of the number of active subscriptions in the DB.\r
+        * @return the count\r
+        */\r
+       public static int countActiveSubscriptions() {\r
+               int count = 0;\r
+               try {\r
+                       DB db = new DB();\r
+                       @SuppressWarnings("resource")\r
+                       Connection conn = db.getConnection();\r
+                       Statement  stmt = conn.createStatement();\r
+                       ResultSet rs = stmt.executeQuery("select count(*) from SUBSCRIPTIONS");\r
+                       if (rs.next()) {\r
+                               count = rs.getInt(1);\r
+                       }\r
+                       rs.close();\r
+                       stmt.close();\r
+                       db.release(conn);\r
+               } catch (SQLException e) {\r
+                       intlogger.warn("PROV0008 countActiveSubscriptions: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               }\r
+               return count;\r
+       }\r
+\r
+       public Subscription() {\r
+               this("", "", "");\r
+       }\r
+       public Subscription(String url, String user, String password) {\r
+               this.subid = -1;\r
+               this.feedid = -1;\r
+               this.groupid = -1; //New field is added - Groups feature Rally:US708115 - 1610\r
+               this.delivery = new SubDelivery(url, user, password, false);\r
+               this.metadataOnly = false;\r
+               this.subscriber = "";\r
+               this.links = new SubLinks();\r
+               this.suspended = false;\r
+               this.last_mod = new Date();\r
+               this.created_date = new Date();\r
+       }\r
+       public Subscription(ResultSet rs) throws SQLException {\r
+               this.subid        = rs.getInt("SUBID");\r
+               this.feedid       = rs.getInt("FEEDID");\r
+               this.groupid       = rs.getInt("GROUPID"); //New field is added - Groups feature Rally:US708115 - 1610\r
+               this.delivery     = new SubDelivery(rs);\r
+               this.metadataOnly = rs.getBoolean("METADATA_ONLY");\r
+               this.subscriber   = rs.getString("SUBSCRIBER");\r
+               this.links        = new SubLinks(rs.getString("SELF_LINK"), URLUtilities.generateFeedURL(feedid), rs.getString("LOG_LINK"));\r
+               this.suspended    = rs.getBoolean("SUSPENDED");\r
+               this.last_mod     = rs.getDate("LAST_MOD");\r
+               this.created_date = rs.getDate("CREATED_DATE");\r
+       }\r
+       public Subscription(JSONObject jo) throws InvalidObjectException {\r
+               this("", "", "");\r
+               try {\r
+                       // The JSONObject is assumed to contain a vnd.att-dr.subscription representation\r
+                       this.subid  = jo.optInt("subid", -1);\r
+                       this.feedid = jo.optInt("feedid", -1);\r
+                       this.groupid = jo.optInt("groupid", -1); //New field is added - Groups feature Rally:US708115 - 1610            \r
+\r
+                       JSONObject jdeli = jo.getJSONObject("delivery");\r
+                       String url      = jdeli.getString("url");\r
+                       String user     = jdeli.getString("user");\r
+                       String password = jdeli.getString("password");\r
+                       boolean use100  = jdeli.getBoolean("use100");\r
+\r
+                       \r
+                       //Data Router Subscriber HTTPS Relaxation feature USERSTORYID:US674047.\r
+                       Properties p = (new DB()).getProperties();\r
+                       if(p.get("com.att.research.datarouter.provserver.https.relaxation").toString().equals("false") && !jo.has("sync")) {\r
+                               if (!url.startsWith("https://"))\r
+                                       throw new InvalidObjectException("delivery URL is not HTTPS");\r
+                       }\r
+\r
+                       if (url.length() > 256)\r
+                               throw new InvalidObjectException("delivery url field is too long");\r
+                       if (user.length() > 20)\r
+                               throw new InvalidObjectException("delivery user field is too long");\r
+                       if (password.length() > 32)\r
+                               throw new InvalidObjectException("delivery password field is too long");\r
+                       this.delivery = new SubDelivery(url, user, password, use100);\r
+\r
+                       this.metadataOnly = jo.getBoolean("metadataOnly");\r
+                       this.suspended    = jo.optBoolean("suspend", false);\r
+\r
+                       this.subscriber = jo.optString("subscriber", "");\r
+                       JSONObject jol = jo.optJSONObject("links");\r
+                       this.links = (jol == null) ? (new SubLinks()) : (new SubLinks(jol));\r
+               } catch (InvalidObjectException e) {\r
+                       throw e;\r
+               } catch (Exception e) {\r
+                       throw new InvalidObjectException("invalid JSON: "+e.getMessage());\r
+               }\r
+       }\r
+       public int getSubid() {\r
+               return subid;\r
+       }\r
+       public void setSubid(int subid) {\r
+               this.subid = subid;\r
+\r
+               // Create link URLs\r
+               SubLinks sl = getLinks();\r
+               sl.setSelf(URLUtilities.generateSubscriptionURL(subid));\r
+               sl.setLog(URLUtilities.generateSubLogURL(subid));\r
+       }\r
+       public int getFeedid() {\r
+               return feedid;\r
+       }\r
+       public void setFeedid(int feedid) {\r
+               this.feedid = feedid;\r
+\r
+               // Create link URLs\r
+               SubLinks sl = getLinks();\r
+               sl.setFeed(URLUtilities.generateFeedURL(feedid));\r
+       }\r
+\r
+       //New getter setters for Groups feature Rally:US708115 - 1610\r
+       public int getGroupid() {               \r
+               return groupid;         \r
+       }               \r
+       public void setGroupid(int groupid) {           \r
+               this.groupid = groupid;         \r
+       }\r
+\r
+       public SubDelivery getDelivery() {\r
+               return delivery;\r
+       }\r
+       public void setDelivery(SubDelivery delivery) {\r
+               this.delivery = delivery;\r
+       }\r
+       public boolean isMetadataOnly() {\r
+               return metadataOnly;\r
+       }\r
+       public void setMetadataOnly(boolean metadataOnly) {\r
+               this.metadataOnly = metadataOnly;\r
+       }\r
+       public boolean isSuspended() {\r
+               return suspended;\r
+       }\r
+       public void setSuspended(boolean suspended) {\r
+               this.suspended = suspended;\r
+       }\r
+       public String getSubscriber() {\r
+               return subscriber;\r
+       }\r
+       public void setSubscriber(String subscriber) {\r
+               if (subscriber != null) {\r
+                       if (subscriber.length() > 8)\r
+                               subscriber = subscriber.substring(0, 8);\r
+                       this.subscriber = subscriber;\r
+               }\r
+       }\r
+       public SubLinks getLinks() {\r
+               return links;\r
+       }\r
+       public void setLinks(SubLinks links) {\r
+               this.links = links;\r
+       }\r
+\r
+       @Override\r
+       public JSONObject asJSONObject() {\r
+               JSONObject jo = new JSONObject();\r
+               jo.put("subid", subid);\r
+               jo.put("feedid", feedid);\r
+               jo.put("groupid", groupid); //New field is added - Groups feature Rally:US708115 - 1610\r
+               jo.put("delivery", delivery.asJSONObject());\r
+               jo.put("metadataOnly", metadataOnly);\r
+               jo.put("subscriber", subscriber);\r
+               jo.put("links", links.asJSONObject());\r
+               jo.put("suspend", suspended);\r
+               jo.put("last_mod", last_mod.getTime());\r
+               jo.put("created_date", created_date.getTime());\r
+               return jo;\r
+       }\r
+       public JSONObject asLimitedJSONObject() {\r
+               JSONObject jo = asJSONObject();\r
+               jo.remove("subid");\r
+               jo.remove("feedid");\r
+               jo.remove("last_mod");\r
+               return jo;\r
+       }\r
+       public JSONObject asJSONObject(boolean hidepasswords) {\r
+               JSONObject jo = asJSONObject();\r
+               if (hidepasswords) {\r
+                       jo.remove("subid");     // we no longer hide passwords, however we do hide these\r
+                       jo.remove("feedid");\r
+                       jo.remove("last_mod");\r
+                       jo.remove("created_date");\r
+               }\r
+               return jo;\r
+       }\r
+       @Override\r
+       public boolean doInsert(Connection c) {\r
+               boolean rv = true;\r
+               PreparedStatement ps = null;\r
+               try {\r
+                       if (subid == -1) {\r
+                               // No feed ID assigned yet, so assign the next available one\r
+                               setSubid(next_subid++);\r
+                       }\r
+                       // In case we insert a feed from synchronization\r
+                       if (subid > next_subid)\r
+                               next_subid = subid+1;\r
+\r
+                       // Create the SUBSCRIPTIONS row\r
+                       String sql = "insert into SUBSCRIPTIONS (SUBID, FEEDID, DELIVERY_URL, DELIVERY_USER, DELIVERY_PASSWORD, DELIVERY_USE100, METADATA_ONLY, SUBSCRIBER, SUSPENDED, GROUPID) values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";\r
+                       ps = c.prepareStatement(sql, new String[] { "SUBID" });\r
+                       ps.setInt(1, subid);\r
+                       ps.setInt(2, feedid);\r
+                       ps.setString(3, getDelivery().getUrl());\r
+                       ps.setString(4, getDelivery().getUser());\r
+                       ps.setString(5, getDelivery().getPassword());\r
+                       ps.setInt(6, getDelivery().isUse100()?1:0);\r
+                       ps.setInt(7, isMetadataOnly()?1:0);\r
+                       ps.setString(8, getSubscriber());\r
+                       ps.setBoolean(9, isSuspended());\r
+                       ps.setInt(10, groupid); //New field is added - Groups feature Rally:US708115 - 1610\r
+                       ps.execute();\r
+                       ps.close();\r
+//                     ResultSet rs = ps.getGeneratedKeys();\r
+//                     rs.first();\r
+//                     setSubid(rs.getInt(1)); // side effect - sets the link URLs\r
+//                     ps.close();\r
+\r
+                       // Update the row to set the URLs\r
+                       sql = "update SUBSCRIPTIONS set SELF_LINK = ?, LOG_LINK = ? where SUBID = ?";\r
+                       ps = c.prepareStatement(sql);\r
+                       ps.setString(1, getLinks().getSelf());\r
+                       ps.setString(2, getLinks().getLog());\r
+                       ps.setInt(3, subid);\r
+                       ps.execute();\r
+                       ps.close();\r
+               } catch (SQLException e) {\r
+                       rv = false;\r
+                       intlogger.warn("PROV0005 doInsert: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               } finally {\r
+                       try {\r
+                               ps.close();\r
+                       } catch (SQLException e) {\r
+                               e.printStackTrace();\r
+                       }\r
+               }\r
+               return rv;\r
+       }\r
+       @Override\r
+       public boolean doUpdate(Connection c) {\r
+               boolean rv = true;\r
+               PreparedStatement ps = null;\r
+               try {\r
+                       String sql = "update SUBSCRIPTIONS set DELIVERY_URL = ?, DELIVERY_USER = ?, DELIVERY_PASSWORD = ?, DELIVERY_USE100 = ?, METADATA_ONLY = ?, SUSPENDED = ?, GROUPID = ? where SUBID = ?";\r
+                       ps = c.prepareStatement(sql);\r
+                       ps.setString(1, delivery.getUrl());\r
+                       ps.setString(2, delivery.getUser());\r
+                       ps.setString(3, delivery.getPassword());\r
+                       ps.setInt(4, delivery.isUse100()?1:0);\r
+                       ps.setInt(5, isMetadataOnly()?1:0);\r
+                       ps.setInt(6, suspended ? 1 : 0);\r
+                       ps.setInt(7, groupid); //New field is added - Groups feature Rally:US708115 - 1610                              \r
+                       ps.setInt(8, subid);\r
+                       ps.executeUpdate();\r
+               } catch (SQLException e) {\r
+                       rv = false;\r
+                       intlogger.warn("PROV0006 doUpdate: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               } finally {\r
+                       try {\r
+                               ps.close();\r
+                       } catch (SQLException e) {\r
+                               e.printStackTrace();\r
+                       }\r
+               }\r
+               return rv;\r
+       }\r
+\r
+\r
+       \r
+       /**Rally US708115\r
+        * Change Ownership of Subscription - 1610\r
+        * */\r
+       public boolean changeOwnerShip() {\r
+               boolean rv = true;\r
+               PreparedStatement ps = null;\r
+               try {\r
+                       \r
+                       DB db = new DB();\r
+                       @SuppressWarnings("resource")\r
+                       Connection c = db.getConnection();\r
+                       String sql = "update SUBSCRIPTIONS set SUBSCRIBER = ? where SUBID = ?";\r
+                       ps = c.prepareStatement(sql);\r
+                       ps.setString(1, this.subscriber);\r
+                       ps.setInt(2, subid);\r
+                       ps.execute();\r
+                       ps.close();\r
+               } catch (SQLException e) {\r
+                       rv = false;\r
+                       intlogger.warn("PROV0006 doUpdate: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               } finally {\r
+                       try {\r
+                               ps.close();\r
+                       } catch (SQLException e) {\r
+                               e.printStackTrace();\r
+                       }\r
+               }\r
+               return rv;\r
+       }\r
+       \r
+\r
+\r
+       @Override\r
+       public boolean doDelete(Connection c) {\r
+               boolean rv = true;\r
+               PreparedStatement ps = null;\r
+               try {\r
+                       String sql = "delete from SUBSCRIPTIONS where SUBID = ?";\r
+                       ps = c.prepareStatement(sql);\r
+                       ps.setInt(1, subid);\r
+                       ps.execute();\r
+               } catch (SQLException e) {\r
+                       rv = false;\r
+                       intlogger.warn("PROV0007 doDelete: "+e.getMessage());\r
+                       e.printStackTrace();\r
+               } finally {\r
+                       try {\r
+                               ps.close();\r
+                       } catch (SQLException e) {\r
+                               e.printStackTrace();\r
+                       }\r
+               }\r
+               return rv;\r
+       }\r
+       @Override\r
+       public String getKey() {\r
+               return ""+getSubid();\r
+       }\r
+       @Override\r
+       public boolean equals(Object obj) {\r
+               if (!(obj instanceof Subscription))\r
+                       return false;\r
+               Subscription os = (Subscription) obj;\r
+               if (subid != os.subid)\r
+                       return false;\r
+               if (feedid != os.feedid)\r
+                       return false;\r
+               if (groupid != os.groupid) //New field is added - Groups feature Rally:US708115 - 1610           \r
+                       return false;\r
+               if (!delivery.equals(os.delivery))\r
+                       return false;\r
+               if (metadataOnly != os.metadataOnly)\r
+                       return false;\r
+               if (!subscriber.equals(os.subscriber))\r
+                       return false;\r
+               if (!links.equals(os.links))\r
+                       return false;\r
+               if (suspended != os.suspended)\r
+                       return false;\r
+               return true;\r
+       }\r
+\r
+       @Override\r
+       public String toString() {\r
+               return "SUB: subid=" + subid + ", feedid=" + feedid;\r
+       }\r
+}\r