HTTP Based finders

lombok.config

@@ -0,0 +1,2 @@
+lombok.addLombokGeneratedAnnotation = true
+lombok.extern.findbugs.addSuppressFBWarnings = true

pom.xml

@@ -6,8 +6,14 @@
 
     <groupId>com.flipkart.ranger</groupId>
     <artifactId>ranger</artifactId>
-    <packaging>jar</packaging>
-    <version>0.6.3</version>
+    <packaging>pom</packaging>
+    <version>1.0-SNAPSHOT</version>
+    <modules>
+        <module>ranger-core</module>
+        <module>ranger-zookeeper</module>
+        <module>ranger-http</module>
+        <module>ranger-server</module>
+    </modules>
 
     <distributionManagement>
         <repository>
@@ -50,38 +56,36 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <guava.version>26.0-jre</guava.version>
         <curator.version>4.0.1</curator.version>
-        <jackson.version>2.9.5</jackson.version>
+        <jackson.version>2.10.1</jackson.version>
         <slf4j.version>1.7.25</slf4j.version>
-        <apache.httpclient.version>4.5.6</apache.httpclient.version>
 
         <maven.compiler.version>3.8.0</maven.compiler.version>
         <java.version>1.8</java.version>
+        <lombok.version>1.18.4</lombok.version>
+
     </properties>
 
     <dependencies>
         <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>${guava.version}</version>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>${lombok.version}</version>
+            <scope>provided</scope>
         </dependency>
-
-        <!--Curator-->
         <dependency>
-            <groupId>org.apache.curator</groupId>
-            <artifactId>curator-framework</artifactId>
-            <version>${curator.version}</version>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>annotations</artifactId>
+            <version>3.0.1</version>
         </dependency>
-
         <dependency>
-            <groupId>org.apache.curator</groupId>
-            <artifactId>curator-recipes</artifactId>
-            <version>${curator.version}</version>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>${guava.version}</version>
         </dependency>
         <dependency>
-            <groupId>org.apache.curator</groupId>
-            <artifactId>curator-test</artifactId>
-            <version>${curator.version}</version>
-            <scope>test</scope>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.26</version>
         </dependency>
 
         <dependency>
@@ -108,9 +112,10 @@
             <version>2.0.0</version>
         </dependency>
         <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
-            <version>${apache.httpclient.version}</version>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.0.2</version>
+            <scope>test</scope>
         </dependency>
     </dependencies>
 

ranger-core/pom.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>ranger</artifactId>
+        <groupId>com.flipkart.ranger</groupId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>ranger-core</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+            <version>${slf4j.version}</version>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>4.5.11</version>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.2.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>test-jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>

ranger-core/src/main/java/com/flipkart/ranger/core/finder/BaseServiceFinderBuilder.java

