code cleanup

Author: Crim

src/main/java/org/sourcelab/storm/spout/redis/RedisStreamSpoutConfig.java

@@ -185,7 +185,7 @@ public static final class Builder {
  /**
  * Connection details.
  */
- private final List<RedisServer> clusterServers = new ArrayList<>();
+ private final List<RedisServer> clusterNodes = new ArrayList<>();
  private RedisServer redisServer = null;
 
  /**
@@ -217,52 +217,94 @@ public static final class Builder {
  private Builder() {
  }
 
- public Builder withServer(final RedisServer redisServer) {
- if (!clusterServers.isEmpty()) {
- // Cannot define both cluster servers and redis server instances.
- throw new IllegalArgumentException("TODO");
- }
- this.redisServer = Objects.requireNonNull(redisServer);
- return this;
- }
-
- public Builder withServer(final String host, final int port, final String password) {
- return withServer(new RedisServer(host, port, password));
- }
-
+ /**
+ * Define connection details for connecting to a single Redis server.
+ *
+ * NOTE: If you want to connect to a RedisCluster, {@link Builder#withClusterNode}.
+ *
+ * @param host Host of redis server to connect to.
+ * @param port Port of redis server to connect to.
+ * @return Builder.
+ */
  public Builder withServer(final String host, final int port) {
  return withServer(host, port, null);
  }
 
-
- public Builder withClusters(final RedisServer...clusterServers) {
- Arrays.stream(clusterServers)
- .forEach(this::withCluster);
- return this;
+ /**
+ * Define connection details for connecting to a single Redis server.
+ *
+ * NOTE: If you want to connect to a RedisCluster, {@link Builder#withClusterNode}.
+ *
+ * @param host Host of redis server to connect to.
+ * @param port Port of redis server to connect to.
+ * @param password (optional) Password for redis server, or NULL if no password required.
+ * @return Builder.
+ */
+ public Builder withServer(final String host, final int port, final String password) {
+ return withServer(new RedisServer(host, port, password));
  }
 
- public Builder withCluster(final RedisServer clusterServer) {
- if (redisServer != null) {
+ /**
+ * Define connection details for connecting to a single Redis server.
+ *
+ * NOTE: If you want to connect to a RedisCluster, {@link Builder#withClusterNode}.
+ *
+ * @param redisServer Defines a redis server to connect to.
+ * @return Builder.
+ */
+ private Builder withServer(final RedisServer redisServer) {
+ if (!clusterNodes.isEmpty()) {
  // Cannot define both cluster servers and redis server instances.
  throw new IllegalArgumentException("TODO");
  }
- clusterServers.add(Objects.requireNonNull(clusterServer));
+ this.redisServer = Objects.requireNonNull(redisServer);
  return this;
  }
 
- public Builder withCluster(final String host, final int port, final String password) {
- return withCluster(new RedisServer(host, port, password));
+ /**
+ * Define connection details for connecting to a RedisCluster.
+ * Call this method as many times as needed to add nodes in your cluster.
+ *
+ * NOTE: If you want to connect to a single redis instance, {@link Builder#withServer}.
+ *
+ * @param host Host of redis node.
+ * @param port Port of redis node.
+ * @return Builder.
+ */
+ public Builder withClusterNode(final String host, final int port) {
+ return withClusterNode(host, port, null);
  }
 
- public Builder withCluster(final String host, final int port) {
- return withCluster(host, port, null);
+ /**
+ * Define connection details for connecting to a RedisCluster.
+ * Call this method as many times as needed to add nodes in your cluster.
+ *
+ * NOTE: If you want to connect to a single redis instance, {@link Builder#withServer}.
+ *
+ * @param host Host of redis node.
+ * @param port Port of redis node.
+ * @param password (optional) Password for redis node, or NULL if no password required.
+ * @return Builder.
+ */
+ public Builder withClusterNode(final String host, final int port, final String password) {
+ return withClusterNode(new RedisServer(host, port, password));
  }
 
- public Builder withCluster(final RedisCluster redisCluster) {
- Objects.requireNonNull(redisCluster);
-
- this.clusterServers.clear();
- this.clusterServers.addAll(redisCluster.getServers());
+ /**
+ * Define connection details for connecting to a RedisCluster.
+ * Call this method as many times as needed to add nodes in your cluster.
+ *
+ * NOTE: If you want to connect to a single redis instance, {@link Builder#withServer}.
+ *
+ * @param node Defines a node in the RedisCluster.
+ * @return Builder.
+ */
+ private Builder withClusterNode(final RedisServer node) {
+ if (redisServer != null) {
+ // Cannot define both cluster servers and redis server instances.
+ throw new IllegalArgumentException("TODO");
+ }
+ clusterNodes.add(Objects.requireNonNull(node));
  return this;
  }
 
@@ -335,8 +377,8 @@ public Builder withMetricsEnabled(final boolean enabled) {
  */
  public RedisStreamSpoutConfig build() {
  RedisCluster redisCluster = null;
- if (!clusterServers.isEmpty()) {
- redisCluster = new RedisCluster(clusterServers);
+ if (!clusterNodes.isEmpty()) {
+ redisCluster = new RedisCluster(clusterNodes);
  }
 
  return new RedisStreamSpoutConfig(
@@ -354,13 +396,16 @@ public RedisStreamSpoutConfig build() {
  }
  }
 
+ /**
+ * Defines a RedisCluster connection details.
+ */
  public static class RedisCluster {
  private final List<RedisServer> servers;
 
- public RedisCluster(final RedisServer...servers) {
-  this(Arrays.asList(servers));
- }
-
+ /**
+ * Constructor.
+  * @param servers One or more Nodes in the RedisCluster.
+ */
  public RedisCluster(final List<RedisServer> servers) {
  Objects.requireNonNull(servers);
  this.servers = Collections.unmodifiableList(new ArrayList<>(servers));
@@ -377,22 +422,40 @@ public String toString() {
  + '}';
  }
 
+ /**
+ * The URI for connecting to this RedisCluster.
+ * @return URI for the cluster.
+ */
  public String getConnectString() {
  return getServers().stream()
  .map(RedisServer::getConnectString)
  .collect(Collectors.joining(","));
  }
  }
 
+ /**
+ * Defines a Single RedisServer instance connection details.
+ */
  public static class RedisServer {
  private final String host;
  private final int port;
  private final String password;
 
+ /**
+ * Constructor.
+ * @param host hostname of redis server.
+ * @param port port of redis server.
+ */
  public RedisServer(final String host, final int port) {
  this(host, port, null);
  }
 
+ /**
+ * Constructor.
+ * @param host hostname of redis server.
+ * @param port port of redis server.
+ * @param password (optional) password for server, or NULL if not required.
+ */
  public RedisServer(final String host, final int port, final String password) {
  this.host = host;
  this.port = port;
@@ -411,10 +474,10 @@ public String getPassword() {
  return password;
  }
 
- public boolean hasPassword() {
-  return password != null;
- }
-
+ /**
+ * The URI for connecting to this Redis Server instance.
+  * @return URI for the server.
+ */
  public String getConnectString() {
  String connectStr = "redis://";
 

src/main/java/org/sourcelab/storm/spout/redis/client/LettuceClient.java

@@ -58,8 +58,10 @@ public LettuceClient(final RedisStreamSpoutConfig config, final int instanceId)
  this(
  config,
  instanceId,
- config.isConnectingToCluster() ?
- new LettuceClusterClient(RedisClusterClient.create(config.getConnectString()))
+ // Determine which adapter to use based on what type of redis instance we are
+ // communicating with.
+ config.isConnectingToCluster()
+ ? new LettuceClusterClient(RedisClusterClient.create(config.getConnectString()))
  : new LettuceRedisClient(RedisClient.create(config.getConnectString()))
  );
  }

src/main/java/org/sourcelab/storm/spout/redis/client/LettuceClusterClient.java

@@ -7,7 +7,8 @@
 import java.util.Objects;
 
 /**
- *
+ * Adapter for talking to a RedisCluster.
+ * If you need to talk to a single Redis instance {@link LettuceRedisClient}.
  */
 public class LettuceClusterClient implements LettuceAdapter {
  /**

src/main/java/org/sourcelab/storm/spout/redis/client/LettuceRedisClient.java

@@ -3,16 +3,14 @@
 import io.lettuce.core.RedisClient;
 import io.lettuce.core.api.StatefulRedisConnection;
 import io.lettuce.core.api.sync.RedisStreamCommands;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.util.Objects;
 
 /**
- * Adapter for RedisClient.
+ * Adapter for talking to a single Redis instance.
+ * If you need to talk to a RedisCluster {@link LettuceClusterClient}.
  */
 public class LettuceRedisClient implements LettuceAdapter {
- private static final Logger logger = LoggerFactory.getLogger(LettuceRedisClient.class);
 
  /**
  * The underlying Redis Client.

src/test/java/org/sourcelab/storm/spout/redis/util/test/RedisTestContainer.java

@@ -1,11 +1,7 @@
 package org.sourcelab.storm.spout.redis.util.test;
 
-import org.jetbrains.annotations.NotNull;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.sourcelab.storm.spout.redis.RedisStreamSpoutConfig;
 import org.testcontainers.containers.FixedHostPortGenericContainer;
-import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.startupcheck.MinimumDurationRunningStartupCheckStrategy;
 
 import java.time.Duration;
@@ -60,7 +56,7 @@ public String getConnectStr() {
 
  public RedisStreamSpoutConfig.Builder addConnectionDetailsToConfig(final RedisStreamSpoutConfig.Builder builder) {
  if (isCluster) {
- builder.withCluster(getHost(), getPort());
+ builder.withClusterNode(getHost(), getPort());
  } else {
  builder.withServer(getHost(), getPort());
  }