X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=test%2Fenterprise%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsupport%2Fpersistence%2FAbstractDatabase.java;h=12c82c41177b7fe9f66d239d1d642d4218c0a1b9;hb=dec278a67997ea8e85d10662e31548afd8890ed3;hp=2e8f8d8335e0070530bd9c042f8e699181429a97;hpb=db8c34ba627d0342d911283793352804bb353c64;p=utils diff --git a/test/enterprise/src/main/java/org/wamblee/support/persistence/AbstractDatabase.java b/test/enterprise/src/main/java/org/wamblee/support/persistence/AbstractDatabase.java index 2e8f8d83..12c82c41 100644 --- a/test/enterprise/src/main/java/org/wamblee/support/persistence/AbstractDatabase.java +++ b/test/enterprise/src/main/java/org/wamblee/support/persistence/AbstractDatabase.java @@ -20,14 +20,30 @@ import java.util.logging.Logger; import javax.sql.DataSource; +import junit.framework.Assert; + import org.apache.commons.dbcp.ConnectionFactory; import org.apache.commons.dbcp.DriverManagerConnectionFactory; import org.apache.commons.dbcp.PoolableConnectionFactory; import org.apache.commons.dbcp.PoolingDataSource; import org.apache.commons.pool.impl.GenericObjectPool; +/** + * Abstract database class providing the creation of the datasource, + * preventing duplicate starts of the same database, and checking + * for connection leaks when the database is stopped. + * + * @author Erik Brakkee + * + */ public abstract class AbstractDatabase implements Database { + /** + * Set this system property to a non-null value to ignore connection leaks + * when {@link #stop()} is called. + */ + private static final String IGNORE_CONNECTION_LEAK_PROPERTY = "org.wamblee.database.ignoreconnectionleaks"; + private static final Logger LOGGER = Logger .getLogger(AbstractDatabase.class.getName()); @@ -39,12 +55,21 @@ public abstract class AbstractDatabase implements Database { private boolean started; + /** + * Constructs the database. + */ protected AbstractDatabase() { started = false; } + /** + * To be implemented by subclasses to start the database. + */ protected abstract void doStart(); + /** + * To be implemented by subclasses to stop the database. + */ protected abstract void doStop(); /** @@ -64,12 +89,20 @@ public abstract class AbstractDatabase implements Database { itsDataSource = new PoolingDataSource(connectionPool); } + @Override + public int getActiveConnections() { + return connectionPool.getNumActive(); + } + private static void ingoredVariable(PoolableConnectionFactory aFactory) { // Empty } // / BELOW THIS LINE IS NOT OF INTEREST TO SUBCLASSES. + /** + * Starts the database. + */ public final DataSource start() { if (started) { throw new RuntimeException("Database already started"); @@ -79,12 +112,27 @@ public abstract class AbstractDatabase implements Database { return getDatasource(); } + /** + * Stops the database and tests for connection leaks. + * In cast the system property with the name given by {@link #IGNORE_CONNECTION_LEAK_PROPERTY} + * is set then the connection leaks are not checked. + */ public final void stop() { if (!started) { return; // nothing to do. } started = false; try { + if (connectionPool.getNumActive() > 0) { + String msg = "JDBC connection pool still has " + + connectionPool.getNumActive() + + " active connection(s), this is a potential resource leak in the code\n"; + // backdoor to ignore connection leaks. Use this system property only if you + // can safely ignore the connection leaks. + if (System.getProperty(IGNORE_CONNECTION_LEAK_PROPERTY) == null) { + Assert.fail(msg); + } + } connectionPool.close(); connectionPool.close(); } catch (Exception e) {