invoke the close() callback at the beginning of ConfigurationImpl.close(); change other ConfigurationImpl subtypes to use preClose() instead of now-final close(); add test case for close callbacks.

git-svn-id: https://svn.apache.org/repos/asf/incubator/openjpa/trunk@475115 13f79535-47bb-0310-9956-ffa450edef68

openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/conf/JDBCConfigurationImpl.java

@@ -853,7 +853,7 @@ public class JDBCConfigurationImpl
     /**
      * Free the data sources.
      */
-    public void close() {
+    protected void preClose() {
         if (dataSource != null) {
             getDBDictionaryInstance().closeDataSource(dataSource);
             connectionFactory.set(null, true); // so super doesn't close it
@@ -862,7 +862,7 @@ public class JDBCConfigurationImpl
             getDBDictionaryInstance().closeDataSource(dataSource);
             connectionFactory2.set(null, true); // so super doesn't close it
         }
-        super.close();
+        super.preClose();
     }
 
     protected boolean isInvalidProperty(String propName) {

openjpa-kernel/src/main/java/org/apache/openjpa/conf/OpenJPAConfigurationImpl.java

@@ -1411,10 +1411,10 @@ public class OpenJPAConfigurationImpl
         getRemoteCommitEventManager();
     }
 
-    public void close() {
+    protected void preClose() {
         ImplHelper.close(metaRepository);
         ImplHelper.close(remoteEventManager);
-        super.close();
+        super.preClose();
     }
 
     public Log getConfigurationLog() {

openjpa-lib/src/main/java/org/apache/openjpa/lib/conf/ConfigurationImpl.java

@@ -329,7 +329,11 @@ public class ConfigurationImpl
     /**
      * Closes all closeable values and plugins.
      */
-    public void close() {
+    public final void close() {
+        ProductDerivations.beforeClose(this);
+        
+        preClose();
+        
         ObjectValue val;
         for (int i = 0; i < _vals.size(); i++) {
             if (_vals.get(i) instanceof Closeable) {
@@ -351,6 +355,16 @@ public class ConfigurationImpl
         }
     }
     
+    /**
+     * Invoked by final method {@link #close} after invoking the 
+     * {@link ProductDerivation#beforeConfigurationClose} callbacks
+     * but before performing internal close operations.
+     * 
+     * @since 0.9.7
+     */
+    protected void preClose() {
+    }
+
     ///////////////////////////
     // BeanInfo implementation
     ///////////////////////////

openjpa-lib/src/main/java/org/apache/openjpa/lib/conf/ProductDerivations.java

@@ -150,6 +150,22 @@ public class ProductDerivations {
         }
     }
 
+    /**
+     * Called as the first step of a Configuration's close() method. 
+     * Exceptions are swallowed.
+     * 
+     * @since 0.9.7
+     */
+    public static void beforeClose(Configuration conf) {
+        for (int i = 0; i < _derivations.length; i++) {
+            try {
+                _derivations[i].beforeConfigurationClose(conf);
+            } catch (Exception e) {
+                conf.getConfigurationLog().warn(_loc.get("before-close-ex"), e);
+            }
+        }
+    }
+
     /**
      * Load the given given resource, or return false if it is not a resource
      * this provider understands. The given class loader may be null.

openjpa-lib/src/main/resources/org/apache/openjpa/lib/conf/localizer.properties

@@ -84,6 +84,8 @@ no-product-derivations: Your system is missing product derivations.  Product \
     is an overly-restrictive security manager.\n{1}
 bad-product-derivations: Some product derivations are being skipped. For \
     information about product derivation status, run:\njava {0}
+before-close-ex: An exception occurred during ProductDerivations.beforeClose().\
+	This exception will be ignored, and is logged along with this message.
 
 Log-name: Log factory
 Log-desc: LogFactory and configuration

openjpa-lib/src/test/java/org/apache/openjpa/lib/conf/test/ConfigurationTestProductDerivation.java

@@ -22,6 +22,7 @@ import java.util.MissingResourceException;
 import java.util.Properties;
 
 import org.apache.openjpa.lib.conf.AbstractProductDerivation;
+import org.apache.openjpa.lib.conf.Configuration;
 import org.apache.openjpa.lib.conf.ConfigurationProvider;
 import org.apache.openjpa.lib.conf.MapConfigurationProvider;
 import org.apache.openjpa.lib.conf.ProductDerivation;
@@ -37,10 +38,16 @@ import org.apache.openjpa.lib.conf.ProductDerivation;
 public class ConfigurationTestProductDerivation 
     extends AbstractProductDerivation {
     
+    public static boolean closed = false;
+
     public int getType() {
         return ProductDerivation.TYPE_PRODUCT;
     }
     
+    public void beforeConfigurationClose(Configuration conf) {
+        closed = true;
+    }
+
     public ConfigurationProvider loadGlobals(ClassLoader loader)
         throws IOException {
         return load(null, loader);

openjpa-lib/src/test/java/org/apache/openjpa/lib/conf/test/TestConfigurationImpl.java

@@ -235,6 +235,13 @@ public class TestConfigurationImpl extends AbstractTestCase {
         assertEquals("", copy2.getPluginKeyInstance().toString());
     }
     
+    public void testProductDerivationCloseCallback() {
+        // toggle the static. This will be reset by the close invocation.
+        ConfigurationTestProductDerivation.closed = false;
+        _conf.close();
+        assertTrue(ConfigurationTestProductDerivation.closed);
+    }
+
     public static void main(String[] args) {
         main();
     }