Created Super and Sub routing procedures for multi clustering feature

- Super procedure simply returns a list of the router capable hosts in a
cluster, split by database name.

- Sub procedure is similar, though takes a database name as a parameter
and only returns those router capable hosts which contain that database.

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/core/CausalClusterConfigurationValidator.java

@@ -23,7 +23,7 @@
 import java.util.Map;
 import javax.annotation.Nonnull;
 
-import org.neo4j.causalclustering.load_balancing.LoadBalancingPluginLoader;
+import org.neo4j.causalclustering.routing.load_balancing.LoadBalancingPluginLoader;
 import org.neo4j.graphdb.config.InvalidSettingException;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.configuration.ConfigurationValidator;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/core/EnterpriseCoreEditionModule.java

@@ -54,11 +54,11 @@
 import org.neo4j.causalclustering.handlers.PipelineWrapper;
 import org.neo4j.causalclustering.handlers.VoidPipelineWrapperFactory;
 import org.neo4j.causalclustering.identity.MemberId;
-import org.neo4j.causalclustering.load_balancing.LoadBalancingPluginLoader;
-import org.neo4j.causalclustering.load_balancing.LoadBalancingProcessor;
-import org.neo4j.causalclustering.load_balancing.procedure.GetServersProcedureForMultiDC;
-import org.neo4j.causalclustering.load_balancing.procedure.GetServersProcedureForSingleDC;
-import org.neo4j.causalclustering.load_balancing.procedure.LegacyGetServersProcedure;
+import org.neo4j.causalclustering.routing.load_balancing.LoadBalancingPluginLoader;
+import org.neo4j.causalclustering.routing.load_balancing.LoadBalancingProcessor;
+import org.neo4j.causalclustering.routing.load_balancing.procedure.GetServersProcedureForMultiDC;
+import org.neo4j.causalclustering.routing.load_balancing.procedure.GetServersProcedureForSingleDC;
+import org.neo4j.causalclustering.routing.load_balancing.procedure.LegacyGetServersProcedure;
 import org.neo4j.causalclustering.logging.BetterMessageLogger;
 import org.neo4j.causalclustering.logging.MessageLogger;
 import org.neo4j.causalclustering.logging.NullMessageLogger;
@@ -78,6 +78,8 @@
 import org.neo4j.causalclustering.protocol.handshake.ModifierProtocolRepository;
 import org.neo4j.causalclustering.protocol.handshake.ModifierSupportedProtocols;
 import org.neo4j.causalclustering.protocol.handshake.ProtocolStack;
+import org.neo4j.causalclustering.routing.multi_cluster.procedure.GetSubClusterRoutersProcedure;
+import org.neo4j.causalclustering.routing.multi_cluster.procedure.GetSuperClusterRoutersProcedure;
 import org.neo4j.com.storecopy.StoreUtil;
 import org.neo4j.function.Predicates;
 import org.neo4j.graphdb.DependencyResolver;
@@ -177,6 +179,8 @@ public void registerEditionSpecificProcedures( Procedures procedures ) throws Ke
                     config, logProvider ) );
         }
 
+        procedures.register( new GetSuperClusterRoutersProcedure( topologyService, config ) );
+        procedures.register( new GetSubClusterRoutersProcedure( topologyService, config ) );
         procedures.register( new ClusterOverviewProcedure( topologyService, logProvider ) );
         procedures.register( new CoreRoleProcedure( consensusModule.raftMachine() ) );
         procedures.register( new InstalledProtocolsProcedure( clientInstalledProtocols, serverInstalledProtocols ) );

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/readreplica/UserDefinedConfigurationStrategy.java

