#2307 - ENH: Add DatabaseFactory.disableShutdownHook() ... [ alias for ShutdownManager.deregisterShutdownHook() ]

ebean-api/src/main/java/io/ebean/DatabaseFactory.java

@@ -2,6 +2,7 @@ package io.ebean;
 
 import io.ebean.config.ContainerConfig;
 import io.ebean.config.DatabaseConfig;
+import io.ebean.event.ShutdownManager;
 import io.ebean.service.SpiContainer;
 import io.ebean.service.SpiContainerFactory;
 
@@ -16,18 +17,15 @@ import java.util.concurrent.locks.ReentrantLock;
  * <p>
  * This uses either DatabaseConfig or properties in the application.properties file to
  * configure and create a Database instance.
- * </p>
  * <p>
  * The Database instance can either be registered with the DB singleton or
  * not. The DB singleton effectively holds a map of Database by a name.
  * If the Database is registered with the DB singleton you can retrieve it
  * later via {@link DB#byName(String)}.
- * </p>
  * <p>
  * One Database can be nominated as the 'default/primary' Database. Many
  * methods on the DB singleton such as {@link DB#find(Class)} are just a
  * convenient way of using the 'default/primary' Database.
- * </p>
  */
 public class DatabaseFactory {
 
@@ -68,6 +66,16 @@ public class DatabaseFactory {
 
   /**
    * Create using the DatabaseConfig object to configure the database.
+   *
+   * <pre>{@code
+   *
+   *   DatabaseConfig config = new DatabaseConfig();
+   *   config.setName("db");
+   *   config.loadProperties();
+   *
+   *   Database database = DatabaseFactory.create(config);
+   *
+   * }</pre>
    */
   public static Database create(DatabaseConfig config) {
     lock.lock();
@@ -115,7 +123,6 @@ public class DatabaseFactory {
    * Shutdown gracefully all Database instances cleaning up any resources as required.
    * <p>
    * This is typically invoked via JVM shutdown hook and not explicitly called.
-   * </p>
    */
   public static void shutdown() {
     lock.lock();
@@ -126,6 +133,14 @@ public class DatabaseFactory {
     }
   }
 
+  /**
+   * Removes the JVM shutdown hook and means the application must shut down ebean
+   * explicitly using {@link DatabaseFactory#shutdown()}.
+   */
+  public static void disableShutdownHook() {
+    ShutdownManager.deregisterShutdownHook();
+  }
+
   private static Database createInternal(DatabaseConfig config) {
     return getContainer(config.getContainerConfig()).createServer(config);
   }

ebean-api/src/main/java/io/ebean/event/ShutdownManager.java

@@ -14,10 +14,9 @@ import java.util.List;
 import java.util.concurrent.locks.ReentrantLock;
 
 /**
- * Manages the shutdown of the JVM Runtime.
+ * Manages the shutdown of Ebean.
  * <p>
  * Makes sure all the resources are shutdown properly and in order.
- * </p>
  */
 public final class ShutdownManager {
 
@@ -44,6 +43,9 @@ public final class ShutdownManager {
   private ShutdownManager() {
   }
 
+  /**
+   * Registers the container (potentially with cluster management).
+   */
   public static void registerContainer(SpiContainer ebeanContainer) {
     container = ebeanContainer;
   }
@@ -94,7 +96,7 @@ public final class ShutdownManager {
   /**
    * Register the shutdown hook with the Runtime.
    */
-  protected static void registerShutdownHook() {
+  private static void registerShutdownHook() {
     lock.lock();
     try {
       String value = System.getProperty("ebean.registerShutdownHook");
@@ -123,13 +125,10 @@ public final class ShutdownManager {
         // Already run shutdown...
         return;
       }
-
       if (logger.isDebugEnabled()) {
         logger.debug("Shutting down");
       }
-
       stopping = true;
-
       deregisterShutdownHook();
 
       String shutdownRunner = System.getProperty("ebean.shutdown.runnable");
@@ -147,7 +146,6 @@ public final class ShutdownManager {
         // shutdown cluster networking if active
         container.shutdown();
       }
-
       // shutdown any registered servers that have not
       // already been shutdown manually
       for (Database server : databases) {
@@ -158,7 +156,6 @@ public final class ShutdownManager {
           ex.printStackTrace();
         }
       }
-
       if ("true".equalsIgnoreCase(System.getProperty("ebean.datasource.deregisterAllDrivers", "false"))) {
         deregisterAllJdbcDrivers();
       }
@@ -168,15 +165,15 @@ public final class ShutdownManager {
   }
 
   private static void deregisterAllJdbcDrivers() {
-    // This manually deregisters all JDBC drivers
+    // This manually de-registers all JDBC drivers
     Enumeration<Driver> drivers = DriverManager.getDrivers();
     while (drivers.hasMoreElements()) {
       Driver driver = drivers.nextElement();
       try {
-        logger.info("Deregistering jdbc driver: " + driver);
+        logger.info("De-registering jdbc driver: " + driver);
         DriverManager.deregisterDriver(driver);
       } catch (SQLException e) {
-        logger.error("Error deregistering driver " + driver, e);
+        logger.error("Error de-registering driver " + driver, e);
       }
     }
   }
@@ -209,6 +206,9 @@ public final class ShutdownManager {
   }
 
   private static class ShutdownHook extends Thread {
+    private ShutdownHook() {
+      super("EbeanHook");
+    }
     @Override
     public void run() {
       ShutdownManager.shutdown();