Use 'Session' instead of 'Connection' in config referring to pooling.

jakewins · jakewins · commit 9cc9df48449a · 2016-02-12T15:17:09.000-06:00
diff --git a/driver/src/main/java/org/neo4j/driver/v1/Config.java b/driver/src/main/java/org/neo4j/driver/v1/Config.java
@@ -161,25 +161,45 @@ public ConfigBuilder withLogging( Logging logging )
         }
 
         /**
-         * The max number of connections to open at any given time per Neo4j instance.
-         * @param size the size of the connection pool
+         * The max number of sessions to keep open at once. Configure this
+         * higher if you want more concurrent sessions, or lower if you want
+         * to lower the pressure on the database instance.
+         *
+         * If the driver is asked to provide more sessions than this, it will
+         * block waiting for another session to be closed, with a timeout.
+         *
+         * @param size the max number of sessions to keep open
          * @return this builder
          */
-        public ConfigBuilder withConnectionPoolSize( int size )
+        public ConfigBuilder withMaxSessions( int size )
         {
             this.connectionPoolSize = size;
             return this;
         }
 
         /**
-         * Pooled connections that have been unused for longer than this timeout will be tested before they are
-         * used again, to ensure they are still live.
-         * @param milliSecond minimum idle time in milliseconds
+         * Pooled sessions that have been unused for longer than this timeout
+         * will be tested before they are used again, to ensure they are still live.
+         *
+         * If this option is set too low, an additional network call will be
+         * incurred when acquiring a session, which causes a performance hit.
+         *
+         * If this is set high, you may receive sessions that are no longer live,
+         * which will lead to exceptions in your application. Assuming the
+         * database is running, these exceptions will go away if you retry acquiring
+         * sessions.
+         *
+         * Hence, this parameter tunes a balance between the likelihood of your
+         * application seeing connection problems, and performance.
+         *
+         * You normally should not need to tune this parameter.
+         *
+         * @param timeout minimum idle time in milliseconds
          * @return this builder
          */
-        public ConfigBuilder withMinIdleTimeBeforeConnectionTest( long milliSecond )
+        public ConfigBuilder withSessionLivenessCheckTimeout( long timeout )
         {
-            this.idleTimeBeforeConnectionTest = milliSecond;
+            this.idleTimeBeforeConnectionTest = timeout;
             return this;
         }
 
diff --git a/driver/src/test/java/org/neo4j/driver/internal/ConfigTest.java b/driver/src/test/java/org/neo4j/driver/internal/ConfigTest.java
@@ -82,7 +82,7 @@ public void shouldChangeToTrustedCert()
     public void shouldConfigureMinIdleTime() throws Throwable
     {
         // when
-        Config config = Config.build().withMinIdleTimeBeforeConnectionTest( 1337 ).toConfig();
+        Config config = Config.build().withSessionLivenessCheckTimeout( 1337 ).toConfig();
 
         // then
         assertThat( config.idleTimeBeforeConnectionTest(), equalTo( 1337l ));
diff --git a/driver/src/test/java/org/neo4j/driver/internal/pool/InternalConnectionPoolTest.java b/driver/src/test/java/org/neo4j/driver/internal/pool/InternalConnectionPoolTest.java
@@ -51,7 +51,7 @@ public void shouldThrowExceptionWhenConnectionPoolIsFull() throws Throwable
         // Given
         URI uri = URI.create( "bolt://asd" );
         Connector connector = connector( "bolt" );
-        Config config = Config.build().withConnectionPoolSize( 1 ).toConfig();
+        Config config = Config.build().withMaxSessions( 1 ).toConfig();
         InternalConnectionPool pool = new InternalConnectionPool( singletonList( connector ),
                 Clock.SYSTEM, config );
 
diff --git a/examples/src/main/java/org/neo4j/docs/driver/Examples.java b/examples/src/main/java/org/neo4j/docs/driver/Examples.java
@@ -52,7 +52,7 @@ public static Driver configuration() throws Exception
     {
         // tag::configuration[]
         Driver driver =
-                GraphDatabase.driver( "bolt://localhost", Config.build().withConnectionPoolSize( 10 ).toConfig() );
+                GraphDatabase.driver( "bolt://localhost", Config.build().withMaxSessions( 10 ).toConfig() );
         // end::configuration[]
 
         return driver;

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public void shouldChangeToTrustedCert()`
`82`	`82`	`public void shouldConfigureMinIdleTime() throws Throwable`
`83`	`83`	`{`
`84`	`84`	`// when`
`85`		`- Config config = Config.build().withMinIdleTimeBeforeConnectionTest( 1337 ).toConfig();`
	`85`	`+ Config config = Config.build().withSessionLivenessCheckTimeout( 1337 ).toConfig();`
`86`	`86`
`87`	`87`	`// then`
`88`	`88`	`assertThat( config.idleTimeBeforeConnectionTest(), equalTo( 1337l ));`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public static Driver configuration() throws Exception`
`52`	`52`	`{`
`53`	`53`	`// tag::configuration[]`
`54`	`54`	`Driver driver =`
`55`		`- GraphDatabase.driver( "bolt://localhost", Config.build().withConnectionPoolSize( 10 ).toConfig() );`
	`55`	`+ GraphDatabase.driver( "bolt://localhost", Config.build().withMaxSessions( 10 ).toConfig() );`
`56`	`56`	`// end::configuration[]`
`57`	`57`
`58`	`58`	`return driver;`