@@ -30,10 +30,10 @@
 import org.neo4j.causalclustering.discovery.DiscoveryServerInfo;
 import org.neo4j.causalclustering.discovery.Topology;
 import org.neo4j.causalclustering.identity.MemberId;
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
-import org.neo4j.causalclustering.load_balancing.plugins.server_policies.FilterConfigParser;
-import org.neo4j.causalclustering.load_balancing.plugins.server_policies.InvalidFilterSpecification;
-import org.neo4j.causalclustering.load_balancing.plugins.server_policies.ServerInfo;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies.FilterConfigParser;
+import org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies.InvalidFilterSpecification;
+import org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies.ServerInfo;
 import org.neo4j.helpers.Service;
 
 @Service.Implementation( UpstreamDatabaseSelectionStrategy.class )

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/Endpoint.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/Endpoint.java

@@ -17,9 +17,10 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing;
 
 import java.util.Objects;
+import java.util.Optional;
 
 import org.neo4j.helpers.AdvertisedSocketAddress;
 
@@ -38,6 +39,12 @@ public Endpoint( AdvertisedSocketAddress address, Role role )
         this.role = role;
     }
 
+    public Endpoint( AdvertisedSocketAddress address, Role role, String dbName )
+    {
+        this.address = address;
+        this.role = role;
+    }
+
     public AdvertisedSocketAddress address()
     {
         return address;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/Role.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/Role.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing;
 
 /**
  * Defines a capability of an endpoint.

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/RoutingResult.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2002-2018 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.causalclustering.routing;
+
+
+public interface RoutingResult
+{
+    /**
+     * @return The time-to-live of the returned result.
+     */
+    long ttlMillis();
+}

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/Util.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/Util.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing;
 
 import java.util.Collections;
 import java.util.List;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/LoadBalancingPlugin.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/LoadBalancingPlugin.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing.load_balancing;
 
 import org.neo4j.causalclustering.core.consensus.LeaderLocator;
 import org.neo4j.causalclustering.discovery.TopologyService;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/LoadBalancingPluginLoader.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/LoadBalancingPluginLoader.java

@@ -17,15 +17,15 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing.load_balancing;
 
 import java.util.HashSet;
 import java.util.Set;
 
 import org.neo4j.causalclustering.core.CausalClusteringSettings;
 import org.neo4j.causalclustering.core.consensus.LeaderLocator;
 import org.neo4j.causalclustering.discovery.TopologyService;
-import org.neo4j.causalclustering.load_balancing.plugins.ServerShufflingProcessor;
+import org.neo4j.causalclustering.routing.load_balancing.plugins.ServerShufflingProcessor;
 import org.neo4j.graphdb.config.InvalidSettingException;
 import org.neo4j.helpers.Service;
 import org.neo4j.kernel.configuration.Config;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/LoadBalancingProcessor.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/LoadBalancingProcessor.java

@@ -17,11 +17,13 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing.load_balancing;
 
 import java.util.List;
 import java.util.Map;
 
+import org.neo4j.causalclustering.routing.Endpoint;
+import org.neo4j.causalclustering.routing.RoutingResult;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 
 public interface LoadBalancingProcessor
@@ -35,13 +37,8 @@ public interface LoadBalancingProcessor
      */
     Result run( Map<String,String> context ) throws ProcedureException;
 
