Allow ebean server extra configuration

Signed-off-by: Thibault Meyer <[email protected]>
payintech · Dec 20, 2018 · b5e24f9 · b5e24f9
1 parent 5f4089f
commit b5e24f9
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -149,6 +149,11 @@ ebean {
         # self signed certificates
         allowAllCertificates = false
       }
+      
+      # Extra Ebean server configuration
+      # Use full classpath (ie: ebean.DemoEbeanServerExtraConfig)
+      extra-config = [
+      ]
     }
   }
 

diff --git a/play-ebean/src/main/java/play/db/ebean/orm/DefaultEbeanConfig.java b/play-ebean/src/main/java/play/db/ebean/orm/DefaultEbeanConfig.java
@@ -26,6 +26,8 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
+import static java.lang.Class.forName;
+
 /**
  * Ebean server configuration.
  *
@@ -294,7 +296,7 @@ EbeanConfig parse() {
 
                     if (ebeanServerConfig.hasPath("docstore")) {
                         try {
-                            Class.forName("io.ebeanservice.elastic.ElasticDocumentStore");
+                            forName("io.ebeanservice.elastic.ElasticDocumentStore");
                         } catch (ClassNotFoundException ex) {
                             final Option<ConfigOrigin> origin = this.configuration.hasPath("ebean.servers" + serverName + ".docstore") ?
                                 Option.apply(this.configuration.getValue("ebean.servers" + serverName + ".docstore").origin()) :
@@ -340,6 +342,21 @@ EbeanConfig parse() {
                         }
                     }
 
+                    if (ebeanServerConfig.hasPath("extra-config")) {
+                        ebeanServerConfig.getStringList("extra-config").forEach(className -> {
+                            try {
+                                final EbeanServerExtraConfig esac = (EbeanServerExtraConfig) forName(
+                                    className,
+                                    true,
+                                    this.environment.classLoader()
+                                ).newInstance();
+                                esac.applyExtraConfiguration(serverConfig, this.configuration);
+                            } catch (final ClassNotFoundException | IllegalAccessException | InstantiationException ex) {
+                                ex.printStackTrace();
+                            }
+                        });
+                    }
+
                     serverConfigs.put(serverName, serverConfig);
                 });
             } else {
@@ -385,7 +402,7 @@ private void addModelClassesToServerConfig(final String key, final ServerConfig
                                                    final Set<String> classes) {
             for (final String clazz : classes) {
                 try {
-                    serverConfig.addClass(Class.forName(clazz, true, this.environment.classLoader()));
+                    serverConfig.addClass(forName(clazz, true, this.environment.classLoader()));
                 } catch (Throwable ex) {
                     final Option<ConfigOrigin> origin = this.configuration.hasPath("ebean.servers." + key) ?
                         Option.apply(this.configuration.getValue("ebean.servers." + key).origin()) :

diff --git a/play-ebean/src/main/java/play/db/ebean/orm/EbeanServerExtraConfig.java b/play-ebean/src/main/java/play/db/ebean/orm/EbeanServerExtraConfig.java
@@ -0,0 +1,21 @@
+package play.db.ebean.orm;
+
+import com.typesafe.config.Config;
+import io.ebean.config.ServerConfig;
+
+/**
+ * Allow third party app to configure Ebean server.
+ *
+ * @author Thibault Meyer
+ * @since 18.12.20
+ */
+public interface EbeanServerExtraConfig {
+
+    /**
+     * Apply extra configuration to the Ebean server before it was started.
+     *
+     * @param ebeanServerConfig Handle to the Ebean server configuration
+     * @param playConfig        Handle to Play configuration
+     */
+    void applyExtraConfiguration(final ServerConfig ebeanServerConfig, final Config playConfig);
+}
diff --git a/sbt-play-ebean-test/app/ebean/DemoEbeanServerExtraConfig.java b/sbt-play-ebean-test/app/ebean/DemoEbeanServerExtraConfig.java
@@ -0,0 +1,14 @@
+package ebean;
+
+import com.typesafe.config.Config;
+import io.ebean.config.ServerConfig;
+import play.Logger;
+import play.db.ebean.orm.EbeanServerExtraConfig;
+
+public class DemoEbeanServerExtraConfig implements EbeanServerExtraConfig {
+
+    @Override
+    public void applyExtraConfiguration(ServerConfig ebeanServerConfig, Config playConfig) {
+        Logger.info("Applying ebean server extra configuration");
+    }
+}
diff --git a/sbt-play-ebean-test/conf/application.conf b/sbt-play-ebean-test/conf/application.conf
@@ -76,6 +76,11 @@ ebean {
         # self signed certificates
         allowAllCertificates = false
       }
+
+      # Extra Ebean server configuration
+      extra-config = [
+        "ebean.DemoEbeanServerExtraConfig"
+      ]
     }
 
     # Secondary server