Renamed a few classes and added more java docs

Author: Zhen Li

driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTableHandler.java

@@ -36,7 +36,7 @@ public class RoutingTableHandler implements RoutingErrorHandler
 {
     private final RoutingTable routingTable;
     private final String databaseName;
-    private final RoutingTables routingTables;
+    private final RoutingTableRegistry routingTableRegistry;
     private volatile CompletableFuture<RoutingTable> refreshRoutingTableFuture;
     private final ConnectionPool connectionPool;
     private final Rediscovery rediscovery;
@@ -46,14 +46,13 @@ public class RoutingTableHandler implements RoutingErrorHandler
     // TODO make this a configuration option
     public static final Duration STALE_ROUTING_TABLE_PURGE_TIMEOUT = Duration.ofSeconds( 30 );
 
-
-    public RoutingTableHandler( RoutingTable routingTable, Rediscovery rediscovery, ConnectionPool connectionPool, RoutingTables routingTables, Logger log )
+    public RoutingTableHandler( RoutingTable routingTable, Rediscovery rediscovery, ConnectionPool connectionPool, RoutingTableRegistry routingTableRegistry, Logger log )
     {
         this.routingTable = routingTable;
         this.databaseName = routingTable.database();
         this.rediscovery = rediscovery;
         this.connectionPool = connectionPool;
-        this.routingTables = routingTables;
+        this.routingTableRegistry = routingTableRegistry;
         this.log = log;
     }
 
@@ -113,8 +112,8 @@ private synchronized void freshClusterCompositionFetched( ClusterComposition com
         try
         {
             routingTable.update( composition );
-            routingTables.purgeAged();
-            connectionPool.retainAll( routingTables.allServers() );
+            routingTableRegistry.purgeAged();
+            connectionPool.retainAll( routingTableRegistry.allServers() );
 
             log.info( "Updated routing table for database '%s'. %s", databaseName, routingTable );
 
@@ -131,7 +130,7 @@ private synchronized void freshClusterCompositionFetched( ClusterComposition com
     private synchronized void clusterCompositionLookupFailed( Throwable error )
     {
         log.error( String.format( "Failed to update routing table for database '%s'. Current routing table: %s.", databaseName, routingTable ), error );
-        routingTables.remove( databaseName );
+        routingTableRegistry.remove( databaseName );
         CompletableFuture<RoutingTable> routingTableFuture = refreshRoutingTableFuture;
         refreshRoutingTableFuture = null;
         routingTableFuture.completeExceptionally( error );

driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTables.java renamed to driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTableRegistry.java

@@ -28,22 +28,22 @@
  * A generic interface to access all routing tables as a whole.
  * It also provides methods to obtain a routing table or manage a routing table for a specified database.
  */
-public interface RoutingTables
+public interface RoutingTableRegistry
 {
     /**
-     * Fresh the routing table for the database and given access mode.
-     * For server version lower than 4.0, the database name will be ignored while refresh routing table.
+     * Fresh the routing table for the database with given access mode.
+     * For server version lower than 4.0, the database name will be ignored while refreshing routing table.
      * @return The future of a new routing table handler.
      */
     CompletionStage<RoutingTableHandler> refreshRoutingTable( String databaseName, AccessMode mode );
 
     /**
-     * @return all servers in all routing tables
+     * @return all servers in the registry
      */
     Set<BoltServerAddress> allServers();
 
     /**
-     * Removes a routing table of the given database from all tables.
+     * Removes a routing table of the given database from registry.
      */
     void remove( String databaseName );
 

driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTablesImpl.java renamed to driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTableRegistryImpl.java

@@ -30,18 +30,18 @@
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.util.Clock;
 
-public class RoutingTablesImpl implements RoutingTables
+public class RoutingTableRegistryImpl implements RoutingTableRegistry
 {
     private final ConcurrentMap<String,RoutingTableHandler> routingTables;
     private final RoutingTableHandlerFactory factory;
     private final Logger logger;
 
-    public RoutingTablesImpl( ConnectionPool connectionPool, Rediscovery rediscovery, Clock clock, Logger logger )
+    public RoutingTableRegistryImpl( ConnectionPool connectionPool, Rediscovery rediscovery, Clock clock, Logger logger )
     {
         this( new ConcurrentHashMap<>(), new RoutingTableHandlerFactory( connectionPool, rediscovery, clock, logger ), logger );
     }
 
-    RoutingTablesImpl( ConcurrentMap<String,RoutingTableHandler> routingTables, RoutingTableHandlerFactory factory, Logger logger )
+    RoutingTableRegistryImpl( ConcurrentMap<String,RoutingTableHandler> routingTables, RoutingTableHandlerFactory factory, Logger logger )
     {
         this.factory = factory;
         this.routingTables = routingTables;
@@ -118,7 +118,7 @@ static class RoutingTableHandlerFactory
             this.log = log;
         }
 
-        RoutingTableHandler newInstance( String databaseName, RoutingTables allTables )
+        RoutingTableHandler newInstance( String databaseName, RoutingTableRegistry allTables )
         {
             ClusterRoutingTable routingTable = new ClusterRoutingTable( databaseName, clock );
             return new RoutingTableHandler( routingTable, rediscovery, connectionPool, allTables, log );

driver/src/main/java/org/neo4j/driver/internal/cluster/loadbalancing/LoadBalancer.java

@@ -37,8 +37,8 @@
 import org.neo4j.driver.internal.cluster.RoutingProcedureClusterCompositionProvider;
 import org.neo4j.driver.internal.cluster.RoutingSettings;
 import org.neo4j.driver.internal.cluster.RoutingTable;
-import org.neo4j.driver.internal.cluster.RoutingTables;
-import org.neo4j.driver.internal.cluster.RoutingTablesImpl;
+import org.neo4j.driver.internal.cluster.RoutingTableRegistry;
+import org.neo4j.driver.internal.cluster.RoutingTableRegistryImpl;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.spi.ConnectionProvider;
@@ -53,7 +53,7 @@ public class LoadBalancer implements ConnectionProvider
 {
     private static final String LOAD_BALANCER_LOG_NAME = "LoadBalancer";
     private final ConnectionPool connectionPool;
-    private final RoutingTables routingTables;
+    private final RoutingTableRegistry routingTables;
     private final LoadBalancingStrategy loadBalancingStrategy;
     private final EventExecutorGroup eventExecutorGroup;
     private final Logger log;
@@ -66,7 +66,7 @@ public LoadBalancer( BoltServerAddress initialRouter, RoutingSettings settings,
                 loadBalancerLogger( logging ), loadBalancingStrategy, eventExecutorGroup );
     }
 
-    LoadBalancer( ConnectionPool connectionPool, RoutingTables routingTables, Logger log, LoadBalancingStrategy loadBalancingStrategy,
+    LoadBalancer( ConnectionPool connectionPool, RoutingTableRegistry routingTables, Logger log, LoadBalancingStrategy loadBalancingStrategy,
             EventExecutorGroup eventExecutorGroup )
     {
         this.connectionPool = connectionPool;
@@ -168,12 +168,12 @@ private BoltServerAddress selectAddress( AccessMode mode, AddressSet servers )
         }
     }
 
-    private static RoutingTables createRoutingTables( ConnectionPool connectionPool, EventExecutorGroup eventExecutorGroup, BoltServerAddress initialRouter,
+    private static RoutingTableRegistry createRoutingTables( ConnectionPool connectionPool, EventExecutorGroup eventExecutorGroup, BoltServerAddress initialRouter,
             ServerAddressResolver resolver, RoutingSettings settings, Clock clock, Logging logging )
     {
         Logger log = loadBalancerLogger( logging );
         Rediscovery rediscovery = createRediscovery( eventExecutorGroup, initialRouter, resolver, settings, clock, log );
-        return new RoutingTablesImpl( connectionPool, rediscovery, clock, log );
+        return new RoutingTableRegistryImpl( connectionPool, rediscovery, clock, log );
     }
 
     private static Rediscovery createRediscovery( EventExecutorGroup eventExecutorGroup, BoltServerAddress initialRouter, ServerAddressResolver resolver,

driver/src/test/java/org/neo4j/driver/internal/cluster/RoutingTableHandlerTest.java

@@ -155,7 +155,7 @@ void shouldRetainAllFetchedAddressesInConnectionPoolAfterFetchingOfRoutingTable(
         when( rediscovery.lookupClusterComposition( any(), any() ) ).thenReturn( completedFuture(
                 new ClusterComposition( 42, asOrderedSet( A, B ), asOrderedSet( B, C ), asOrderedSet( A, C ) ) ) );
 
-        RoutingTables routingTables = new RoutingTables()
+        RoutingTableRegistry routingTables = new RoutingTableRegistry()
         {
             @Override
             public CompletionStage<RoutingTableHandler> refreshRoutingTable( String databaseName, AccessMode mode )
@@ -200,7 +200,7 @@ void shouldRemoveRoutingTableHandlerIfFailedToLookup() throws Throwable
         when( rediscovery.lookupClusterComposition( any(), any() ) ).thenReturn( Futures.failedFuture( new RuntimeException( "Bang!" ) ) );
 
         ConnectionPool connectionPool = newConnectionPoolMock();
-        RoutingTables routingTables = newRoutingTablesMock();
+        RoutingTableRegistry routingTables = newRoutingTablesMock();
         // When
 
         RoutingTableHandler handler = new RoutingTableHandler( routingTable, rediscovery, connectionPool, routingTables, DEV_NULL_LOGGER );
@@ -258,9 +258,9 @@ private static RoutingTable newStaleRoutingTableMock( AccessMode mode )
         return routingTable;
     }
 
-    private static RoutingTables newRoutingTablesMock()
+    private static RoutingTableRegistry newRoutingTablesMock()
     {
-        return mock( RoutingTables.class );
+        return mock( RoutingTableRegistry.class );
     }
 
     private static Rediscovery newRediscoveryMock()

driver/src/test/java/org/neo4j/driver/internal/cluster/RoutingTablesImplTest.java renamed to driver/src/test/java/org/neo4j/driver/internal/cluster/RoutingTableRegistryImplTest.java

@@ -18,7 +18,6 @@
  */
 package org.neo4j.driver.internal.cluster;
 
-import org.hamcrest.CoreMatchers;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
@@ -32,7 +31,7 @@
 
 import org.neo4j.driver.AccessMode;
 import org.neo4j.driver.internal.BoltServerAddress;
-import org.neo4j.driver.internal.cluster.RoutingTablesImpl.RoutingTableHandlerFactory;
+import org.neo4j.driver.internal.cluster.RoutingTableRegistryImpl.RoutingTableHandlerFactory;
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.util.Clock;
 
@@ -60,25 +59,23 @@
 import static org.neo4j.driver.internal.util.ClusterCompositionUtil.F;
 import static org.neo4j.driver.util.TestUtil.await;
 
-class RoutingTablesImplTest
+class RoutingTableRegistryImplTest
 {
     @Test
     void factoryShouldCreateARoutingTableWithSameDatabaseName() throws Throwable
     {
         Clock clock = Clock.SYSTEM;
-        BoltServerAddress initialRouter = new BoltServerAddress( "localhost:7687" );
         RoutingTableHandlerFactory factory =
                 new RoutingTableHandlerFactory( mock( ConnectionPool.class ), mock( RediscoveryImpl.class ), clock, DEV_NULL_LOGGER );
 
         RoutingTableHandler handler = factory.newInstance( "Molly", null );
         RoutingTable table = handler.routingTable();
 
         assertThat( table.database(), equalTo( "Molly" ) );
-        assertThat( table.servers(), contains( CoreMatchers.equalTo( initialRouter ) ) );
-        assertThat( Arrays.asList( table.routers().toArray() ), contains( CoreMatchers.equalTo( initialRouter ) ) );
 
-        assertThat( table.readers().size(), CoreMatchers.equalTo( 0 ) );
-        assertThat( table.writers().size(), CoreMatchers.equalTo( 0 ) );
+        assertThat( table.routers().size(), equalTo( 0 ) );
+        assertThat( table.readers().size(), equalTo( 0 ) );
+        assertThat( table.writers().size(), equalTo( 0 ) );
 
         assertTrue( table.isStaleFor( AccessMode.READ ) );
         assertTrue( table.isStaleFor( AccessMode.WRITE ) );
@@ -91,7 +88,7 @@ void shouldCreateRoutingTableHandlerIfAbsentWhenFreshRoutingTable( String databa
         // Given
         ConcurrentMap<String,RoutingTableHandler> map = new ConcurrentHashMap<>();
         RoutingTableHandlerFactory factory = mockedHandlerFactory();
-        RoutingTablesImpl routingTables = newRoutingTables( map, factory );
+        RoutingTableRegistryImpl routingTables = newRoutingTables( map, factory );
 
         // When
         routingTables.refreshRoutingTable( databaseName, AccessMode.READ );
@@ -111,7 +108,7 @@ void shouldReturnExistingRoutingTableHandlerWhenFreshRoutingTable( String databa
         map.put( databaseName, handler );
 
         RoutingTableHandlerFactory factory = mockedHandlerFactory();
-        RoutingTablesImpl routingTables = newRoutingTables( map, factory );
+        RoutingTableRegistryImpl routingTables = newRoutingTables( map, factory );
 
         // When
         RoutingTableHandler actual = await( routingTables.refreshRoutingTable( databaseName, AccessMode.READ ) );
@@ -130,7 +127,7 @@ void shouldReturnFreshRoutingTable( AccessMode mode ) throws Throwable
         ConcurrentMap<String,RoutingTableHandler> map = new ConcurrentHashMap<>();
         RoutingTableHandler handler = mockedRoutingTableHandler();
         RoutingTableHandlerFactory factory = mockedHandlerFactory( handler );
-        RoutingTablesImpl routingTables = new RoutingTablesImpl( map, factory, DEV_NULL_LOGGER );
+        RoutingTableRegistryImpl routingTables = new RoutingTableRegistryImpl( map, factory, DEV_NULL_LOGGER );
 
         // When
         routingTables.refreshRoutingTable( ABSENT_DB_NAME, mode );
@@ -148,7 +145,7 @@ void shouldReturnServersInAllRoutingTables() throws Throwable
         map.put( "Banana", mockedRoutingTableHandler( B, C, D ) );
         map.put( "Orange", mockedRoutingTableHandler( E, F, C ) );
         RoutingTableHandlerFactory factory = mockedHandlerFactory();
-        RoutingTablesImpl routingTables = new RoutingTablesImpl( map, factory, DEV_NULL_LOGGER );
+        RoutingTableRegistryImpl routingTables = new RoutingTableRegistryImpl( map, factory, DEV_NULL_LOGGER );
 
         // When
         Set<BoltServerAddress> servers = routingTables.allServers();
@@ -167,7 +164,7 @@ void shouldRemoveRoutingTableHandler() throws Throwable
         map.put( "Orange", mockedRoutingTableHandler( C ) );
 
         RoutingTableHandlerFactory factory = mockedHandlerFactory();
-        RoutingTablesImpl routingTables = newRoutingTables( map, factory );
+        RoutingTableRegistryImpl routingTables = newRoutingTables( map, factory );
 
         // When
         routingTables.remove( "Apple" );
@@ -185,7 +182,7 @@ void shouldRemoveStatleRoutingTableHandlers() throws Throwable
         map.put( "Orange", mockedRoutingTableHandler( C ) );
 
         RoutingTableHandlerFactory factory = mockedHandlerFactory();
-        RoutingTablesImpl routingTables = newRoutingTables( map, factory );
+        RoutingTableRegistryImpl routingTables = newRoutingTables( map, factory );
 
         // When
         routingTables.purgeAged();
@@ -201,9 +198,9 @@ private RoutingTableHandler mockedRoutingTableHandler( BoltServerAddress... serv
         return handler;
     }
 
-    private RoutingTablesImpl newRoutingTables( ConcurrentMap<String,RoutingTableHandler> handlers, RoutingTableHandlerFactory factory )
+    private RoutingTableRegistryImpl newRoutingTables( ConcurrentMap<String,RoutingTableHandler> handlers, RoutingTableHandlerFactory factory )
     {
-        return new RoutingTablesImpl( handlers, factory, DEV_NULL_LOGGER );
+        return new RoutingTableRegistryImpl( handlers, factory, DEV_NULL_LOGGER );
     }
 
     private RoutingTableHandlerFactory mockedHandlerFactory( RoutingTableHandler handler )

driver/src/test/java/org/neo4j/driver/internal/cluster/loadbalancing/LoadBalancerTest.java

@@ -40,7 +40,7 @@
 import org.neo4j.driver.internal.cluster.ClusterRoutingTable;
 import org.neo4j.driver.internal.cluster.RoutingTable;
 import org.neo4j.driver.internal.cluster.RoutingTableHandler;
-import org.neo4j.driver.internal.cluster.RoutingTables;
+import org.neo4j.driver.internal.cluster.RoutingTableRegistry;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.util.FakeClock;
@@ -229,7 +229,7 @@ private static ConnectionPool newConnectionPoolMockWithFailures(
     private static LoadBalancer newLoadBalancer( ConnectionPool connectionPool, RoutingTable routingTable )
     {
         // Used only in testing
-        RoutingTables routingTables = mock( RoutingTables.class );
+        RoutingTableRegistry routingTables = mock( RoutingTableRegistry.class );
         RoutingTableHandler handler = mock( RoutingTableHandler.class );
         when( handler.routingTable() ).thenReturn( routingTable );
         when( routingTables.refreshRoutingTable( any( String.class ), any( AccessMode.class ) ) ).thenReturn( CompletableFuture.completedFuture( handler ) );