Merge pull request #611 from zhenlineo/2.0-session-config

Changed session parameters to builder pattern

Author: zhenlineo

driver/src/main/java/org/neo4j/driver/Driver.java

@@ -19,11 +19,10 @@
 package org.neo4j.driver;
 
 import java.util.concurrent.CompletionStage;
-import java.util.function.Consumer;
 
 import org.neo4j.driver.async.AsyncSession;
 import org.neo4j.driver.exceptions.ClientException;
-import org.neo4j.driver.internal.SessionParameters;
+import org.neo4j.driver.internal.SessionConfig;
 import org.neo4j.driver.reactive.RxSession;
 import org.neo4j.driver.types.TypeSystem;
 import org.neo4j.driver.util.Experimental;
@@ -74,83 +73,88 @@ public interface Driver extends AutoCloseable
     boolean isEncrypted();
 
     /**
-     * Create a new general purpose {@link Session} with default {@link SessionParameters session parameters}.
+     * Create a new general purpose {@link Session} with default {@link SessionConfig session configuration}.
      * <p>
-     * Alias to {@link #session(Consumer)}}.
+     * Alias to {@link #session(SessionConfig)}}.
      *
      * @return a new {@link Session} object.
      */
     Session session();
 
     /**
-     * Create a new {@link Session} with a specified {@link SessionParametersTemplate}.
-     * @param templateConsumer specifies how the session parameter shall be built for this session.
+     * Create a new {@link Session} with a specified {@link SessionConfig session configuration}.
+     * Use {@link SessionConfig#forDatabase(String)} to obtain a general purpose session configuration for the specified database.
+     * @param sessionConfig specifies session configurations for this session.
      * @return a new {@link Session} object.
-     * @see SessionParameters
+     * @see SessionConfig
      */
-    Session session( Consumer<SessionParametersTemplate> templateConsumer );
-    /**
-     * Close all the resources assigned to this driver, including open connections and IO threads.
-     * <p>
-     * This operation works the same way as {@link #closeAsync()} but blocks until all resources are closed.
-     */
-    @Override
-    void close();
-
-    /**
-     * Close all the resources assigned to this driver, including open connections and IO threads.
-     * <p>
-     * This operation is asynchronous and returns a {@link CompletionStage}. This stage is completed with
-     * {@code null} when all resources are closed. It is completed exceptionally if termination fails.
-     *
-     * @return a {@link CompletionStage completion stage} that represents the asynchronous close.
-     */
-    CompletionStage<Void> closeAsync();
+    Session session( SessionConfig sessionConfig );
 
     /**
-     * Returns the driver metrics if metrics reporting is enabled via {@link Config.ConfigBuilder#withDriverMetrics()}.
-     * Otherwise a {@link ClientException} will be thrown.
-     * @return the driver metrics if enabled.
-     * @throws ClientException if the driver metrics reporting is not enabled.
-     */
-    Metrics metrics();
-
-    /**
-     * Create a new general purpose {@link RxSession} with default {@link SessionParameters session parameters}.
+     * Create a new general purpose {@link RxSession} with default {@link SessionConfig session configuration}.
      * The {@link RxSession} provides a reactive way to run queries and process results.
      * <p>
-     * Alias to {@link #rxSession(Consumer)}}.
+     * Alias to {@link #rxSession(SessionConfig)}}.
      *
      * @return @return a new {@link RxSession} object.
      */
     RxSession rxSession();
 
     /**
-     * Create a new {@link RxSession} with a specified {@link SessionParametersTemplate}.
+     * Create a new {@link RxSession} with a specified {@link SessionConfig session configuration}.
+     * Use {@link SessionConfig#forDatabase(String)} to obtain a general purpose session configuration for the specified database.
      * The {@link RxSession} provides a reactive way to run queries and process results.
-     * @param templateConsumer used to customize the session parameters.
+     * @param sessionConfig used to customize the session.
      * @return @return a new {@link RxSession} object.
      */
-    RxSession rxSession( Consumer<SessionParametersTemplate> templateConsumer );
+    RxSession rxSession( SessionConfig sessionConfig );
 
     /**
-     * Create a new general purpose {@link AsyncSession} with default {@link SessionParameters session parameters}.
+     * Create a new general purpose {@link AsyncSession} with default {@link SessionConfig session configuration}.
      * The {@link AsyncSession} provides an asynchronous way to run queries and process results.
      * <p>
-     * Alias to {@link #asyncSession(Consumer)}}.
+     * Alias to {@link #asyncSession(SessionConfig)}}.
      *
      * @return @return a new {@link AsyncSession} object.
      */
     AsyncSession asyncSession();
 
     /**
-     * Create a new {@link AsyncSession} with a specified {@link SessionParametersTemplate}.
+     * Create a new {@link AsyncSession} with a specified {@link SessionConfig session configuration}.
+     * Use {@link SessionConfig#forDatabase(String)} to obtain a general purpose session configuration for the specified database.
      * The {@link AsyncSession} provides an asynchronous way to run queries and process results.
      *
-     * @param templateConsumer used to customize the session parameters.
+     * @param sessionConfig used to customize the session.
      * @return a new {@link AsyncSession} object.
      */
