Coverage Report

Coverage Report - org.apache.commons.configuration.DatabaseConfiguration

Classes in this File

Line Coverage

Branch Coverage

Complexity

DatabaseConfiguration

85%

127/149

67%

29/43

3,9

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.apache.commons.configuration;
 
 import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
 
 import javax.sql.DataSource;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 /**
  * Configuration stored in a database.
  *
  * @since 1.0
  *
  * @author Emmanuel Bourg
  * @version $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $
  */
 public class DatabaseConfiguration extends AbstractConfiguration
 {
     /** Logger */
     private static Log log = LogFactory.getLog(DatabaseConfiguration.class);
 
     /** The datasource to connect to the database. */
     private DataSource datasource;
 
     /** The name of the table containing the configurations. */
     private String table;
 
     /** The column containing the name of the configuration. */
     private String nameColumn;
 
     /** The column containing the keys. */
     private String keyColumn;
 
     /** The column containing the values. */
     private String valueColumn;
 
     /** The name of the configuration. */
     private String name;
 
     /**
      * Build a configuration from a table containing multiple configurations.
      *
      * @param datasource    the datasource to connect to the database
      * @param table         the name of the table containing the configurations
      * @param nameColumn    the column containing the name of the configuration
      * @param keyColumn     the column containing the keys of the configuration
      * @param valueColumn   the column containing the values of the configuration
      * @param name          the name of the configuration
      */
     public DatabaseConfiguration(DataSource datasource, String table, String nameColumn,
             String keyColumn, String valueColumn, String name)
     {
         this.datasource = datasource;
         this.table = table;
         this.nameColumn = nameColumn;
         this.keyColumn = keyColumn;
         this.valueColumn = valueColumn;
         this.name = name;
     }
 
     /**
      * Build a configuration from a table.-
      *
      * @param datasource    the datasource to connect to the database
      * @param table         the name of the table containing the configurations
      * @param keyColumn     the column containing the keys of the configuration
      * @param valueColumn   the column containing the values of the configuration
      */
     public DatabaseConfiguration(DataSource datasource, String table, String keyColumn, String valueColumn)
     {
         this(datasource, table, null, keyColumn, valueColumn, null);
     }
 
     /**
      * {@inheritDoc}
      */
     public Object getProperty(String key)
     {
         Object result = null;
 
         // build the query
         StringBuffer query = new StringBuffer("SELECT * FROM " + table + " WHERE " + keyColumn + "=?");
         if (nameColumn != null)
         {
             query.append(" AND " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             pstmt.setString(1, key);
             if (nameColumn != null)
             {
                 pstmt.setString(2, name);
             }
 
             ResultSet rs = pstmt.executeQuery();
 
             if (rs.next())
             {
                 result = rs.getObject(valueColumn);
             }
 
             // build a list if there is more than one row in the resultset
             if (rs.next())
             {
                 List results = new ArrayList();
                 results.add(result);
                 results.add(rs.getObject(valueColumn));
                 while (rs.next())
                 {
                     results.add(rs.getObject(valueColumn));
                 }
                 result = results;
             }
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             closeQuietly(conn, pstmt);
         }
 
         return result;
     }
 
     /**
      * {@inheritDoc}
      */
     protected void addPropertyDirect(String key, Object obj)
     {
         // build the query
         StringBuffer query = new StringBuffer("INSERT INTO " + table);
         if (nameColumn != null)
         {
             query.append(" (" + nameColumn + ", " + keyColumn + ", " + valueColumn + ") VALUES (?, ?, ?)");
         }
         else
         {
             query.append(" (" + keyColumn + ", " + valueColumn + ") VALUES (?, ?)");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             int index = 1;
             if (nameColumn != null)
             {
                 pstmt.setString(index++, name);
             }
             pstmt.setString(index++, key);
             pstmt.setString(index++, String.valueOf(obj));
 
             pstmt.executeUpdate();
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     public boolean isEmpty()
     {
         boolean empty = true;
 
         // build the query
         StringBuffer query = new StringBuffer("SELECT count(*) FROM " + table);
         if (nameColumn != null)
         {
             query.append(" WHERE " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             if (nameColumn != null)
             {
                 pstmt.setString(1, name);
             }
 
             ResultSet rs = pstmt.executeQuery();
 
             if (rs.next())
             {
                 empty = rs.getInt(1) == 0;
             }
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
 
         return empty;
     }
 
     /**
      * {@inheritDoc}
      */
     public boolean containsKey(String key)
     {
         boolean found = false;
 
         // build the query
         StringBuffer query = new StringBuffer("SELECT * FROM " + table + " WHERE " + keyColumn + "=?");
         if (nameColumn != null)
         {
             query.append(" AND " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             pstmt.setString(1, key);
             if (nameColumn != null)
             {
                 pstmt.setString(2, name);
             }
 
             ResultSet rs = pstmt.executeQuery();
 
             found = rs.next();
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
 
         return found;
     }
 
     /**
      * {@inheritDoc}
      */
     public void clearProperty(String key)
     {
         // build the query
         StringBuffer query = new StringBuffer("DELETE FROM " + table + " WHERE " + keyColumn + "=?");
         if (nameColumn != null)
         {
             query.append(" AND " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             pstmt.setString(1, key);
             if (nameColumn != null)
             {
                 pstmt.setString(2, name);
             }
 
             pstmt.executeUpdate();
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     public void clear()
     {
         // build the query
         StringBuffer query = new StringBuffer("DELETE FROM " + table);
         if (nameColumn != null)
         {
             query.append(" WHERE " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             if (nameColumn != null)
             {
                 pstmt.setString(1, name);
             }
 
             pstmt.executeUpdate();
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     public Iterator getKeys()
     {
         Collection keys = new ArrayList();
 
         // build the query
         StringBuffer query = new StringBuffer("SELECT DISTINCT " + keyColumn + " FROM " + table);
         if (nameColumn != null)
         {
             query.append(" WHERE " + nameColumn + "=?");
         }
 
         Connection conn = null;
         PreparedStatement pstmt = null;
 
         try
         {
             conn = datasource.getConnection();
 
             // bind the parameters
             pstmt = conn.prepareStatement(query.toString());
             if (nameColumn != null)
             {
                 pstmt.setString(1, name);
             }
 
             ResultSet rs = pstmt.executeQuery();
 
             while (rs.next())
             {
                 keys.add(rs.getString(1));
             }
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
         finally
         {
             // clean up
             closeQuietly(conn, pstmt);
         }
 
         return keys.iterator();
     }
 
     /**
      * Close a <code>Connection</code> and, <code>Statement</code>.
      * Avoid closing if null and hide any SQLExceptions that occur.
      *
      * @param conn The database connection to close
      * @param stmt The statement to close
      */
     private void closeQuietly(Connection conn, Statement stmt)
     {
         try
         {
             if (stmt != null)
             {
                 stmt.close();
             }
             if (conn != null)
             {
                 conn.close();
             }
         }
         catch (SQLException e)
         {
             log.error(e.getMessage(), e);
         }
     }
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		package org.apache.commons.configuration;
19
20		import java.sql.Connection;
21		import java.sql.PreparedStatement;
22		import java.sql.ResultSet;
23		import java.sql.SQLException;
24		import java.sql.Statement;
25		import java.util.ArrayList;
26		import java.util.Collection;
27		import java.util.Iterator;
28		import java.util.List;
29
30		import javax.sql.DataSource;
31
32		import org.apache.commons.logging.Log;
33		import org.apache.commons.logging.LogFactory;
34
35		/**
36		* Configuration stored in a database.
37		*
38		* @since 1.0
39		*
40		* @author Emmanuel Bourg
41		* @version $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $
42		*/
43	1	public class DatabaseConfiguration extends AbstractConfiguration
44		{
45		/** Logger */
46	1	private static Log log = LogFactory.getLog(DatabaseConfiguration.class);
47
48		/** The datasource to connect to the database. */
49		private DataSource datasource;
50
51		/** The name of the table containing the configurations. */
52		private String table;
53
54		/** The column containing the name of the configuration. */
55		private String nameColumn;
56
57		/** The column containing the keys. */
58		private String keyColumn;
59
60		/** The column containing the values. */
61		private String valueColumn;
62
63		/** The name of the configuration. */
64		private String name;
65
66		/**
67		* Build a configuration from a table containing multiple configurations.
68		*
69		* @param datasource the datasource to connect to the database
70		* @param table the name of the table containing the configurations
71		* @param nameColumn the column containing the name of the configuration
72		* @param keyColumn the column containing the keys of the configuration
73		* @param valueColumn the column containing the values of the configuration
74		* @param name the name of the configuration
75		*/
76		public DatabaseConfiguration(DataSource datasource, String table, String nameColumn,
77		String keyColumn, String valueColumn, String name)
78	19	{
79	19	this.datasource = datasource;
80	19	this.table = table;
81	19	this.nameColumn = nameColumn;
82	19	this.keyColumn = keyColumn;
83	19	this.valueColumn = valueColumn;
84	19	this.name = name;
85	19	}
86
87		/**
88		* Build a configuration from a table.-
89		*
90		* @param datasource the datasource to connect to the database
91		* @param table the name of the table containing the configurations
92		* @param keyColumn the column containing the keys of the configuration
93		* @param valueColumn the column containing the values of the configuration
94		*/
95		public DatabaseConfiguration(DataSource datasource, String table, String keyColumn, String valueColumn)
96		{
97	11	this(datasource, table, null, keyColumn, valueColumn, null);
98	11	}
99
100		/**
101		* {@inheritDoc}
102		*/
103		public Object getProperty(String key)
104		{
105	7	Object result = null;
106
107		// build the query
108	7	StringBuffer query = new StringBuffer("SELECT * FROM " + table + " WHERE " + keyColumn + "=?");
109	7	if (nameColumn != null)
110		{
111	3	query.append(" AND " + nameColumn + "=?");
112		}
113
114	7	Connection conn = null;
115	7	PreparedStatement pstmt = null;
116
117		try
118		{
119	7	conn = datasource.getConnection();
120
121		// bind the parameters
122	7	pstmt = conn.prepareStatement(query.toString());
123	7	pstmt.setString(1, key);
124	7	if (nameColumn != null)
125		{
126	3	pstmt.setString(2, name);
127		}
128
129	7	ResultSet rs = pstmt.executeQuery();
130
131	7	if (rs.next())
132		{
133	5	result = rs.getObject(valueColumn);
134		}
135
136		// build a list if there is more than one row in the resultset
137	7	if (rs.next())
138		{
139	1	List results = new ArrayList();
140	1	results.add(result);
141	1	results.add(rs.getObject(valueColumn));
142	3	while (rs.next())
143		{
144	1	results.add(rs.getObject(valueColumn));
145		}
146	1	result = results;
147		}
148	7	}
149		catch (SQLException e)
150		{
151	0	log.error(e.getMessage(), e);
152	0	}
153		finally
154		{
155	0	closeQuietly(conn, pstmt);
156		}
157
158	7	return result;
159		}
160
161		/**
162		* {@inheritDoc}
163		*/
164		protected void addPropertyDirect(String key, Object obj)
165		{
166		// build the query
167	3	StringBuffer query = new StringBuffer("INSERT INTO " + table);
168	3	if (nameColumn != null)
169		{
170	1	query.append(" (" + nameColumn + ", " + keyColumn + ", " + valueColumn + ") VALUES (?, ?, ?)");
171		}
172		else
173		{
174	2	query.append(" (" + keyColumn + ", " + valueColumn + ") VALUES (?, ?)");
175		}
176
177	3	Connection conn = null;
178	3	PreparedStatement pstmt = null;
179
180		try
181		{
182	3	conn = datasource.getConnection();
183
184		// bind the parameters
185	3	pstmt = conn.prepareStatement(query.toString());
186	3	int index = 1;
187	3	if (nameColumn != null)
188		{
189	1	pstmt.setString(index++, name);
190		}
191	3	pstmt.setString(index++, key);
192	3	pstmt.setString(index++, String.valueOf(obj));
193
194	3	pstmt.executeUpdate();
195	3	}
196		catch (SQLException e)
197		{
198	0	log.error(e.getMessage(), e);
199	0	}
200		finally
201		{
202		// clean up
203	0	closeQuietly(conn, pstmt);
204		}
205	3	}
206
207		/**
208		* {@inheritDoc}
209		*/
210		public boolean isEmpty()
211		{
212	6	boolean empty = true;
213
214		// build the query
215	6	StringBuffer query = new StringBuffer("SELECT count(*) FROM " + table);
216	6	if (nameColumn != null)
217		{
218	3	query.append(" WHERE " + nameColumn + "=?");
219		}
220
221	6	Connection conn = null;
222	6	PreparedStatement pstmt = null;
223
224		try
225		{
226	6	conn = datasource.getConnection();
227
228		// bind the parameters
229	6	pstmt = conn.prepareStatement(query.toString());
230	6	if (nameColumn != null)
231		{
232	3	pstmt.setString(1, name);
233		}
234
235	6	ResultSet rs = pstmt.executeQuery();
236
237	6	if (rs.next())
238		{
239	6	empty = rs.getInt(1) == 0;
240		}
241	6	}
242		catch (SQLException e)
243		{
244	0	log.error(e.getMessage(), e);
245	0	}
246		finally
247		{
248		// clean up
249	0	closeQuietly(conn, pstmt);
250		}
251
252	6	return empty;
253		}
254
255		/**
256		* {@inheritDoc}
257		*/
258		public boolean containsKey(String key)
259		{
260	10	boolean found = false;
261
262		// build the query
263	10	StringBuffer query = new StringBuffer("SELECT * FROM " + table + " WHERE " + keyColumn + "=?");
264	10	if (nameColumn != null)
265		{
266	4	query.append(" AND " + nameColumn + "=?");
267		}
268
269	10	Connection conn = null;
270	10	PreparedStatement pstmt = null;
271
272		try
273		{
274	10	conn = datasource.getConnection();
275
276		// bind the parameters
277	10	pstmt = conn.prepareStatement(query.toString());
278	10	pstmt.setString(1, key);
279	10	if (nameColumn != null)
280		{
281	4	pstmt.setString(2, name);
282		}
283
284	10	ResultSet rs = pstmt.executeQuery();
285
286	10	found = rs.next();
287	10	}
288		catch (SQLException e)
289		{
290	0	log.error(e.getMessage(), e);
291	0	}
292		finally
293		{
294		// clean up
295	0	closeQuietly(conn, pstmt);
296		}
297
298	10	return found;
299		}
300
301		/**
302		* {@inheritDoc}
303		*/
304		public void clearProperty(String key)
305		{
306		// build the query
307	3	StringBuffer query = new StringBuffer("DELETE FROM " + table + " WHERE " + keyColumn + "=?");
308	3	if (nameColumn != null)
309		{
310	1	query.append(" AND " + nameColumn + "=?");
311		}
312
313	3	Connection conn = null;
314	3	PreparedStatement pstmt = null;
315
316		try
317		{
318	3	conn = datasource.getConnection();
319
320		// bind the parameters
321	3	pstmt = conn.prepareStatement(query.toString());
322	3	pstmt.setString(1, key);
323	3	if (nameColumn != null)
324		{
325	1	pstmt.setString(2, name);
326		}
327
328	3	pstmt.executeUpdate();
329	3	}
330		catch (SQLException e)
331		{
332	0	log.error(e.getMessage(), e);
333	0	}
334		finally
335		{
336		// clean up
337	0	closeQuietly(conn, pstmt);
338		}
339	3	}
340
341		/**
342		* {@inheritDoc}
343		*/
344		public void clear()
345		{
346		// build the query
347	2	StringBuffer query = new StringBuffer("DELETE FROM " + table);
348	2	if (nameColumn != null)
349		{
350	1	query.append(" WHERE " + nameColumn + "=?");
351		}
352
353	2	Connection conn = null;
354	2	PreparedStatement pstmt = null;
355
356		try
357		{
358	2	conn = datasource.getConnection();
359
360		// bind the parameters
361	2	pstmt = conn.prepareStatement(query.toString());
362	2	if (nameColumn != null)
363		{
364	1	pstmt.setString(1, name);
365		}
366
367	2	pstmt.executeUpdate();
368	2	}
369		catch (SQLException e)
370		{
371	0	log.error(e.getMessage(), e);
372	0	}
373		finally
374		{
375		// clean up
376	0	closeQuietly(conn, pstmt);
377		}
378	2	}
379
380		/**
381		* {@inheritDoc}
382		*/
383		public Iterator getKeys()
384		{
385	5	Collection keys = new ArrayList();
386
387		// build the query
388	5	StringBuffer query = new StringBuffer("SELECT DISTINCT " + keyColumn + " FROM " + table);
389	5	if (nameColumn != null)
390		{
391	1	query.append(" WHERE " + nameColumn + "=?");
392		}
393
394	5	Connection conn = null;
395	5	PreparedStatement pstmt = null;
396
397		try
398		{
399	5	conn = datasource.getConnection();
400
401		// bind the parameters
402	5	pstmt = conn.prepareStatement(query.toString());
403	5	if (nameColumn != null)
404		{
405	1	pstmt.setString(1, name);
406		}
407
408	5	ResultSet rs = pstmt.executeQuery();
409
410	18	while (rs.next())
411		{
412	8	keys.add(rs.getString(1));
413		}
414	5	}
415		catch (SQLException e)
416		{
417	0	log.error(e.getMessage(), e);
418	0	}
419		finally
420		{
421		// clean up
422	0	closeQuietly(conn, pstmt);
423		}
424
425	5	return keys.iterator();
426		}
427
428		/**
429		* Close a <code>Connection</code> and, <code>Statement</code>.
430		* Avoid closing if null and hide any SQLExceptions that occur.
431		*
432		* @param conn The database connection to close
433		* @param stmt The statement to close
434		*/
435		private void closeQuietly(Connection conn, Statement stmt)
436		{
437		try
438		{
439	36	if (stmt != null)
440		{
441	36	stmt.close();
442		}
443	36	if (conn != null)
444		{
445	36	conn.close();
446		}
447	36	}
448		catch (SQLException e)
449		{
450	0	log.error(e.getMessage(), e);
451		}
452	36	}
453		}