More unit test coverage and code cleanup
[dmaap/datarouter.git] / datarouter-prov / src / main / java / org / onap / dmaap / datarouter / provisioning / beans / EgressRoute.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 \r
25 package org.onap.dmaap.datarouter.provisioning.beans;\r
26 \r
27 import com.att.eelf.configuration.EELFLogger;\r
28 import com.att.eelf.configuration.EELFManager;\r
29 import java.sql.Connection;\r
30 import java.sql.PreparedStatement;\r
31 import java.sql.ResultSet;\r
32 import java.sql.SQLException;\r
33 import java.sql.Statement;\r
34 import java.util.Objects;\r
35 import java.util.SortedSet;\r
36 import java.util.TreeSet;\r
37 import org.json.JSONObject;\r
38 import org.onap.dmaap.datarouter.provisioning.utils.DB;\r
39 \r
40 /**\r
41  * The representation of one route in the Egress Route Table.\r
42  *\r
43  * @author Robert P. Eby\r
44  * @version $Id: EgressRoute.java,v 1.3 2013/12/16 20:30:23 eby Exp $\r
45  */\r
46 public class EgressRoute extends NodeClass implements Comparable<EgressRoute> {\r
47 \r
48     private static EELFLogger intlogger = EELFManager.getInstance().getLogger("InternalLog");\r
49     private final int subid;\r
50     private final int nodeid;\r
51 \r
52     public EgressRoute(int subid, int nodeid) {\r
53         this.subid = subid;\r
54         this.nodeid = nodeid;\r
55         // Note: unlike for Feeds, it subscriptions can be removed from the tables, so it is\r
56         // possible that an orphan ERT entry can exist if a sub is removed.\r
57         //        if (Subscription.getSubscriptionById(subid) == null)\r
58         //            throw new IllegalArgumentException("No such subscription: "+subid);\r
59     }\r
60 \r
61     public EgressRoute(int subid, String node) {\r
62         this(subid, lookupNodeName(node));\r
63     }\r
64 \r
65     /**\r
66      * Get a set of all Egress Routes in the DB.  The set is sorted according to the natural sorting order of the routes\r
67      * (based on the subscription ID in each route).\r
68      *\r
69      * @return the sorted set\r
70      */\r
71     public static SortedSet<EgressRoute> getAllEgressRoutes() {\r
72         SortedSet<EgressRoute> set = new TreeSet<>();\r
73         DB db = new DB();\r
74         String sql = "select SUBID, NODEID from EGRESS_ROUTES";\r
75         try (Connection conn = db.getConnection()) {\r
76             try (Statement stmt = conn.createStatement()) {\r
77                 try (ResultSet rs = stmt.executeQuery(sql)) {\r
78                     addEgressRouteToSet(set, rs);\r
79                 }\r
80             } finally {\r
81                 db.release(conn);\r
82             }\r
83         } catch (SQLException e) {\r
84             intlogger.error("PROV0008 EgressRoute.getAllEgressRoutes: " + e.getMessage(), e);\r
85         }\r
86         return set;\r
87     }\r
88 \r
89     private static void addEgressRouteToSet(SortedSet<EgressRoute> set, ResultSet rs) throws SQLException {\r
90         while (rs.next()) {\r
91             int subid = rs.getInt("SUBID");\r
92             int nodeid = rs.getInt("NODEID");\r
93             set.add(new EgressRoute(subid, nodeid));\r
94         }\r
95     }\r
96 \r
97     /**\r
98      * Get a single Egress Route for the subscription <i>sub</i>.\r
99      *\r
100      * @param sub the subscription to lookup\r
101      * @return an EgressRoute, or null if there is no route for this subscription\r
102      */\r
103     public static EgressRoute getEgressRoute(int sub) {\r
104         EgressRoute v = null;\r
105         DB db = new DB();\r
106         String sql = "select NODEID from EGRESS_ROUTES where SUBID = ?";\r
107         try (Connection conn = db.getConnection();\r
108                 PreparedStatement ps = conn.prepareStatement(sql)) {\r
109             ps.setInt(1, sub);\r
110             try (ResultSet rs = ps.executeQuery()) {\r
111                 if (rs.next()) {\r
112                     int node = rs.getInt("NODEID");\r
113                     v = new EgressRoute(sub, node);\r
114                 }\r
115             } finally {\r
116                 db.release(conn);\r
117             }\r
118         } catch (SQLException e) {\r
119             intlogger.error("PROV0009 EgressRoute.getEgressRoute: " + e.getMessage(), e);\r
120         }\r
121         return v;\r
122     }\r
123 \r
124     @Override\r
125     public boolean doDelete(Connection c) {\r
126         boolean rv = true;\r
127         String sql = "delete from EGRESS_ROUTES where SUBID = ?";\r
128         try (PreparedStatement ps = c.prepareStatement(sql)) {\r
129             ps.setInt(1, subid);\r
130             ps.execute();\r
131         } catch (SQLException e) {\r
132             rv = false;\r
133             intlogger.error("PROV0007 doDelete: " + e.getMessage(), e);\r
134         }\r
135         return rv;\r
136     }\r
137 \r
138     @Override\r
139     public boolean doInsert(Connection c) {\r
140         boolean rv = false;\r
141         String sql = "insert into EGRESS_ROUTES (SUBID, NODEID) values (?, ?)";\r
142         try (PreparedStatement ps = c.prepareStatement(sql)) {\r
143             // Create the NETWORK_ROUTES row\r
144             ps.setInt(1, this.subid);\r
145             ps.setInt(2, this.nodeid);\r
146             ps.execute();\r
147             ps.close();\r
148             rv = true;\r
149         } catch (SQLException e) {\r
150             intlogger.warn("PROV0005 doInsert: " + e.getMessage(), e);\r
151         }\r
152         return rv;\r
153     }\r
154 \r
155     @Override\r
156     public boolean doUpdate(Connection c) {\r
157         boolean rv = true;\r
158         String sql = "update EGRESS_ROUTES set NODEID = ? where SUBID = ?";\r
159         try (PreparedStatement ps = c.prepareStatement(sql)) {\r
160             ps.setInt(1, nodeid);\r
161             ps.setInt(2, subid);\r
162             ps.executeUpdate();\r
163         } catch (SQLException e) {\r
164             rv = false;\r
165             intlogger.warn("PROV0006 doUpdate: " + e.getMessage(), e);\r
166         }\r
167         return rv;\r
168     }\r
169 \r
170     @Override\r
171     public JSONObject asJSONObject() {\r
172         JSONObject jo = new JSONObject();\r
173         jo.put("" + subid, lookupNodeID(nodeid));\r
174         return jo;\r
175     }\r
176 \r
177     @Override\r
178     public String getKey() {\r
179         return "" + subid;\r
180     }\r
181 \r
182     @Override\r
183     public boolean equals(Object obj) {\r
184         if (!(obj instanceof EgressRoute)) {\r
185             return false;\r
186         }\r
187         EgressRoute on = (EgressRoute) obj;\r
188         return (subid == on.subid) && (nodeid == on.nodeid);\r
189     }\r
190 \r
191     @Override\r
192     public int compareTo(EgressRoute o) {\r
193         return this.subid - o.subid;\r
194     }\r
195 \r
196     @Override\r
197     public String toString() {\r
198         return String.format("EGRESS: sub=%d, node=%d", subid, nodeid);\r
199     }\r
200 \r
201     @Override\r
202     public int hashCode() {\r
203         return Objects.hash(subid, nodeid);\r
204     }\r
205 }\r