WIP

Author: BrandonArp

src/main/java/com/arpnetworking/akka/ActorBuilder.java

@@ -0,0 +1,66 @@
+package com.arpnetworking.akka;
+
+import akka.actor.ActorRef;
+import akka.actor.ActorSystem;
+import akka.actor.Props;
+import com.arpnetworking.commons.builder.OvalBuilder;
+import net.sf.oval.constraint.NotEmpty;
+import net.sf.oval.constraint.NotNull;
+import org.codehaus.jackson.map.annotate.JacksonInject;
+
+import java.util.function.Function;
+
+/**
+ * Builder for actors.
+ *
+ * @param <B> The type of the builder
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public abstract class ActorBuilder<B extends ActorBuilder<B>> extends OvalBuilder<ActorRef> {
+    /**
+     * Protected constructor.
+     *
+     * @param createProps method to create a {@link Props} from the {@link ActorBuilder}
+     */
+    protected ActorBuilder(final Function<B, Props> createProps) {
+        super(B::createActor);
+        _createProps = createProps;
+    }
+
+    public B setActorName(final String value) {
+        _actorName = value;
+        return self();
+    }
+
+    public B setActorSystem(final ActorSystem value) {
+        _actorSystem = value;
+        return self();
+    }
+
+    /**
+     * Creates an actor in the {@link ActorSystem}.  DO NOT OVERRIDE.
+     *
+     * @return an {@link ActorRef} to a newly launched actor
+     */
+    protected final ActorRef createActor(){
+        return this._actorSystem.actorOf(_createProps.apply(self()));
+    }
+
+    /**
+     * Called by setters to always return appropriate subclass of
+     * {@link ActorBuilder}, even from setters of base class.
+     *
+     * @return instance with correct {@link ActorBuilder} class type.
+     */
+    protected abstract B self();
+
+    @NotNull
+    @JacksonInject
+    protected ActorSystem _actorSystem;
+
+    @NotNull
+    @NotEmpty
+    protected String _actorName;
+
+    private final Function<B, Props> _createProps;
+}

src/main/java/com/arpnetworking/akka/NonJoiningClusterJoiner.java

@@ -0,0 +1,69 @@
+/**
+ * Copyright 2016 Inscope Metrics
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.arpnetworking.akka;
+
+import akka.actor.Props;
+import akka.actor.UntypedActor;
+
+/**
+ * Actor that does not attempt to join a cluster.
+ *
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public class NonJoiningClusterJoiner extends UntypedActor {
+    /**
+     * Static factory method for creating a {@link Props} to create a {@link NonJoiningClusterJoiner} actor.
+     *
+     * @return a new {@link Props}
+     */
+    public static Props props() {
+        return Props.create(NonJoiningClusterJoiner.class);
+    }
+
+    /**
+     * Static factory method for creating a {@link Props} to create a {@link NonJoiningClusterJoiner} actor from a
+     * {@link Builder}.
+     *
+     * @param builder Builder to create the Props from
+     * @return a new {@link Props}
+     */
+    private static Props props(final Builder builder) {
+        return props();
+    }
+
+    /**
+     * Public constructor.
+     */
+    public NonJoiningClusterJoiner() {
+    }
+
+    @Override
+    public void onReceive(final Object message) throws Exception {
+        unhandled(message);
+    }
+
+
+    public static class Builder extends ActorBuilder<Builder> {
+        public Builder() {
+            super(NonJoiningClusterJoiner::props);
+        }
+
+        @Override
+        public Builder self() {
+            return this;
+        }
+    }
+}

src/main/java/com/arpnetworking/clusteraggregator/GuiceModule.java

@@ -358,6 +358,14 @@ private ActorRef provideGracefulShutdownActor(final ActorSystem system, final In
         return system.actorOf(GuiceActorCreator.props(injector, GracefulShutdownActor.class), "graceful-shutdown");
     }
 
+//    @Provides
+//    @Singleton
+//    @Named("cluster-joiner")
+//    @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD") // Invoked reflectively by Guice
+//    private ActorRef provideClusterJoiner(final ActorSystem system, final Injector injector) {
+//        return system.actorOf(GuiceActorCreator.props(injector, NonJoiningClusterJoiner.class), "cluster-joiner");
+//    }
+
     @Provides
     @Named("cluster-host-suffix")
     @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD") // Invoked reflectively by Guice

src/main/java/com/arpnetworking/clusteraggregator/Main.java

@@ -24,12 +24,14 @@
 import com.arpnetworking.configuration.jackson.HoconFileSource;
 import com.arpnetworking.configuration.jackson.JsonNodeFileSource;
 import com.arpnetworking.configuration.jackson.JsonNodeSource;