@@ -0,0 +1,179 @@
+/**
+ * Copyright 2015 Flipkart Internet Pvt. Ltd.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.flipkart.ranger.core.finder;
+
+import com.flipkart.ranger.core.finder.signals.ScheduledRegistryUpdateSignal;
+import com.flipkart.ranger.core.model.*;
+import com.flipkart.ranger.core.signals.Signal;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.Lists;
+import lombok.extern.slf4j.Slf4j;
+import lombok.val;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+
+@Slf4j
+public abstract class BaseServiceFinderBuilder
+        <
+                T,
+                R extends ServiceRegistry<T>,
+                F extends ServiceFinder<T, R>,
+                B extends BaseServiceFinderBuilder<T, R, F, B, D>,
+                D extends Deserializer<T>> {
+
+    protected String namespace;
+    protected String serviceName;
+    protected int nodeRefreshIntervalMs;
+    protected boolean disablePushUpdaters;
+    protected D deserializer;
+    protected ShardSelector<T, R> shardSelector;
+    protected ServiceNodeSelector<T> nodeSelector = new RandomServiceNodeSelector<>();
+    protected final List<Signal<T>> additionalRefreshSignals = new ArrayList<>();
+    protected final List<Consumer<Void>> startSignalHandlers = Lists.newArrayList();
+    protected final List<Consumer<Void>> stopSignalHandlers = Lists.newArrayList();
+
+    public B withNamespace(final String namespace) {
+        this.namespace = namespace;
+        return (B)this;
+    }
+
+    public B withServiceName(final String serviceName) {
+        this.serviceName = serviceName;
+        return (B)this;
+    }
+
+    public B withDeserializer(D deserializer) {
+        this.deserializer = deserializer;
+        return (B)this;
+    }
+
+    public B withShardSelector(ShardSelector<T, R> shardSelector) {
+        this.shardSelector = shardSelector;
+        return (B)this;
+    }
+
+    public B withNodeSelector(ServiceNodeSelector<T> nodeSelector) {
+        this.nodeSelector = null != nodeSelector ? nodeSelector : this.nodeSelector;
+        return (B)this;
+    }
+
+    public B withNodeRefreshIntervalMs(int nodeRefreshIntervalMs) {
+        this.nodeRefreshIntervalMs = nodeRefreshIntervalMs;
+        return (B)this;
+    }
+
+    public B withDisableWatchers() {
+        this.disablePushUpdaters = true;
+        return (B)this;
+    }
+
+    public B withDisableWatchers(boolean disablePushUpdaters) {
+        this.disablePushUpdaters = disablePushUpdaters;
+        return (B)this;
+    }
+
+    public B withAdditionalSignalGenerator(Signal<T> signalGenerator) {
+        this.additionalRefreshSignals.add(signalGenerator);
+        return (B)this;
+    }
+
+    public B withAdditionalSignalGenerators(Signal<T>... signalGenerators) {
+        this.additionalRefreshSignals.addAll(Arrays.asList(signalGenerators));
+        return (B)this;
+    }
+
+    public B withAdditionalSignalGenerators(List<Signal<T>> signalGenerators) {
+        this.additionalRefreshSignals.addAll(signalGenerators);
+        return (B)this;
+    }
+
+    public B withStartSignalHandler(Consumer<Void> startSignalHandler) {
+        this.startSignalHandlers.add(startSignalHandler);
+        return (B)this;
+    }
+
+    public B withStartSignalHandlers(List<Consumer<Void>> startSignalHandlers) {
+        this.startSignalHandlers.addAll(startSignalHandlers);
+        return (B)this;
+    }
+
+    public B withStopSignalHandler(Consumer<Void> stopSignalHandler) {
+        this.stopSignalHandlers.add(stopSignalHandler);
+        return (B)this;
+    }
+
+    public B withStopSignalHandlers(List<Consumer<Void>> stopSignalHandlers) {
+        this.stopSignalHandlers.addAll(stopSignalHandlers);
+        return (B)this;
+    }
+
+    public abstract F build();
+
+    protected F buildFinder() {
+        Preconditions.checkNotNull(namespace);
+        Preconditions.checkNotNull(serviceName);
+        Preconditions.checkNotNull(deserializer);
+
+        if (nodeRefreshIntervalMs < 1000) {
+            log.warn("Node refresh interval for {} is too low: {} ms. Has been upgraded to 1000ms ",
+                     serviceName, nodeRefreshIntervalMs);
+            nodeRefreshIntervalMs = 1000;
+        }
+        Service service = new Service(namespace, serviceName);
+        val finder = buildFinder(service, shardSelector, nodeSelector);
+        val registry = finder.getServiceRegistry();
+        List<Signal<T>> signalGenerators = new ArrayList<>();
+        final NodeDataSource<T, D> nodeDataSource = dataSource(service);
+
+        signalGenerators.add(new ScheduledRegistryUpdateSignal<>(service, nodeRefreshIntervalMs));
+        additionalRefreshSignals.addAll(implementationSpecificRefreshSignals(service, nodeDataSource));
+        if (!additionalRefreshSignals.isEmpty()) {
+            signalGenerators.addAll(additionalRefreshSignals);
+            log.debug("Added additional signal handlers");
+        }
+
+        val updater = new ServiceRegistryUpdater<T, D>(registry, nodeDataSource, signalGenerators, deserializer);
+        finder.getStartSignal()
+                .registerConsumers(startSignalHandlers)
+                .registerConsumer(x -> nodeDataSource.start())
+                .registerConsumer(x -> updater.start())
+                .registerConsumer(x -> signalGenerators.forEach(Signal::start));
+
+        finder.getStopSignal()
+                .registerConsumer(x -> signalGenerators.forEach(Signal::stop))
+                .registerConsumer(x -> updater.stop())
+                .registerConsumer(x -> nodeDataSource.stop())
+                .registerConsumers(stopSignalHandlers);
+        return finder;
+    }
+
+    protected List<Signal<T>> implementationSpecificRefreshSignals(Service service, NodeDataSource<T, D> nodeDataSource) {
+        return Collections.emptyList();
+    }
+
+    protected abstract NodeDataSource<T, D> dataSource(Service service);
+
+    protected abstract F buildFinder(
+            Service service,
+            ShardSelector<T, R> shardSelector,
+            ServiceNodeSelector<T> nodeSelector);
+
+}

src/main/java/com/flipkart/ranger/finder/RandomServiceNodeSelector.java → ranger-core/src/main/java/com/flipkart/ranger/core/finder/RandomServiceNodeSelector.java

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package com.flipkart.ranger.finder;
+package com.flipkart.ranger.core.finder;
 
-import com.flipkart.ranger.model.ServiceNode;
-import com.flipkart.ranger.model.ServiceNodeSelector;
+import com.flipkart.ranger.core.model.ServiceNode;
+import com.flipkart.ranger.core.model.ServiceNodeSelector;
 
 import java.util.List;
 import java.util.concurrent.ThreadLocalRandom;

src/main/java/com/flipkart/ranger/finder/RoundRobinServiceNodeSelector.java → ranger-core/src/main/java/com/flipkart/ranger/core/finder/RoundRobinServiceNodeSelector.java

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package com.flipkart.ranger.finder;
+package com.flipkart.ranger.core.finder;
 
-import com.flipkart.ranger.model.ServiceNode;
-import com.flipkart.ranger.model.ServiceNodeSelector;
+import com.flipkart.ranger.core.model.ServiceNode;
+import com.flipkart.ranger.core.model.ServiceNodeSelector;
 
 import java.util.List;