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