+import com.arpnetworking.configuration.jackson.akka.ActorBuilderDeserializer;
 import com.arpnetworking.configuration.triggers.FileTrigger;
 import com.arpnetworking.steno.Logger;
 import com.arpnetworking.utility.Configurator;
 import com.arpnetworking.utility.Database;
 import com.arpnetworking.utility.Launchable;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.google.common.collect.Lists;
 import com.google.inject.Guice;
 import com.google.inject.Injector;
@@ -97,6 +99,9 @@ public static void main(final String[] args) {
             final File configurationFile = new File(args[0]);
             configurator = Optional.of(new Configurator<>(Main::new, ClusterAggregatorConfiguration.class));
             final ObjectMapper objectMapper = ClusterAggregatorConfiguration.createObjectMapper();
+            final SimpleModule module = new SimpleModule();
+            module.addDeserializer(ActorRef.class, new ActorBuilderDeserializer(objectMapper));
+            objectMapper.registerModule(module);
             configuration = Optional.of(new DynamicConfiguration.Builder()
                     .setObjectMapper(objectMapper)
                     .addSourceBuilder(getFileSourceBuilder(configurationFile, objectMapper))

src/main/java/com/arpnetworking/configuration/jackson/akka/ActorBuilderDeserializer.java

@@ -0,0 +1,56 @@
+package com.arpnetworking.configuration.jackson.akka;
+
+import akka.actor.ActorRef;
+import com.arpnetworking.commons.builder.Builder;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.TreeNode;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.TextNode;
+
+import java.io.IOException;
+
+/**
+ * Deserializer that will create an ActorBuilder for the given actor, then create the Actor from Guice
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public class ActorBuilderDeserializer extends JsonDeserializer<ActorRef> {
+    /**
+     * Public constructor.
+     *
+     * @param mapper the {@link ObjectMapper} to use to deserialize the {@link Builder}
+     */
+    public ActorBuilderDeserializer(final ObjectMapper mapper) {
+        _mapper = mapper;
+    }
+
+    @Override
+    public ActorRef deserialize(final JsonParser p, final DeserializationContext ctxt) throws IOException, JsonProcessingException {
+        final TreeNode treeNode = p.readValueAsTree();
+        final String type = ((TextNode) treeNode.get("type")).textValue();
+        try {
+            final Class<?> clazz = Class.forName(type);
+            final Class<? extends Builder<? extends ActorRef>> builder = getBuilderForClass(clazz);
+            final Builder<? extends ActorRef> value = _mapper.readValue(treeNode.toString(), builder);
+            return value.build();
+        } catch (ClassNotFoundException e) {
+            throw new JsonMappingException(p, String.format("Unable to find class %s referenced by ActorRef type", type));
+        } finally {
+            p.close();
+        }
+    }
+
+    @SuppressWarnings("unchecked")
+    private static Class<? extends Builder<ActorRef>> getBuilderForClass(final Class<?> clazz)
+            throws ClassNotFoundException {
+        return (Class<? extends Builder<ActorRef>>) (Class.forName(
+                clazz.getName() + "$Builder",
+                true, // initialize
+                clazz.getClassLoader()));
+    }
+
+    private final ObjectMapper _mapper;
+}

src/test/java/com/arpnetworking/clusteraggregator/configuration/ActorBuilderTest.java

@@ -0,0 +1,39 @@
+package com.arpnetworking.clusteraggregator.configuration;
+
+import akka.actor.ActorRef;
+import com.arpnetworking.akka.NonJoiningClusterJoiner;
+import com.arpnetworking.commons.jackson.databind.ObjectMapperFactory;
+import com.arpnetworking.configuration.jackson.akka.ActorBuilderDeserializer;
+import com.arpnetworking.utility.BaseActorTest;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import org.intellij.lang.annotations.Language;
+import org.junit.Test;
+
+import java.io.IOException;
+
+/**
+ * @author Brandon Arp (brandon dot arp at inscopemetrics dot com)
+ */
+public class ActorBuilderTest extends BaseActorTest {
+    @Test
+    public void testBuild() {
+        final NonJoiningClusterJoiner.Builder builder = new NonJoiningClusterJoiner.Builder();
+        builder.setActorName("foo");
+        builder.setActorSystem(getSystem());
+        builder.build();
+    }
+
+    @Test
+    public void testPolyDeserialize() throws IOException {
+        final ObjectMapper mapper = ObjectMapperFactory.createInstance();
+        final SimpleModule module = new SimpleModule();
+        module.addDeserializer(ActorRef.class, new ActorBuilderDeserializer(mapper));
+        mapper.registerModule(module);
+
+        @Language("JSON") final String data = "{\n" +
+                "  \"type\": \"com.arpnetworking.akka.NonJoiningClusterJoiner\"\n" +
+                "}";
+        final ActorRef ref = mapper.readValue(data, ActorRef.class);
+    }
+}