introduce new vertx package

moved @Sanne's Vertx instance management to a new
package defined as an extension point

Author: gavinking

hibernate-reactive-core/src/main/java/org/hibernate/reactive/boot/impl/ReactiveServiceRegistryInitializer.java

@@ -7,7 +7,7 @@
 import org.hibernate.reactive.service.initiator.ReactiveJdbcEnvironmentInitiator;
 import org.hibernate.reactive.service.initiator.ReactiveQueryTranslatorFactoryInitiator;
 import org.hibernate.reactive.service.initiator.ReactiveTransactionCoordinatorBuilderInitiator;
-import org.hibernate.reactive.service.initiator.VertxInitiator;
+import org.hibernate.reactive.vertx.impl.VertxInstanceInitiator;
 import org.hibernate.service.spi.ServiceContributor;
 
 /**
@@ -19,7 +19,7 @@ public class ReactiveServiceRegistryInitializer implements ServiceContributor {
 
 	@Override
 	public void contribute(StandardServiceRegistryBuilder serviceRegistryBuilder) {
-		serviceRegistryBuilder.addInitiator( VertxInitiator.INSTANCE );
+		serviceRegistryBuilder.addInitiator( VertxInstanceInitiator.INSTANCE );
 		serviceRegistryBuilder.addInitiator( DummyConnectionProviderInitiator.INSTANCE );
 		serviceRegistryBuilder.addInitiator( ReactiveJdbcEnvironmentInitiator.INSTANCE );
 		serviceRegistryBuilder.addInitiator( ReactiveTransactionCoordinatorBuilderInitiator.INSTANCE );

hibernate-reactive-core/src/main/java/org/hibernate/reactive/pool/ReactiveConnectionPool.java

@@ -14,6 +14,13 @@
  * {@link org.hibernate.boot.registry.StandardServiceInitiator}
  * or from code-based Hibernate configuration by calling
  * {@link org.hibernate.boot.registry.StandardServiceRegistryBuilder#addService}.
+ *
+ * <pre>
+ * new StandardServiceRegistryBuilder()
+ *     .applySettings( properties )
+ *     .addService( ReactiveConnectionPool.class, new MyReactiveConnectionPool() )
+ *     .build();
+ * </pre>
  */
 public interface ReactiveConnectionPool extends Service {
 

hibernate-reactive-core/src/main/java/org/hibernate/reactive/pool/impl/SqlClientPool.java

@@ -12,7 +12,7 @@
 import org.hibernate.reactive.cfg.ReactiveSettings;
 import org.hibernate.reactive.pool.ReactiveConnection;
 import org.hibernate.reactive.pool.ReactiveConnectionPool;
-import org.hibernate.reactive.service.VertxService;
+import org.hibernate.reactive.vertx.VertxInstance;
 import org.hibernate.reactive.util.impl.JdbcUrlParser;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.ServiceRegistryAwareService;
@@ -31,6 +31,8 @@
 
 /**
  * A pool of reactive connections backed by a Vert.x {@link Pool}.
+ * The {@code Pool} itself is backed by an instance of {@link Vertx}
+ * obtained via the {@link VertxInstance} service.
  */
 public class SqlClientPool implements ReactiveConnectionPool, ServiceRegistryAwareService, Configurable, Stoppable, Startable {
 
@@ -66,8 +68,7 @@ public void start() {
 				pool = (Pool) o;
 			}
 		} else {
-			final VertxService vertxService = serviceRegistry.getService( VertxService.class );
-			Vertx vertx = vertxService.getVertx();
+			Vertx vertx = serviceRegistry.getService( VertxInstance.class ).getVertx();
 			pool = configurePool( configurationValues, vertx );
 		}
 

hibernate-reactive-core/src/main/java/org/hibernate/reactive/service/ExternallyProvidedVertxService.java

@@ -0,0 +1,34 @@
+package org.hibernate.reactive.vertx;
+
+import io.vertx.core.Vertx;
+import org.hibernate.service.Service;
+
+/**
+ * Used by {@link org.hibernate.reactive.pool.impl.SqlClientPool}
+ * to obtain an instance of {@link Vertx}. The default instance is
+ * {@link org.hibernate.reactive.vertx.impl.DefaultVertxInstance}.
+ *
+ * A program may integrate a custom {@link VertxInstance}
+ * with Hibernate Reactive by contributing a new service using a
+ * {@link org.hibernate.boot.registry.StandardServiceInitiator}
+ * or from code-based Hibernate configuration by calling
+ * {@link org.hibernate.boot.registry.StandardServiceRegistryBuilder#addService}.
+ *
+ * <pre>
+ * new StandardServiceRegistryBuilder()
+ *     .applySettings( properties )
+ *     .addService( VertxInstance.class, () -> myVertx )
+ *     .build();
+ * </pre>
+ *
+ * @see org.hibernate.reactive.vertx.impl.ProvidedVertxInstance
+ */
+@FunctionalInterface
+public interface VertxInstance extends Service {
+
+    /**
+     * Obtain the instance of {@link Vertx}.
+     */
+    Vertx getVertx();
+
+}

hibernate-reactive-core/src/main/java/org/hibernate/reactive/service/VertxService.java

@@ -1,18 +1,20 @@
-package org.hibernate.reactive.service;
+package org.hibernate.reactive.vertx.impl;
 
 import io.vertx.core.Vertx;
+import org.hibernate.reactive.vertx.VertxInstance;
 import org.hibernate.service.spi.Startable;
 import org.hibernate.service.spi.Stoppable;
 
 /**
- * This will start a new Vertx instance on demand, then ensure it's closed when
- * the SessionFactory is closed.
- * To use an external Vertx instance you can inject an alternative implementation
- * in the bootstrap registry.
+ * A singleton instance of {@link Vertx} that is created on
+ * demand and destroyed automatically along with the Hibernate
+ * {@link org.hibernate.SessionFactory#close() session factory}.
+ *
+ * @see ProvidedVertxInstance if you need to a different instance
  *
  * @author Sanne Grinovero <[email protected]>
  */
-public final class SelfmanagingVertxService implements VertxService, Stoppable, Startable {
+public final class DefaultVertxInstance implements VertxInstance, Stoppable, Startable {
 
     private Vertx vertx;
 

hibernate-reactive-core/src/main/java/org/hibernate/reactive/service/initiator/VertxInitiator.java

@@ -0,0 +1,36 @@
+package org.hibernate.reactive.vertx.impl;
+
+import io.vertx.core.Vertx;
+import org.hibernate.reactive.vertx.VertxInstance;
+
+import java.util.Objects;
+
+/**
+ * An implementation of {@link VertxInstance} which allows the client
+ * to provide an instance of {@link Vertx} whose lifecyle is managed
+ * extrenally to Hibernate Reactive. The {@code ProvidedVertxInstance}
+ * must be registered with explicitly Hibernate by calling
+ * {@link org.hibernate.boot.registry.StandardServiceRegistryBuilder#addService}.
+ * Hibernate will destroy the {@code Vertx} instance on shutdown.
+ *
+ * <pre>
+ * new StandardServiceRegistryBuilder()
+ *     .applySettings( properties )
+ *     .addService( VertxInstance.class, new ProvidedVertxInstance( vertx ) )
+ *     .build();
+ * </pre>
+ */
+public final class ProvidedVertxInstance implements VertxInstance {
+
+    private final Vertx vertx;
+
+    public ProvidedVertxInstance(Vertx vertx) {
+        Objects.requireNonNull( vertx );
+        this.vertx = vertx;
+    }
+
+    @Override
+    public Vertx getVertx() {
+        return vertx;
+    }
+}

hibernate-reactive-core/src/main/java/org/hibernate/reactive/vertx/VertxInstance.java

@@ -0,0 +1,26 @@
+package org.hibernate.reactive.vertx.impl;
+
+import org.hibernate.boot.registry.StandardServiceInitiator;
+import org.hibernate.reactive.vertx.VertxInstance;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+import java.util.Map;
+
+/**
+ * Factory for the default implementation of {@link VertxInstance}.
+ */
+public final class VertxInstanceInitiator implements StandardServiceInitiator<VertxInstance> {
+
+    public static final VertxInstanceInitiator INSTANCE = new VertxInstanceInitiator();
+
+    @Override
+    public VertxInstance initiateService(Map configurationValues, ServiceRegistryImplementor registry) {
+        return new DefaultVertxInstance();
+    }
+
+    @Override
+    public Class<VertxInstance> getServiceInitiated() {
+        return VertxInstance.class;
+    }
+
+}

hibernate-reactive-core/src/main/java/org/hibernate/reactive/service/SelfmanagingVertxService.java renamed to hibernate-reactive-core/src/main/java/org/hibernate/reactive/vertx/impl/DefaultVertxInstance.java

@@ -1,8 +1,8 @@
 package org.hibernate.reactive.testing;
 
 import io.vertx.core.Vertx;
-import org.hibernate.reactive.service.ExternallyProvidedVertxService;
-import org.hibernate.reactive.service.VertxService;
+import org.hibernate.reactive.vertx.VertxInstance;
+import org.hibernate.reactive.vertx.impl.ProvidedVertxInstance;
 import org.hibernate.service.Service;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.service.spi.ServiceBinding;
@@ -35,10 +35,10 @@ public ServiceRegistryImplementor getServiceRegistry() {
     //TODO extract into its own class and evolve as necessary?
     private static class Registry implements ServiceRegistryImplementor {
 
-        private final ExternallyProvidedVertxService vertxService;
+        private final ProvidedVertxInstance vertxService;
 
         public Registry(Vertx vertx) {
-            this.vertxService = new ExternallyProvidedVertxService( vertx );
+            this.vertxService = new ProvidedVertxInstance( vertx );
         }
 
         @Override
@@ -68,7 +68,7 @@ public ServiceRegistry getParentServiceRegistry() {
 
         @Override
         public <R extends Service> R getService(Class<R> serviceRole) {
-            if ( serviceRole == VertxService.class )
+            if ( serviceRole == VertxInstance.class )
                 return (R) vertxService;
             else {
                 throw new IllegalArgumentException( "This is a mock service - need to explicitly handle any service we might need during testing" );