Cleanup

Author: Crim

src/main/java/org/sourcelab/storm/spout/redis/client/jedis/JedisAdapter.java

@@ -9,27 +9,36 @@
  * Adapter to allow usage of both Jedis and JedisCluster.
  */
 public interface JedisAdapter {
- /**
- * Is the underlying client connected?
- * @return true if connected, false if not.
- */
- boolean isConnected();
-
  /**
  * Call connect.
  */
  void connect();
 
+ /**
+ * Consume next batch of messages.
+ * @return List of messages consumed.
+ */
  List<Map.Entry<String, List<StreamEntry>>> consume();
 
+ /**
+ * Mark the provided messageId as acknowledged/completed.
+ * @param msgId Id of the message.
+ */
  void commit(final String msgId);
 
  /**
- * Call shutdown.
+ * Disconnect client.
  */
  void close();
 
+ /**
+ * Advance the last offset consumed from PPL.
+ * @param lastMsgId Id of the last msg consumed.
+ */
  void advancePplOffset(final String lastMsgId);
 
+ /**
+ * Switch to consuming from latest messages.
+ */
  void switchToConsumerGroupMessages();
 }

src/main/java/org/sourcelab/storm/spout/redis/client/jedis/JedisClusterAdapter.java

@@ -15,7 +15,8 @@
 import java.util.Objects;
 
 /**
- *
+ * Adapter for talking to a RedisCluster.
+ * If you need to talk to a single Redis instance {@link JedisRedisAdapter}.
  */
 public class JedisClusterAdapter implements JedisAdapter {
  private static final Logger logger = LoggerFactory.getLogger(JedisClusterAdapter.class);
@@ -38,17 +39,18 @@ public class JedisClusterAdapter implements JedisAdapter {
  */
  private Map.Entry<String, StreamEntryID> streamPositionKey;
 
+ /**
+ * Constructor.
+ * @param jedisCluster Underlying Jedis Cluster client instance.
+ * @param config Spout configuration.
+ * @param instanceId Spout instance Id.
+ */
  public JedisClusterAdapter(final JedisCluster jedisCluster, final RedisStreamSpoutConfig config, final int instanceId) {
  this.jedisCluster = Objects.requireNonNull(jedisCluster);
  this.config = Objects.requireNonNull(config);
  this.consumerId = config.getConsumerIdPrefix() + instanceId;
  }
 
- @Override
- public boolean isConnected() {
- return true;
- }
-
  @Override
  public void connect() {
  // Attempt to create consumer group

src/main/java/org/sourcelab/storm/spout/redis/client/jedis/JedisRedisAdapter.java

@@ -15,7 +15,8 @@
 import java.util.Objects;
 
 /**
- *
+ * Adapter for talking to a single Redis instance.
+ * If you need to talk to a RedisCluster {@link JedisClusterAdapter}.
  */
 public class JedisRedisAdapter implements JedisAdapter {
  private static final Logger logger = LoggerFactory.getLogger(JedisRedisAdapter.class);
@@ -38,17 +39,18 @@ public class JedisRedisAdapter implements JedisAdapter {
  */
  private Map.Entry<String, StreamEntryID> streamPositionKey;
 
+ /**
+ * Constructor.
+ * @param jedis Underlying Jedis client instance.
+ * @param config Spout configuration.
+ * @param instanceId Spout instance Id.
+ */
  public JedisRedisAdapter(final Jedis jedis, final RedisStreamSpoutConfig config, final int instanceId) {
  this.jedis = Objects.requireNonNull(jedis);
  this.config = Objects.requireNonNull(config);
  this.consumerId = config.getConsumerIdPrefix() + instanceId;
  }
 
- @Override
- public boolean isConnected() {
- return jedis.isConnected();
- }
-
  @Override
  public void connect() {
  jedis.connect();