datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Parameters.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.sql.Connection;\r
  27 import java.sql.PreparedStatement;\r
  28 import java.sql.ResultSet;\r
  29 import java.sql.SQLException;\r
  30 import java.sql.Statement;\r
  31 import java.util.*;\r
  32 \r
  33 import com.att.eelf.configuration.EELFLogger;\r
  34 import com.att.eelf.configuration.EELFManager;\r
  35 import org.json.JSONObject;\r
  36 import org.onap.dmaap.datarouter.provisioning.utils.DB;\r
  37 \r
  38 /**\r
  39  * Methods to provide access to Provisioning parameters in the DB. This class also provides constants of the standard\r
  40  * parameters used by the Data Router.\r
  41  *\r
  42  * @author Robert Eby\r
  43  * @version $Id: Parameters.java,v 1.11 2014/03/12 19:45:41 eby Exp $\r
  44  */\r
  45 public class Parameters extends Syncable {\r
  46 \r
  47     public static final String PROV_REQUIRE_SECURE = "PROV_REQUIRE_SECURE";\r
  48     public static final String PROV_REQUIRE_CERT = "PROV_REQUIRE_CERT";\r
  49     public static final String PROV_AUTH_ADDRESSES = "PROV_AUTH_ADDRESSES";\r
  50     public static final String PROV_AUTH_SUBJECTS = "PROV_AUTH_SUBJECTS";\r
  51     public static final String PROV_NAME = "PROV_NAME";\r
  52     public static final String PROV_ACTIVE_NAME = "PROV_ACTIVE_NAME";\r
  53     public static final String PROV_DOMAIN = "PROV_DOMAIN";\r
  54     public static final String PROV_MAXFEED_COUNT = "PROV_MAXFEED_COUNT";\r
  55     public static final String PROV_MAXSUB_COUNT = "PROV_MAXSUB_COUNT";\r
  56     public static final String PROV_POKETIMER1 = "PROV_POKETIMER1";\r
  57     public static final String PROV_POKETIMER2 = "PROV_POKETIMER2";\r
  58     public static final String PROV_SPECIAL_SUBNET = "PROV_SPECIAL_SUBNET";\r
  59     public static final String PROV_LOG_RETENTION = "PROV_LOG_RETENTION";\r
  60     public static final String NODES = "NODES";\r
  61     public static final String ACTIVE_POD = "ACTIVE_POD";\r
  62     public static final String STANDBY_POD = "STANDBY_POD";\r
  63     public static final String LOGROLL_INTERVAL = "LOGROLL_INTERVAL";\r
  64     public static final String DELIVERY_INIT_RETRY_INTERVAL = "DELIVERY_INIT_RETRY_INTERVAL";\r
  65     public static final String DELIVERY_MAX_RETRY_INTERVAL = "DELIVERY_MAX_RETRY_INTERVAL";\r
  66     public static final String DELIVERY_RETRY_RATIO = "DELIVERY_RETRY_RATIO";\r
  67     public static final String DELIVERY_MAX_AGE = "DELIVERY_MAX_AGE";\r
  68     public static final String THROTTLE_FILTER = "THROTTLE_FILTER";\r
  69     public static final String STATIC_ROUTING_NODES = "STATIC_ROUTING_NODES"; //Adding new param for static Routing - Rally:US664862-1610\r
  70 \r
  71     private static EELFLogger intlogger = EELFManager.getInstance().getLogger("InternalLog");\r
  72     private static final String SQLEXCEPTION = "SQLException: ";\r
  73 \r
  74     private String keyname;\r
  75     private String value;\r
  76 \r
  77     /**\r
  78      * Get all parameters in the DB as a Map.\r
  79      *\r
  80      * @return the Map of keynames/values from the DB.\r
  81      */\r
  82     public static Map<String, String> getParameters() {\r
  83         Map<String, String> props = new HashMap<String, String>();\r
  84         for (Parameters p : getParameterCollection()) {\r
  85             props.put(p.getKeyname(), p.getValue());\r
  86         }\r
  87         return props;\r
  88     }\r
  89 \r
  90     public static Collection<Parameters> getParameterCollection() {\r
  91         Collection<Parameters> coll = new ArrayList<Parameters>();\r
  92         try {\r
  93             DB db = new DB();\r
  94             @SuppressWarnings("resource")\r
  95             Connection conn = db.getConnection();\r
  96             try (Statement stmt = conn.createStatement()) {\r
  97                 String sql = "select * from PARAMETERS";\r
  98                 try (ResultSet rs = stmt.executeQuery(sql)) {\r
  99                     while (rs.next()) {\r
 100                         Parameters p = new Parameters(rs);\r
 101                         coll.add(p);\r
 102                     }\r
 103                 }\r
 104             }\r
 105             db.release(conn);\r
 106         } catch (SQLException e) {\r
 107             intlogger.error(SQLEXCEPTION + e.getMessage());\r
 108         }\r
 109         return coll;\r
 110     }\r
 111 \r
 112     /**\r
 113      * Get a specific parameter value from the DB.\r
 114      *\r
 115      * @param k the key to lookup\r
 116      * @return the value, or null if non-existant\r
 117      */\r
 118     public static Parameters getParameter(String k) {\r
 119         Parameters v = null;\r
 120         try {\r
 121             DB db = new DB();\r
 122             @SuppressWarnings("resource")\r
 123             Connection conn = db.getConnection();\r
 124             try (PreparedStatement stmt = conn\r
 125                     .prepareStatement("select KEYNAME, VALUE from PARAMETERS where KEYNAME = ?")) {\r
 126                 stmt.setString(1, k);\r
 127                 try (ResultSet rs = stmt.executeQuery()) {\r
 128                     if (rs.next()) {\r
 129                         v = new Parameters(rs);\r
 130                     }\r
 131                 }\r
 132             }\r
 133             db.release(conn);\r
 134         } catch (SQLException e) {\r
 135             intlogger.error(SQLEXCEPTION + e.getMessage());\r
 136         }\r
 137         return v;\r
 138     }\r
 139 \r
 140     public Parameters() {\r
 141         this("", "");\r
 142     }\r
 143 \r
 144     public Parameters(String k, String v) {\r
 145         this.keyname = k;\r
 146         this.value = v;\r
 147     }\r
 148 \r
 149     public Parameters(ResultSet rs) throws SQLException {\r
 150         this.keyname = rs.getString("KEYNAME");\r
 151         this.value = rs.getString("VALUE");\r
 152     }\r
 153 \r
 154     public String getKeyname() {\r
 155         return keyname;\r
 156     }\r
 157 \r
 158     public void setKeyname(String keyname) {\r
 159         this.keyname = keyname;\r
 160     }\r
 161 \r
 162     public String getValue() {\r
 163         return value;\r
 164     }\r
 165 \r
 166     public void setValue(String value) {\r
 167         this.value = value;\r
 168     }\r
 169 \r
 170     @Override\r
 171     public JSONObject asJSONObject() {\r
 172         JSONObject jo = new JSONObject();\r
 173         jo.put("keyname", keyname);\r
 174         jo.put("value", value);\r
 175         return jo;\r
 176     }\r
 177 \r
 178     @Override\r
 179     public boolean doInsert(Connection c) {\r
 180         boolean rv = true;\r
 181         PreparedStatement ps = null;\r
 182         try {\r
 183             // Create the SUBSCRIPTIONS row\r
 184             String sql = "insert into PARAMETERS values (?, ?)";\r
 185             ps = c.prepareStatement(sql);\r
 186             ps.setString(1, getKeyname());\r
 187             ps.setString(2, getValue());\r
 188             ps.execute();\r
 189         } catch (SQLException e) {\r
 190             rv = false;\r
 191             intlogger.warn("PROV0005 doInsert: " + e.getMessage(), e);\r
 192         } finally {\r
 193             try {\r
 194                 if (ps != null) {\r
 195                     ps.close();\r
 196                 }\r
 197             } catch (SQLException e) {\r
 198                 intlogger.error(SQLEXCEPTION + e.getMessage());\r
 199             }\r
 200         }\r
 201         return rv;\r
 202     }\r
 203 \r
 204     @Override\r
 205     public boolean doUpdate(Connection c) {\r
 206         boolean rv = true;\r
 207         PreparedStatement ps = null;\r
 208         try {\r
 209             // Update the PARAMETERS row\r
 210             String sql = "update PARAMETERS set VALUE = ? where KEYNAME = ?";\r
 211             ps = c.prepareStatement(sql);\r
 212             ps.setString(1, getValue());\r
 213             ps.setString(2, getKeyname());\r
 214             ps.executeUpdate();\r
 215         } catch (SQLException e) {\r
 216             rv = false;\r
 217             intlogger.warn("PROV0006 doUpdate: " + e.getMessage(),e);\r
 218         } finally {\r
 219             try {\r
 220                 if (ps != null) {\r
 221                     ps.close();\r
 222                 }\r
 223             } catch (SQLException e) {\r
 224                 intlogger.error(SQLEXCEPTION + e.getMessage(), e);\r
 225             }\r
 226         }\r
 227         return rv;\r
 228     }\r
 229 \r
 230     @Override\r
 231     public boolean doDelete(Connection c) {\r
 232         boolean rv = true;\r
 233         PreparedStatement ps = null;\r
 234         try {\r
 235             // Create the SUBSCRIPTIONS row\r
 236             String sql = "delete from PARAMETERS where KEYNAME = ?";\r
 237             ps = c.prepareStatement(sql);\r
 238             ps.setString(1, getKeyname());\r
 239             ps.execute();\r
 240         } catch (SQLException e) {\r
 241             rv = false;\r
 242             intlogger.warn("PROV0007 doDelete: " + e.getMessage(), e);\r
 243         } finally {\r
 244             try {\r
 245                 if (ps != null) {\r
 246                     ps.close();\r
 247                 }\r
 248             } catch (SQLException e) {\r
 249                 intlogger.error(SQLEXCEPTION + e.getMessage(), e);\r
 250             }\r
 251         }\r
 252         return rv;\r
 253     }\r
 254 \r
 255     @Override\r
 256     public String getKey() {\r
 257         return getKeyname();\r
 258     }\r
 259 \r
 260     @Override\r
 261     public boolean equals(Object obj) {\r
 262         if (!(obj instanceof Parameters)) {\r
 263             return false;\r
 264         }\r
 265         Parameters of = (Parameters) obj;\r
 266         if (!keyname.equals(of.keyname)) {\r
 267             return false;\r
 268         }\r
 269         if (!value.equals(of.value)) {\r
 270             return false;\r
 271         }\r
 272         return true;\r
 273     }\r
 274 \r
 275     @Override\r
 276     public int hashCode() {\r
 277         return Objects.hash(keyname, value);\r
 278     }\r
 279 \r
 280     @Override\r
 281     public String toString() {\r
 282         return "PARAM: keyname=" + keyname + ", value=" + value;\r
 283     }\r
 284 }\r
 285 \r