-    interface Result
+    interface Result extends RoutingResult
     {
-        /**
-         * @return The time-to-live of the returned result.
-         */
-        long getTimeToLiveMillis();
-
         /**
          * @return List of ROUTE-capable endpoints.
          */

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/LoadBalancingResult.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/LoadBalancingResult.java

@@ -17,11 +17,13 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing;
+package org.neo4j.causalclustering.routing.load_balancing;
 
 import java.util.List;
 import java.util.Objects;
 
+import org.neo4j.causalclustering.routing.Endpoint;
+
 /**
  * The outcome of applying a load balancing plugin, which will be used by client
  * software for scheduling work at the endpoints.
@@ -43,7 +45,7 @@ public LoadBalancingResult( List<Endpoint> routeEndpoints, List<Endpoint> writeE
     }
 
     @Override
-    public long getTimeToLiveMillis()
+    public long ttlMillis()
     {
         return timeToLiveMillis;
     }

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/filters/Filter.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/filters/Filter.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.filters;
+package org.neo4j.causalclustering.routing.load_balancing.filters;
 
 import java.util.Set;
 

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/filters/FilterChain.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/filters/FilterChain.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.filters;
+package org.neo4j.causalclustering.routing.load_balancing.filters;
 
 import java.util.List;
 import java.util.Objects;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/filters/FirstValidRule.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/filters/FirstValidRule.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.filters;
+package org.neo4j.causalclustering.routing.load_balancing.filters;
 
 import java.util.List;
 import java.util.Objects;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/filters/IdentityFilter.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/filters/IdentityFilter.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.filters;
+package org.neo4j.causalclustering.routing.load_balancing.filters;
 
 import java.util.Set;
 

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/filters/MinimumCountFilter.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/filters/MinimumCountFilter.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.filters;
+package org.neo4j.causalclustering.routing.load_balancing.filters;
 
 import java.util.Objects;
 import java.util.Set;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/ServerShufflingProcessor.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/ServerShufflingProcessor.java

@@ -17,12 +17,12 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins;
+package org.neo4j.causalclustering.routing.load_balancing.plugins;
 
 import java.util.Collections;
 import java.util.Map;
 
-import org.neo4j.causalclustering.load_balancing.LoadBalancingProcessor;
+import org.neo4j.causalclustering.routing.load_balancing.LoadBalancingProcessor;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 
 /**

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/AnyGroupFilter.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/AnyGroupFilter.java

@@ -17,14 +17,14 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
 
 import static org.neo4j.helpers.collection.Iterators.asSet;
 

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/FilterConfigParser.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/FilterConfigParser.java

@@ -17,18 +17,18 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
-import org.neo4j.causalclustering.load_balancing.filters.FilterChain;
-import org.neo4j.causalclustering.load_balancing.filters.FirstValidRule;
-import org.neo4j.causalclustering.load_balancing.filters.IdentityFilter;
-import org.neo4j.causalclustering.load_balancing.filters.MinimumCountFilter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.FilterChain;
+import org.neo4j.causalclustering.routing.load_balancing.filters.FirstValidRule;
+import org.neo4j.causalclustering.routing.load_balancing.filters.IdentityFilter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.MinimumCountFilter;
 
 import static java.lang.String.format;
 import static java.util.Collections.singletonList;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/FilteringPolicy.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/FilteringPolicy.java

@@ -17,12 +17,12 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.Objects;
 import java.util.Set;
 
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
 
 public class FilteringPolicy implements Policy
 {

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/FilteringPolicyLoader.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/FilteringPolicyLoader.java

@@ -17,13 +17,13 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
 
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.logging.Log;
 

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/HaltFilter.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/HaltFilter.java

@@ -17,11 +17,11 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.Set;
 
-import org.neo4j.causalclustering.load_balancing.filters.Filter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.Filter;
 
 /**
  * This filter is not meant for actual use. No more filters nor

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/InvalidFilterSpecification.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/InvalidFilterSpecification.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 public class InvalidFilterSpecification extends Exception
 {

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/Policies.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/Policies.java

@@ -17,12 +17,12 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.HashMap;
 import java.util.Map;
 
-import org.neo4j.causalclustering.load_balancing.filters.IdentityFilter;
+import org.neo4j.causalclustering.routing.load_balancing.filters.IdentityFilter;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.kernel.api.exceptions.Status;
 import org.neo4j.logging.Log;

enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/load_balancing/plugins/server_policies/Policy.java → enterprise/causal-clustering/src/main/java/org/neo4j/causalclustering/routing/load_balancing/plugins/server_policies/Policy.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.causalclustering.load_balancing.plugins.server_policies;
+package org.neo4j.causalclustering.routing.load_balancing.plugins.server_policies;
 
 import java.util.Set;