-    AsyncSession asyncSession( Consumer<SessionParametersTemplate> templateConsumer );
+    AsyncSession asyncSession( SessionConfig sessionConfig );
+
+    /**
+     * Close all the resources assigned to this driver, including open connections and IO threads.
+     * <p>
+     * This operation works the same way as {@link #closeAsync()} but blocks until all resources are closed.
+     */
+    @Override
+    void close();
+
+    /**
+     * Close all the resources assigned to this driver, including open connections and IO threads.
+     * <p>
+     * This operation is asynchronous and returns a {@link CompletionStage}. This stage is completed with
+     * {@code null} when all resources are closed. It is completed exceptionally if termination fails.
+     *
+     * @return a {@link CompletionStage completion stage} that represents the asynchronous close.
+     */
+    CompletionStage<Void> closeAsync();
+
+    /**
+     * Returns the driver metrics if metrics reporting is enabled via {@link Config.ConfigBuilder#withDriverMetrics()}.
+     * Otherwise a {@link ClientException} will be thrown.
+     * @return the driver metrics if enabled.
+     * @throws ClientException if the driver metrics reporting is not enabled.
+     */
+    @Experimental
+    Metrics metrics();
 
     /**
      * This will return the type system supported by the driver.

driver/src/main/java/org/neo4j/driver/SessionParametersTemplate.java

@@ -20,14 +20,12 @@
 
 import java.util.concurrent.CompletionStage;
 import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.function.Consumer;
 
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Logger;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.Metrics;
 import org.neo4j.driver.Session;
-import org.neo4j.driver.SessionParametersTemplate;
 import org.neo4j.driver.async.AsyncSession;
 import org.neo4j.driver.internal.async.InternalAsyncSession;
 import org.neo4j.driver.internal.async.NetworkSession;
@@ -61,43 +59,37 @@ public class InternalDriver implements Driver
     @Override
     public Session session()
     {
-        return new InternalSession( newSession( SessionParameters.empty() )  );
+        return new InternalSession( newSession( SessionConfig.empty() )  );
     }
 
     @Override
-    public Session session( Consumer<SessionParametersTemplate> templateConsumer )
+    public Session session( SessionConfig sessionConfig )
     {
-        SessionParameters.Template template = SessionParameters.template();
-        templateConsumer.accept( template );
-        return new InternalSession( newSession( template.build() ) );
+        return new InternalSession( newSession( sessionConfig ) );
     }
 
     @Override
     public RxSession rxSession()
     {
-        return new InternalRxSession( newSession( SessionParameters.empty() ) );
+        return new InternalRxSession( newSession( SessionConfig.empty() ) );
     }
 
     @Override
-    public RxSession rxSession( Consumer<SessionParametersTemplate> templateConsumer )
+    public RxSession rxSession( SessionConfig sessionConfig )
     {
-        SessionParameters.Template template = SessionParameters.template();
-        templateConsumer.accept( template );
-        return new InternalRxSession( newSession( template.build() ) );
+        return new InternalRxSession( newSession( sessionConfig ) );
     }
 
     @Override
     public AsyncSession asyncSession()
     {
-        return new InternalAsyncSession( newSession( SessionParameters.empty() ) );
+        return new InternalAsyncSession( newSession( SessionConfig.empty() ) );
     }
 
     @Override
-    public AsyncSession asyncSession( Consumer<SessionParametersTemplate> templateConsumer )
+    public AsyncSession asyncSession( SessionConfig sessionConfig )
     {
-        SessionParameters.Template template = SessionParameters.template();
-        templateConsumer.accept( template );
-        return new InternalAsyncSession( newSession( template.build() ) );
+        return new InternalAsyncSession( newSession( sessionConfig ) );
     }
 
     @Override
@@ -158,7 +150,7 @@ private static RuntimeException driverCloseException()
         return new IllegalStateException( "This driver instance has already been closed" );
     }
 
-    public NetworkSession newSession( SessionParameters parameters )
+    public NetworkSession newSession( SessionConfig parameters )
     {
         assertOpen();
         NetworkSession session = sessionFactory.newInstance( parameters );