Repository: storm Updated Branches: refs/heads/0.10.x-branch df8ad6109 -> d02f94268
fix javadoc errors Project: http://git-wip-us.apache.org/repos/asf/storm/repo Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/e1829807 Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/e1829807 Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/e1829807 Branch: refs/heads/0.10.x-branch Commit: e182980704ff1159b619e48970fb0d50a303b546 Parents: df8ad61 Author: P. Taylor Goetz <ptgo...@gmail.com> Authored: Fri Oct 23 14:39:11 2015 -0400 Committer: P. Taylor Goetz <ptgo...@gmail.com> Committed: Fri Oct 23 14:39:11 2015 -0400 ---------------------------------------------------------------------- .../src/jvm/storm/starter/BasicDRPCTopology.java | 2 +- .../src/jvm/storm/starter/ReachTopology.java | 8 ++++---- .../src/jvm/storm/starter/TransactionalWords.java | 4 ++-- .../storm/starter/bolt/AbstractRankerBolt.java | 2 +- .../starter/bolt/IntermediateRankingsBolt.java | 2 +- .../jvm/storm/starter/bolt/RollingCountBolt.java | 6 +++--- .../jvm/storm/starter/bolt/TotalRankingsBolt.java | 2 +- .../starter/tools/NthLastModifiedTimeTracker.java | 4 ++-- .../starter/tools/RankableObjectWithFields.java | 4 ++-- .../storm/starter/tools/SlidingWindowCounter.java | 16 ++++++++-------- .../jvm/storm/starter/tools/SlotBasedCounter.java | 2 +- .../apache/storm/hive/bolt/mapper/HiveMapper.java | 12 ++++++------ .../org/apache/storm/hive/common/HiveWriter.java | 6 +++--- .../apache/storm/jdbc/bolt/JdbcInsertBolt.java | 2 +- .../java/org/apache/storm/jdbc/common/Column.java | 6 +++--- .../src/jvm/storm/kafka/bolt/KafkaBolt.java | 14 +++++++------- .../storm/redis/bolt/AbstractRedisBolt.java | 8 ++++---- .../apache/storm/redis/bolt/RedisLookupBolt.java | 2 +- .../apache/storm/redis/bolt/RedisStoreBolt.java | 2 +- .../redis/common/config/JedisClusterConfig.java | 4 ++-- .../redis/common/config/JedisPoolConfig.java | 2 +- .../common/container/JedisClusterContainer.java | 2 +- .../trident/state/AbstractRedisMapState.java | 16 +++++++++------- .../trident/state/AbstractRedisStateQuerier.java | 2 +- .../trident/state/AbstractRedisStateUpdater.java | 2 +- .../storm/redis/trident/state/KeyFactory.java | 4 ++-- .../apache/storm/redis/trident/state/Options.java | 2 +- .../redis/trident/state/RedisClusterState.java | 2 +- .../storm/redis/trident/state/RedisState.java | 2 +- storm-core/src/jvm/backtype/storm/Config.java | 18 +++++++++--------- .../src/jvm/backtype/storm/ConfigValidation.java | 2 +- .../storm/metric/api/rpc/CountShellMetric.java | 2 +- .../storm/metric/api/rpc/IShellMetric.java | 5 ++--- .../src/jvm/backtype/storm/scheduler/Cluster.java | 10 +++++----- .../storm/scheduler/SchedulerAssignment.java | 2 +- .../storm/security/INimbusCredentialPlugin.java | 1 - .../backtype/storm/security/auth/AuthUtils.java | 8 ++++---- .../security/auth/DefaultPrincipalToLocal.java | 2 +- .../backtype/storm/security/auth/IAuthorizer.java | 4 ++-- .../storm/security/auth/IPrincipalToLocal.java | 2 +- .../security/auth/KerberosPrincipalToLocal.java | 2 +- .../security/auth/authorizer/DenyAuthorizer.java | 4 ++-- .../security/auth/authorizer/NoopAuthorizer.java | 2 +- .../authorizer/SimpleWhitelistAuthorizer.java | 2 +- .../src/jvm/backtype/storm/spout/ISpout.java | 4 ++++ .../jvm/backtype/storm/task/OutputCollector.java | 2 +- .../jvm/backtype/storm/testing/MockedSources.java | 2 +- .../src/jvm/backtype/storm/testing/TestJob.java | 1 + .../backtype/storm/topology/InputDeclarer.java | 4 ++-- .../src/jvm/backtype/storm/tuple/Tuple.java | 3 ++- .../src/jvm/backtype/storm/utils/ShellUtils.java | 2 +- .../StormBoundedExponentialBackoffRetry.java | 4 ++-- .../jvm/backtype/storm/utils/WritableUtils.java | 4 ++-- 53 files changed, 120 insertions(+), 114 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/BasicDRPCTopology.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/BasicDRPCTopology.java b/examples/storm-starter/src/jvm/storm/starter/BasicDRPCTopology.java index a12b017..3085b6c 100644 --- a/examples/storm-starter/src/jvm/storm/starter/BasicDRPCTopology.java +++ b/examples/storm-starter/src/jvm/storm/starter/BasicDRPCTopology.java @@ -32,7 +32,7 @@ import backtype.storm.tuple.Values; /** * This topology is a basic example of doing distributed RPC on top of Storm. It implements a function that appends a * "!" to any string you send the DRPC function. - * <p/> + * <p></p> * See https://github.com/nathanmarz/storm/wiki/Distributed-RPC for more information on doing distributed RPC on top of * Storm. */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/ReachTopology.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/ReachTopology.java b/examples/storm-starter/src/jvm/storm/starter/ReachTopology.java index 2c5c8ba..8e9daf8 100644 --- a/examples/storm-starter/src/jvm/storm/starter/ReachTopology.java +++ b/examples/storm-starter/src/jvm/storm/starter/ReachTopology.java @@ -37,17 +37,17 @@ import java.util.*; /** * This is a good example of doing complex Distributed RPC on top of Storm. This program creates a topology that can * compute the reach for any URL on Twitter in realtime by parallelizing the whole computation. - * <p/> + * <p></p> * Reach is the number of unique people exposed to a URL on Twitter. To compute reach, you have to get all the people * who tweeted the URL, get all the followers of all those people, unique that set of followers, and then count the * unique set. It's an intense computation that can involve thousands of database calls and tens of millions of follower * records. - * <p/> + * <p></p> * This Storm topology does every piece of that computation in parallel, turning what would be a computation that takes * minutes on a single machine into one that takes just a couple seconds. - * <p/> + * <p></p> * For the purposes of demonstration, this topology replaces the use of actual DBs with in-memory hashmaps. - * <p/> + * <p></p> * See https://github.com/nathanmarz/storm/wiki/Distributed-RPC for more information on Distributed RPC. */ public class ReachTopology { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/TransactionalWords.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/TransactionalWords.java b/examples/storm-starter/src/jvm/storm/starter/TransactionalWords.java index 4d5ba1b..6ed2c2a 100644 --- a/examples/storm-starter/src/jvm/storm/starter/TransactionalWords.java +++ b/examples/storm-starter/src/jvm/storm/starter/TransactionalWords.java @@ -42,10 +42,10 @@ import java.util.Map; /** * This class defines a more involved transactional topology then TransactionalGlobalCount. This topology processes a * stream of words and produces two outputs: - * <p/> + * <p></p> * 1. A count for each word (stored in a database) 2. The number of words for every bucket of 10 counts. So it stores in * the database how many words have appeared 0-9 times, how many have appeared 10-19 times, and so on. - * <p/> + * <p></p> * A batch of words can cause the bucket counts to decrement for some buckets and increment for others as words move * between buckets as their counts accumulate. */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/bolt/AbstractRankerBolt.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/bolt/AbstractRankerBolt.java b/examples/storm-starter/src/jvm/storm/starter/bolt/AbstractRankerBolt.java index 64ceb29..4842894 100644 --- a/examples/storm-starter/src/jvm/storm/starter/bolt/AbstractRankerBolt.java +++ b/examples/storm-starter/src/jvm/storm/starter/bolt/AbstractRankerBolt.java @@ -33,7 +33,7 @@ import java.util.Map; /** * This abstract bolt provides the basic behavior of bolts that rank objects according to their count. - * <p/> + * <p></p> * It uses a template method design pattern for {@link AbstractRankerBolt#execute(Tuple, BasicOutputCollector)} to allow * actual bolt implementations to specify how incoming tuples are processed, i.e. how the objects embedded within those * tuples are retrieved and counted. http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/bolt/IntermediateRankingsBolt.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/bolt/IntermediateRankingsBolt.java b/examples/storm-starter/src/jvm/storm/starter/bolt/IntermediateRankingsBolt.java index d1805ff..4e38cf9 100644 --- a/examples/storm-starter/src/jvm/storm/starter/bolt/IntermediateRankingsBolt.java +++ b/examples/storm-starter/src/jvm/storm/starter/bolt/IntermediateRankingsBolt.java @@ -24,7 +24,7 @@ import storm.starter.tools.RankableObjectWithFields; /** * This bolt ranks incoming objects by their count. - * <p/> + * <p></p> * It assumes the input tuples to adhere to the following format: (object, object_count, additionalField1, * additionalField2, ..., additionalFieldN). */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/bolt/RollingCountBolt.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/bolt/RollingCountBolt.java b/examples/storm-starter/src/jvm/storm/starter/bolt/RollingCountBolt.java index 31f7ee2..91b643d 100644 --- a/examples/storm-starter/src/jvm/storm/starter/bolt/RollingCountBolt.java +++ b/examples/storm-starter/src/jvm/storm/starter/bolt/RollingCountBolt.java @@ -36,18 +36,18 @@ import java.util.Map.Entry; /** * This bolt performs rolling counts of incoming objects, i.e. sliding window based counting. - * <p/> + * <p></p> * The bolt is configured by two parameters, the length of the sliding window in seconds (which influences the output * data of the bolt, i.e. how it will count objects) and the emit frequency in seconds (which influences how often the * bolt will output the latest window counts). For instance, if the window length is set to an equivalent of five * minutes and the emit frequency to one minute, then the bolt will output the latest five-minute sliding window every * minute. - * <p/> + * <p></p> * The bolt emits a rolling count tuple per object, consisting of the object itself, its latest rolling count, and the * actual duration of the sliding window. The latter is included in case the expected sliding window length (as * configured by the user) is different from the actual length, e.g. due to high system load. Note that the actual * window length is tracked and calculated for the window, and not individually for each object within a window. - * <p/> + * <p></p> * Note: During the startup phase you will usually observe that the bolt warns you about the actual sliding window * length being smaller than the expected length. This behavior is expected and is caused by the way the sliding window * counts are initially "loaded up". You can safely ignore this warning during startup (e.g. you will see this warning http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/bolt/TotalRankingsBolt.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/bolt/TotalRankingsBolt.java b/examples/storm-starter/src/jvm/storm/starter/bolt/TotalRankingsBolt.java index 0e1bb05..47a69fa 100644 --- a/examples/storm-starter/src/jvm/storm/starter/bolt/TotalRankingsBolt.java +++ b/examples/storm-starter/src/jvm/storm/starter/bolt/TotalRankingsBolt.java @@ -23,7 +23,7 @@ import storm.starter.tools.Rankings; /** * This bolt merges incoming {@link Rankings}. - * <p/> + * <p></p> * It can be used to merge intermediate rankings generated by {@link IntermediateRankingsBolt} into a final, * consolidated ranking. To do so, configure this bolt with a globalGrouping on {@link IntermediateRankingsBolt}. */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/tools/NthLastModifiedTimeTracker.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/tools/NthLastModifiedTimeTracker.java b/examples/storm-starter/src/jvm/storm/starter/tools/NthLastModifiedTimeTracker.java index 08df8cf..40eb713 100644 --- a/examples/storm-starter/src/jvm/storm/starter/tools/NthLastModifiedTimeTracker.java +++ b/examples/storm-starter/src/jvm/storm/starter/tools/NthLastModifiedTimeTracker.java @@ -22,9 +22,9 @@ import org.apache.commons.collections.buffer.CircularFifoBuffer; /** * This class tracks the time-since-last-modify of a "thing" in a rolling fashion. - * <p/> + * <p></p> * For example, create a 5-slot tracker to track the five most recent time-since-last-modify. - * <p/> + * <p></p> * You must manually "mark" that the "something" that you want to track -- in terms of modification times -- has just * been modified. */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/tools/RankableObjectWithFields.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/tools/RankableObjectWithFields.java b/examples/storm-starter/src/jvm/storm/starter/tools/RankableObjectWithFields.java index 9a0ecae..c5c23b77 100644 --- a/examples/storm-starter/src/jvm/storm/starter/tools/RankableObjectWithFields.java +++ b/examples/storm-starter/src/jvm/storm/starter/tools/RankableObjectWithFields.java @@ -26,7 +26,7 @@ import java.util.List; /** * This class wraps an objects and its associated count, including any additional data fields. - * <p/> + * <p></p> * This class can be used, for instance, to track the number of occurrences of an object in a Storm topology. */ public class RankableObjectWithFields implements Rankable, Serializable { @@ -53,7 +53,7 @@ public class RankableObjectWithFields implements Rankable, Serializable { /** * Construct a new instance based on the provided {@link Tuple}. - * <p/> + * <p></p> * This method expects the object to be ranked in the first field (index 0) of the provided tuple, and the number of * occurrences of the object (its count) in the second field (index 1). Any further fields in the tuple will be * extracted and tracked, too. These fields can be accessed via {@link RankableObjectWithFields#getFields()}. http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/tools/SlidingWindowCounter.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/tools/SlidingWindowCounter.java b/examples/storm-starter/src/jvm/storm/starter/tools/SlidingWindowCounter.java index 1199c40..80c209c 100644 --- a/examples/storm-starter/src/jvm/storm/starter/tools/SlidingWindowCounter.java +++ b/examples/storm-starter/src/jvm/storm/starter/tools/SlidingWindowCounter.java @@ -22,20 +22,20 @@ import java.util.Map; /** * This class counts objects in a sliding window fashion. - * <p/> + * <p></p> * It is designed 1) to give multiple "producer" threads write access to the counter, i.e. being able to increment - * counts of objects, and 2) to give a single "consumer" thread (e.g. {@link PeriodicSlidingWindowCounter}) read access + * counts of objects, and 2) to give a single "consumer" thread read access * to the counter. Whenever the consumer thread performs a read operation, this class will advance the head slot of the * sliding window counter. This means that the consumer thread indirectly controls where writes of the producer threads * will go to. Also, by itself this class will not advance the head slot. - * <p/> + * <p></p> * A note for analyzing data based on a sliding window count: During the initial <code>windowLengthInSlots</code> * iterations, this sliding window counter will always return object counts that are equal or greater than in the * previous iteration. This is the effect of the counter "loading up" at the very start of its existence. Conceptually, * this is the desired behavior. - * <p/> + * <p></p> * To give an example, using a counter with 5 slots which for the sake of this example represent 1 minute of time each: - * <p/> + * <p></p> * <pre> * {@code * Sliding window counts of an object X over time @@ -50,14 +50,14 @@ import java.util.Map; * 1 2 3 4 4 3 2 1 * } * </pre> - * <p/> + * <p></p> * As you can see in this example, for the first <code>windowLengthInSlots</code> (here: the first five minutes) the * counter will always return counts equal or greater than in the previous iteration (1, 2, 3, 4, 4). This initial load * effect needs to be accounted for whenever you want to perform analyses such as trending topics; otherwise your * analysis algorithm might falsely identify the object to be trending as the counter seems to observe continuously * increasing counts. Also, note that during the initial load phase <em>every object</em> will exhibit increasing * counts. - * <p/> + * <p></p> * On a high-level, the counter exhibits the following behavior: If you asked the example counter after two minutes, * "how often did you count the object during the past five minutes?", then it should reply "I have counted it 2 times * in the past five minutes", implying that it can only account for the last two of those five minutes because the @@ -92,7 +92,7 @@ public final class SlidingWindowCounter<T> implements Serializable { /** * Return the current (total) counts of all tracked objects, then advance the window. - * <p/> + * <p></p> * Whenever this method is called, we consider the counts of the current sliding window to be available to and * successfully processed "upstream" (i.e. by the caller). Knowing this we will start counting any subsequent * objects within the next "chunk" of the sliding window. http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/examples/storm-starter/src/jvm/storm/starter/tools/SlotBasedCounter.java ---------------------------------------------------------------------- diff --git a/examples/storm-starter/src/jvm/storm/starter/tools/SlotBasedCounter.java b/examples/storm-starter/src/jvm/storm/starter/tools/SlotBasedCounter.java index 4b2d472..ad1e551 100644 --- a/examples/storm-starter/src/jvm/storm/starter/tools/SlotBasedCounter.java +++ b/examples/storm-starter/src/jvm/storm/starter/tools/SlotBasedCounter.java @@ -25,7 +25,7 @@ import java.util.Set; /** * This class provides per-slot counts of the occurrences of objects. - * <p/> + * <p></p> * It can be used, for instance, as a building block for implementing sliding window counting of objects. * * @param <T> The type of those objects we want to count. http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-hive/src/main/java/org/apache/storm/hive/bolt/mapper/HiveMapper.java ---------------------------------------------------------------------- diff --git a/external/storm-hive/src/main/java/org/apache/storm/hive/bolt/mapper/HiveMapper.java b/external/storm-hive/src/main/java/org/apache/storm/hive/bolt/mapper/HiveMapper.java index a3b5531..cc4c1bb 100644 --- a/external/storm-hive/src/main/java/org/apache/storm/hive/bolt/mapper/HiveMapper.java +++ b/external/storm-hive/src/main/java/org/apache/storm/hive/bolt/mapper/HiveMapper.java @@ -38,7 +38,7 @@ public interface HiveMapper extends Serializable { /** * Given a endPoint, returns a RecordWriter with columnNames. * - * @param tuple + * @param endPoint * @return */ @@ -52,13 +52,13 @@ public interface HiveMapper extends Serializable { * Given a tuple, return a hive partition values list. * * @param tuple - * @return List<String> + * @return */ List<String> mapPartitions(Tuple tuple); /** * Given a tuple, maps to a HiveRecord based on columnFields - * @Param Tuple + * @param tuple * @return byte[] */ byte[] mapRecord(Tuple tuple); @@ -66,14 +66,14 @@ public interface HiveMapper extends Serializable { /** * Given a TridetnTuple, return a hive partition values list. * - * @param TridentTuple - * @return List<String> + * @param tuple + * @return */ List<String> mapPartitions(TridentTuple tuple); /** * Given a TridentTuple, maps to a HiveRecord based on columnFields - * @Param TridentTuple + * @param tuple * @return byte[] */ byte[] mapRecord(TridentTuple tuple); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-hive/src/main/java/org/apache/storm/hive/common/HiveWriter.java ---------------------------------------------------------------------- diff --git a/external/storm-hive/src/main/java/org/apache/storm/hive/common/HiveWriter.java b/external/storm-hive/src/main/java/org/apache/storm/hive/common/HiveWriter.java index 726b8e8..d046192 100644 --- a/external/storm-hive/src/main/java/org/apache/storm/hive/common/HiveWriter.java +++ b/external/storm-hive/src/main/java/org/apache/storm/hive/common/HiveWriter.java @@ -91,9 +91,9 @@ public class HiveWriter { } /** - * Write data <br /> + * Write data * - * @throws IOException + * @throws org.apache.storm.hive.common.HiveWriter.WriteFailure * @throws InterruptedException */ public synchronized void write(final byte[] record) @@ -278,7 +278,7 @@ public class HiveWriter { /** * Aborts the current Txn and switches to next Txn. - * @throws StreamingException if could not get new Transaction Batch, or switch to next Txn + * @throws InterruptedException if could not get new Transaction Batch, or switch to next Txn */ public void abort() throws InterruptedException { abortTxn(); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/bolt/JdbcInsertBolt.java ---------------------------------------------------------------------- diff --git a/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/bolt/JdbcInsertBolt.java b/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/bolt/JdbcInsertBolt.java index 2f29000..cd24800 100644 --- a/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/bolt/JdbcInsertBolt.java +++ b/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/bolt/JdbcInsertBolt.java @@ -33,7 +33,7 @@ import java.util.Map; /** * Basic bolt for writing to any Database table. - * <p/> + * <p></p> * Note: Each JdbcInsertBolt defined in a topology is tied to a specific table. */ public class JdbcInsertBolt extends AbstractJdbcBolt { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java ---------------------------------------------------------------------- diff --git a/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java b/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java index 73bc0fd..262e99e 100644 --- a/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java +++ b/external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java @@ -34,9 +34,9 @@ import java.io.Serializable; * * The following class can be used to represent the data in the table as * <pre> - * List<List<Column>> rows = new ArrayList<List<Column>>(); - * List<Column> row1 = Lists.newArrayList(new Column("UserId", 1, Types.INTEGER), new Column("UserName", "Foo", Types.VARCHAR)) - * List<Column> row1 = Lists.newArrayList(new Column("UserId", 2, Types.INTEGER), new Column("UserName", "Bar", Types.VARCHAR)) + * List<List<Column>> rows = new ArrayList<List<Column>>(); + * List<Column> row1 = Lists.newArrayList(new Column("UserId", 1, Types.INTEGER), new Column("UserName", "Foo", Types.VARCHAR)) + * List<Column> row1 = Lists.newArrayList(new Column("UserId", 2, Types.INTEGER), new Column("UserName", "Bar", Types.VARCHAR)) * * rows.add(row1) * rows.add(row2) http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-kafka/src/jvm/storm/kafka/bolt/KafkaBolt.java ---------------------------------------------------------------------- diff --git a/external/storm-kafka/src/jvm/storm/kafka/bolt/KafkaBolt.java b/external/storm-kafka/src/jvm/storm/kafka/bolt/KafkaBolt.java index 714ecd3..f74eaca 100644 --- a/external/storm-kafka/src/jvm/storm/kafka/bolt/KafkaBolt.java +++ b/external/storm-kafka/src/jvm/storm/kafka/bolt/KafkaBolt.java @@ -38,13 +38,13 @@ import java.util.Properties; /** - * Bolt implementation that can send Tuple data to Kafka - * <p/> - * It expects the producer configuration and topic in storm config under - * <p/> - * 'kafka.broker.properties' and 'topic' - * <p/> - * respectively. + * <p>Bolt implementation that can send Tuple data to Kafka</p> + * + * <p>It expects the producer configuration and topic in storm config under</p> + * + * <p>'kafka.broker.properties' and 'topic'</p> + * + * <p>respectively.</p> */ public class KafkaBolt<K, V> extends BaseRichBolt { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/AbstractRedisBolt.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/AbstractRedisBolt.java b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/AbstractRedisBolt.java index dc2a2d3..aa70961 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/AbstractRedisBolt.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/AbstractRedisBolt.java @@ -30,11 +30,11 @@ import java.util.Map; /** * AbstractRedisBolt class is for users to implement custom bolts which makes interaction with Redis. - * <p/> + * <p></p> * Due to environment abstraction, AbstractRedisBolt provides JedisCommands which contains only single key operations. - * <p/> + * <p></p> * Custom Bolts may want to follow this pattern: - * <p><blockquote><pre> + * <blockquote><pre> * JedisCommands jedisCommands = null; * try { * jedisCommand = getInstance(); @@ -90,7 +90,7 @@ public abstract class AbstractRedisBolt extends BaseRichBolt { } /** - * Borrow JedisCommands instance from container.<p/> + * Borrow JedisCommands instance from container.<p></p> * JedisCommands is an interface which contains single key operations. * @return implementation of JedisCommands * @see JedisCommandsInstanceContainer#getInstance() http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisLookupBolt.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisLookupBolt.java b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisLookupBolt.java index 47c98cb..bb4c64c 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisLookupBolt.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisLookupBolt.java @@ -30,7 +30,7 @@ import java.util.List; /** * Basic bolt for querying from Redis and emits response as tuple. - * <p/> + * <p></p> * Various data types are supported: STRING, LIST, HASH, SET, SORTED_SET, HYPER_LOG_LOG */ public class RedisLookupBolt extends AbstractRedisBolt { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisStoreBolt.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisStoreBolt.java b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisStoreBolt.java index be9a328..f2c0cc2 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisStoreBolt.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/bolt/RedisStoreBolt.java @@ -27,7 +27,7 @@ import redis.clients.jedis.JedisCommands; /** * Basic bolt for writing to Redis - * <p/> + * <p></p> * Various data types are supported: STRING, LIST, HASH, SET, SORTED_SET, HYPER_LOG_LOG */ public class RedisStoreBolt extends AbstractRedisBolt { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisClusterConfig.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisClusterConfig.java b/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisClusterConfig.java index d8696aa..d875d32 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisClusterConfig.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisClusterConfig.java @@ -36,9 +36,9 @@ public class JedisClusterConfig implements Serializable { /** * Constructor - * <p/> + * <p></p> * You can use JedisClusterConfig.Builder() for leaving some fields to apply default value. - * <p/> + * <p></p> * Note that list of node is mandatory, and when you didn't set nodes, it throws NullPointerException. * * @param nodes list of node information for JedisCluster http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisPoolConfig.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisPoolConfig.java b/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisPoolConfig.java index 8b3a2e5..99cffd2 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisPoolConfig.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/common/config/JedisPoolConfig.java @@ -35,7 +35,7 @@ public class JedisPoolConfig implements Serializable { /** * Constructor - * <p/> + * <p></p> * You can use JedisPoolConfig.Builder() for leaving some fields to apply default value. * * @param host hostname or IP http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/common/container/JedisClusterContainer.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/common/container/JedisClusterContainer.java b/external/storm-redis/src/main/java/org/apache/storm/redis/common/container/JedisClusterContainer.java index ea294a6..b2dd491 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/common/container/JedisClusterContainer.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/common/container/JedisClusterContainer.java @@ -24,7 +24,7 @@ import java.io.Closeable; /** * Container for managing JedisCluster. - * <p/> + * <p></p> * Note that JedisCluster doesn't need to be pooled since it's thread-safe and it stores pools internally. */ public class JedisClusterContainer implements JedisCommandsInstanceContainer, Closeable { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisMapState.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisMapState.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisMapState.java index 26056d2..b04ea43 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisMapState.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisMapState.java @@ -35,12 +35,14 @@ import java.util.Map; /** * AbstractRedisMapState is base class of any RedisMapState, which implements IBackingMap. - * <p/> - * Derived classes should provide<br/> - * - which Serializer it uses<br/> - * - which KeyFactory it uses<br/> - * - how to retrieve values from Redis<br/> - * - how to store values to Redis<br/> + * <p></p> + * Derived classes should provide + * <ul> + * <li>which Serializer it uses</li> + * <li>which KeyFactory it uses</li> + * <li>how to retrieve values from Redis</li> + * <li>how to store values to Redis</li> + * </ul> * and AbstractRedisMapState takes care of rest things. * * @param <T> value's type class @@ -115,7 +117,7 @@ public abstract class AbstractRedisMapState<T> implements IBackingMap<T> { protected abstract Serializer getSerializer(); /** - * Returns KeyFactory which is used for converting state key -> Redis key. + * Returns KeyFactory which is used for converting state key -> Redis key. * @return key factory */ protected abstract KeyFactory getKeyFactory(); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.java index 5c7335d..e288a3c 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateQuerier.java @@ -30,7 +30,7 @@ import java.util.List; /** * AbstractRedisStateQuerier is base class of any RedisStateQuerier, which implements BaseQueryFunction. - * <p/> + * <p></p> * Derived classes should provide how to retrieve values from Redis, * and AbstractRedisStateQuerier takes care of rest things. * http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateUpdater.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateUpdater.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateUpdater.java index e9654c7..f928c5b 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateUpdater.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/AbstractRedisStateUpdater.java @@ -30,7 +30,7 @@ import java.util.Map; /** * AbstractRedisStateUpdater is base class of any RedisStateUpdater, which implements BaseStateUpdater. - * <p/> + * <p></p> * Derived classes should provide how to update (key, value) pairs to Redis, * and AbstractRedisStateUpdater takes care of rest things. * http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/KeyFactory.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/KeyFactory.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/KeyFactory.java index 4898dcc..bed6b90 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/KeyFactory.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/KeyFactory.java @@ -21,7 +21,7 @@ import java.io.Serializable; import java.util.List; /** - * KeyFactory defines conversion of state key (which could be compounded) -> Redis key. + * KeyFactory defines conversion of state key (which could be compounded) -> Redis key. */ public interface KeyFactory extends Serializable { /** @@ -37,7 +37,7 @@ public interface KeyFactory extends Serializable { class DefaultKeyFactory implements KeyFactory { /** * {@inheritDoc} - * <p/> + * <p></p> * Currently DefaultKeyFactory returns just first element of list. * * @param key state key http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/Options.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/Options.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/Options.java index f4dbfaa..558b4f5 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/Options.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/Options.java @@ -23,7 +23,7 @@ import storm.trident.state.Serializer; import java.io.Serializable; /** - * Options of State.<br/> + * Options of State.<p></p> * It's a data structure (whole things are public) and you can access and modify all fields. * * @param <T> value's type class http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisClusterState.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisClusterState.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisClusterState.java index 764436d..569dc15 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisClusterState.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisClusterState.java @@ -91,7 +91,7 @@ public class RedisClusterState implements State { /** * Borrows JedisCluster instance. - * <p/> + * <p></p> * Note that you should return borrowed instance when you finish using instance. * * @return JedisCluster instance http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisState.java ---------------------------------------------------------------------- diff --git a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisState.java b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisState.java index 85d0e1b..dde2de6 100644 --- a/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisState.java +++ b/external/storm-redis/src/main/java/org/apache/storm/redis/trident/state/RedisState.java @@ -94,7 +94,7 @@ public class RedisState implements State { /** * Borrows Jedis instance from pool. - * <p/> + * <p></p> * Note that you should return borrowed instance to pool when you finish using instance. * * @return Jedis instance http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/Config.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/Config.java b/storm-core/src/jvm/backtype/storm/Config.java index ebfec82..3026d37 100644 --- a/storm-core/src/jvm/backtype/storm/Config.java +++ b/storm-core/src/jvm/backtype/storm/Config.java @@ -398,7 +398,7 @@ public class Config extends HashMap<String, Object> { /** * How often nimbus should wake the cleanup thread to clean the inbox. - * @see NIMBUS_INBOX_JAR_EXPIRATION_SECS + * @see backtype.storm.Config#NIMBUS_INBOX_JAR_EXPIRATION_SECS */ public static final String NIMBUS_CLEANUP_INBOX_FREQ_SECS = "nimbus.cleanup.inbox.freq.secs"; public static final Object NIMBUS_CLEANUP_INBOX_FREQ_SECS_SCHEMA = ConfigValidation.IntegerValidator; @@ -410,7 +410,7 @@ public class Config extends HashMap<String, Object> { * Note that the time it takes to delete an inbox jar file is going to be somewhat more than * NIMBUS_CLEANUP_INBOX_JAR_EXPIRATION_SECS (depending on how often NIMBUS_CLEANUP_FREQ_SECS * is set to). - * @see NIMBUS_CLEANUP_FREQ_SECS + * @see backtype.storm.Config#NIMBUS_CLEANUP_INBOX_FREQ_SECS */ public static final String NIMBUS_INBOX_JAR_EXPIRATION_SECS = "nimbus.inbox.jar.expiration.secs"; public static final Object NIMBUS_INBOX_JAR_EXPIRATION_SECS_SCHEMA = ConfigValidation.IntegerValidator; @@ -781,14 +781,14 @@ public class Config extends HashMap<String, Object> { /** * The Access Control List for the DRPC Authorizer. - * @see DRPCSimpleAclAuthorizer + * @see backtype.storm.security.auth.authorizer.DRPCSimpleACLAuthorizer */ public static final String DRPC_AUTHORIZER_ACL = "drpc.authorizer.acl"; public static final Object DRPC_AUTHORIZER_ACL_SCHEMA = Map.class; /** * File name of the DRPC Authorizer ACL. - * @see DRPCSimpleAclAuthorizer + * @see backtype.storm.security.auth.authorizer.DRPCSimpleACLAuthorizer */ public static final String DRPC_AUTHORIZER_ACL_FILENAME = "drpc.authorizer.acl.filename"; public static final Object DRPC_AUTHORIZER_ACL_FILENAME_SCHEMA = String.class; @@ -800,7 +800,7 @@ public class Config extends HashMap<String, Object> { * permitted, which is appropriate for a development environment. When set * to true, explicit ACL entries are required for every DRPC function, and * any request for functions will be denied. - * @see DRPCSimpleAclAuthorizer + * @see backtype.storm.security.auth.authorizer.DRPCSimpleACLAuthorizer */ public static final String DRPC_AUTHORIZER_ACL_STRICT = "drpc.authorizer.acl.strict"; public static final Object DRPC_AUTHORIZER_ACL_STRICT_SCHEMA = Boolean.class; @@ -972,10 +972,10 @@ public class Config extends HashMap<String, Object> { /** * The jvm opts provided to workers launched by this supervisor. All "%ID%", "%WORKER-ID%", "%TOPOLOGY-ID%" * and "%WORKER-PORT%" substrings are replaced with: - * %ID% -> port (for backward compatibility), - * %WORKER-ID% -> worker-id, - * %TOPOLOGY-ID% -> topology-id, - * %WORKER-PORT% -> port. + * %ID% -> port (for backward compatibility), + * %WORKER-ID% -> worker-id, + * %TOPOLOGY-ID% -> topology-id, + * %WORKER-PORT% -> port. */ public static final String WORKER_CHILDOPTS = "worker.childopts"; public static final Object WORKER_CHILDOPTS_SCHEMA = ConfigValidation.StringOrStringListValidator; http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/ConfigValidation.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/ConfigValidation.java b/storm-core/src/jvm/backtype/storm/ConfigValidation.java index c8d0143..69c1694 100644 --- a/storm-core/src/jvm/backtype/storm/ConfigValidation.java +++ b/storm-core/src/jvm/backtype/storm/ConfigValidation.java @@ -176,7 +176,7 @@ public class ConfigValidation { /** * Validates a map of Strings to a map of Strings to a list. - * {str -> {str -> [str,str]} + * {str -> {str -> [str,str]} */ public static Object MapOfStringToMapValidator = mapFv(fv(String.class, false), mapFv(fv(String.class, false), listFv(String.class, false), false), true); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/metric/api/rpc/CountShellMetric.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/metric/api/rpc/CountShellMetric.java b/storm-core/src/jvm/backtype/storm/metric/api/rpc/CountShellMetric.java index def74c2..769a4f6 100644 --- a/storm-core/src/jvm/backtype/storm/metric/api/rpc/CountShellMetric.java +++ b/storm-core/src/jvm/backtype/storm/metric/api/rpc/CountShellMetric.java @@ -22,7 +22,7 @@ import backtype.storm.metric.api.CountMetric; public class CountShellMetric extends CountMetric implements IShellMetric { /*** * @param - * params should be null or long + * value should be null or long * if value is null, it will call incr() * if value is long, it will call incrBy((long)params) * */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/metric/api/rpc/IShellMetric.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/metric/api/rpc/IShellMetric.java b/storm-core/src/jvm/backtype/storm/metric/api/rpc/IShellMetric.java index d53baea..a37e46b 100644 --- a/storm-core/src/jvm/backtype/storm/metric/api/rpc/IShellMetric.java +++ b/storm-core/src/jvm/backtype/storm/metric/api/rpc/IShellMetric.java @@ -20,12 +20,11 @@ package backtype.storm.metric.api.rpc; import backtype.storm.metric.api.IMetric; public interface IShellMetric extends IMetric { - /*** - * @function + /** * This interface is used by ShellBolt and ShellSpout through RPC call to update Metric * @param * value used to update metric, its's meaning change according implementation * Object can be any json support types: String, Long, Double, Boolean, Null, List, Map - * */ + */ public void updateMetricFromRPC(Object value); } http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/scheduler/Cluster.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/scheduler/Cluster.java b/storm-core/src/jvm/backtype/storm/scheduler/Cluster.java index e0c7cc7..e171ddf 100644 --- a/storm-core/src/jvm/backtype/storm/scheduler/Cluster.java +++ b/storm-core/src/jvm/backtype/storm/scheduler/Cluster.java @@ -132,7 +132,7 @@ public class Cluster { } /** - * Gets a executor -> component-id map which needs scheduling in this topology. + * Gets a executor -> component-id map which needs scheduling in this topology. * * @param topology * @return @@ -150,7 +150,7 @@ public class Cluster { } /** - * Gets a component-id -> executors map which needs scheduling in this topology. + * Gets a component-id -> executors map which needs scheduling in this topology. * * @param topology * @return @@ -174,7 +174,7 @@ public class Cluster { /** * Get all the used ports of this supervisor. * - * @param cluster + * @param supervisor * @return */ public Set<Integer> getUsedPorts(SupervisorDetails supervisor) { @@ -195,7 +195,7 @@ public class Cluster { /** * Return the available ports of this supervisor. * - * @param cluster + * @param supervisor * @return */ public Set<Integer> getAvailablePorts(SupervisorDetails supervisor) { @@ -216,7 +216,7 @@ public class Cluster { /** * Return all the available slots on this supervisor. * - * @param cluster + * @param supervisor * @return */ public List<WorkerSlot> getAvailableSlots(SupervisorDetails supervisor) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/scheduler/SchedulerAssignment.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/scheduler/SchedulerAssignment.java b/storm-core/src/jvm/backtype/storm/scheduler/SchedulerAssignment.java index 0212e48..e126475 100644 --- a/storm-core/src/jvm/backtype/storm/scheduler/SchedulerAssignment.java +++ b/storm-core/src/jvm/backtype/storm/scheduler/SchedulerAssignment.java @@ -43,7 +43,7 @@ public interface SchedulerAssignment { public String getTopologyId(); /** - * get the executor -> slot map. + * get the executor -> slot map. * @return */ public Map<ExecutorDetails, WorkerSlot> getExecutorToSlot(); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/INimbusCredentialPlugin.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/INimbusCredentialPlugin.java b/storm-core/src/jvm/backtype/storm/security/INimbusCredentialPlugin.java index 9670045..4cdf721 100644 --- a/storm-core/src/jvm/backtype/storm/security/INimbusCredentialPlugin.java +++ b/storm-core/src/jvm/backtype/storm/security/INimbusCredentialPlugin.java @@ -41,7 +41,6 @@ public interface INimbusCredentialPlugin extends Shutdownable { * and stored in zookeeper. * @param credentials credentials map where more credentials will be added. * @param conf topology configuration - * @return */ void populateCredentials(Map<String, String> credentials, Map conf); } http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/AuthUtils.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/AuthUtils.java b/storm-core/src/jvm/backtype/storm/security/auth/AuthUtils.java index ac3fb53..315c280 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/AuthUtils.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/AuthUtils.java @@ -72,7 +72,7 @@ public class AuthUtils { /** * Construct a principal to local plugin - * @param conf storm configuration + * @param storm_conf storm configuration * @return the plugin */ public static IPrincipalToLocal GetPrincipalToLocalPlugin(Map storm_conf) { @@ -90,7 +90,7 @@ public class AuthUtils { /** * Construct a group mapping service provider plugin - * @param conf storm configuration + * @param storm_conf storm configuration * @return the plugin */ public static IGroupMappingServiceProvider GetGroupMappingServiceProviderPlugin(Map storm_conf) { @@ -108,7 +108,7 @@ public class AuthUtils { /** * Get all of the configured Credential Renwer Plugins. - * @param storm_conf the storm configuration to use. + * @param conf the storm configuration to use. * @return the configured credential renewers. */ public static Collection<ICredentialsRenewer> GetCredentialRenewers(Map conf) { @@ -216,7 +216,7 @@ public class AuthUtils { /** * Construct a transport plugin per storm configuration - * @param conf storm configuration + * @param storm_conf storm configuration * @return */ public static ITransportPlugin GetTransportPlugin(ThriftConnectionType type, Map storm_conf, Configuration login_conf) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/DefaultPrincipalToLocal.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/DefaultPrincipalToLocal.java b/storm-core/src/jvm/backtype/storm/security/auth/DefaultPrincipalToLocal.java index 729d744..e54e5fd 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/DefaultPrincipalToLocal.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/DefaultPrincipalToLocal.java @@ -28,7 +28,7 @@ import java.security.Principal; public class DefaultPrincipalToLocal implements IPrincipalToLocal { /** * Invoked once immediately after construction - * @param conf Storm configuration + * @param storm_conf Storm configuration */ public void prepare(Map storm_conf) {} http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/IAuthorizer.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/IAuthorizer.java b/storm-core/src/jvm/backtype/storm/security/auth/IAuthorizer.java index d592bb7..ff1e2ba 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/IAuthorizer.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/IAuthorizer.java @@ -32,7 +32,7 @@ import java.util.Map; public interface IAuthorizer { /** * Invoked once immediately after construction - * @param conf Storm configuration + * @param storm_conf Storm configuration */ void prepare(Map storm_conf); @@ -40,7 +40,7 @@ public interface IAuthorizer { * permit() method is invoked for each incoming Thrift request. * @param context request context includes info about * @param operation operation name - * @param topology_storm configuration of targeted topology + * @param topology_conf configuration of targeted topology * @return true if the request is authorized, false if reject */ public boolean permit(ReqContext context, String operation, Map topology_conf); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/IPrincipalToLocal.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/IPrincipalToLocal.java b/storm-core/src/jvm/backtype/storm/security/auth/IPrincipalToLocal.java index fca3d37..e938d39 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/IPrincipalToLocal.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/IPrincipalToLocal.java @@ -28,7 +28,7 @@ import java.security.Principal; public interface IPrincipalToLocal { /** * Invoked once immediately after construction - * @param conf Storm configuration + * @param storm_conf Storm configuration */ void prepare(Map storm_conf); http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/KerberosPrincipalToLocal.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/KerberosPrincipalToLocal.java b/storm-core/src/jvm/backtype/storm/security/auth/KerberosPrincipalToLocal.java index 35c7788..1f67c14 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/KerberosPrincipalToLocal.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/KerberosPrincipalToLocal.java @@ -28,7 +28,7 @@ public class KerberosPrincipalToLocal implements IPrincipalToLocal { /** * Invoked once immediately after construction - * @param conf Storm configuration + * @param storm_conf Storm configuration */ public void prepare(Map storm_conf) {} http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/authorizer/DenyAuthorizer.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/DenyAuthorizer.java b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/DenyAuthorizer.java index 5e84b38..6ab4ce4 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/DenyAuthorizer.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/DenyAuthorizer.java @@ -41,9 +41,9 @@ public class DenyAuthorizer implements IAuthorizer { /** * permit() method is invoked for each incoming Thrift request - * @param contrext request context + * @param context request context * @param operation operation name - * @param topology_storm configuration of targeted topology + * @param topology_conf configuration of targeted topology * @return true if the request is authorized, false if reject */ public boolean permit(ReqContext context, String operation, Map topology_conf) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/authorizer/NoopAuthorizer.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/NoopAuthorizer.java b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/NoopAuthorizer.java index 9af44d3..72217ce 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/NoopAuthorizer.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/NoopAuthorizer.java @@ -43,7 +43,7 @@ public class NoopAuthorizer implements IAuthorizer { * permit() method is invoked for each incoming Thrift request * @param context request context includes info about * @param operation operation name - * @param topology_storm configuration of targeted topology + * @param topology_conf configuration of targeted topology * @return true if the request is authorized, false if reject */ public boolean permit(ReqContext context, String operation, Map topology_conf) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/security/auth/authorizer/SimpleWhitelistAuthorizer.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/SimpleWhitelistAuthorizer.java b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/SimpleWhitelistAuthorizer.java index 55109f9..7f6144b 100644 --- a/storm-core/src/jvm/backtype/storm/security/auth/authorizer/SimpleWhitelistAuthorizer.java +++ b/storm-core/src/jvm/backtype/storm/security/auth/authorizer/SimpleWhitelistAuthorizer.java @@ -55,7 +55,7 @@ public class SimpleWhitelistAuthorizer implements IAuthorizer { * permit() method is invoked for each incoming Thrift request * @param context request context includes info about * @param operation operation name - * @param topology_storm configuration of targeted topology + * @param topology_conf configuration of targeted topology * @return true if the request is authorized, false if reject */ @Override http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/spout/ISpout.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/spout/ISpout.java b/storm-core/src/jvm/backtype/storm/spout/ISpout.java index c421fed..873c35a 100644 --- a/storm-core/src/jvm/backtype/storm/spout/ISpout.java +++ b/storm-core/src/jvm/backtype/storm/spout/ISpout.java @@ -93,6 +93,8 @@ public interface ISpout extends Serializable { * Storm has determined that the tuple emitted by this spout with the msgId identifier * has been fully processed. Typically, an implementation of this method will take that * message off the queue and prevent it from being replayed. + * + * @param msgId */ void ack(Object msgId); @@ -100,6 +102,8 @@ public interface ISpout extends Serializable { * The tuple emitted by this spout with the msgId identifier has failed to be * fully processed. Typically, an implementation of this method will put that * message back on the queue to be replayed at a later time. + * + * @param msgId */ void fail(Object msgId); } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/task/OutputCollector.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/task/OutputCollector.java b/storm-core/src/jvm/backtype/storm/task/OutputCollector.java index 620d33d..bae89bb 100644 --- a/storm-core/src/jvm/backtype/storm/task/OutputCollector.java +++ b/storm-core/src/jvm/backtype/storm/task/OutputCollector.java @@ -148,7 +148,7 @@ public class OutputCollector implements IOutputCollector { * in Java.</p> * * @param taskId the taskId to send the new tuple to - * @param anchosr the tuples to anchor to + * @param anchors the tuples to anchor to * @param tuple the new output tuple from this bolt */ public void emitDirect(int taskId, Collection<Tuple> anchors, List<Object> tuple) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/testing/MockedSources.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/testing/MockedSources.java b/storm-core/src/jvm/backtype/storm/testing/MockedSources.java index 1fd6b85..fae5cc7 100644 --- a/storm-core/src/jvm/backtype/storm/testing/MockedSources.java +++ b/storm-core/src/jvm/backtype/storm/testing/MockedSources.java @@ -36,7 +36,7 @@ public class MockedSources { * * @param spoutId the spout to be mocked * @param streamId the stream of the spout to be mocked - * @param objects the mocked data + * @param valueses the mocked data */ public void addMockData(String spoutId, String streamId, Values... valueses) { if (!data.containsKey(spoutId)) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/testing/TestJob.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/testing/TestJob.java b/storm-core/src/jvm/backtype/storm/testing/TestJob.java index d41c36a..2f92d17 100644 --- a/storm-core/src/jvm/backtype/storm/testing/TestJob.java +++ b/storm-core/src/jvm/backtype/storm/testing/TestJob.java @@ -29,6 +29,7 @@ import backtype.storm.ILocalCluster; * // your testing logic here. * } * }); + * </code> */ public interface TestJob { /** http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/topology/InputDeclarer.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/topology/InputDeclarer.java b/storm-core/src/jvm/backtype/storm/topology/InputDeclarer.java index ae93c44..d1cb258 100644 --- a/storm-core/src/jvm/backtype/storm/topology/InputDeclarer.java +++ b/storm-core/src/jvm/backtype/storm/topology/InputDeclarer.java @@ -144,7 +144,7 @@ public interface InputDeclarer<T extends InputDeclarer> { /** * Tuples are passed to two hashing functions and each target task is * decided based on the comparison of the state of candidate nodes. - * @see https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream-processing-engines.pdf + * @see "https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream-processing-engines.pdf" * @param componentId * @param fields * @return @@ -154,7 +154,7 @@ public interface InputDeclarer<T extends InputDeclarer> { /** * Tuples are passed to two hashing functions and each target task is * decided based on the comparison of the state of candidate nodes. - * @see https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream-processing-engines.pdf + * @see "https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream-processing-engines.pdf" * @param componentId * @param streamId * @param fields http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/tuple/Tuple.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/tuple/Tuple.java b/storm-core/src/jvm/backtype/storm/tuple/Tuple.java index 34dc61a..05c0635 100644 --- a/storm-core/src/jvm/backtype/storm/tuple/Tuple.java +++ b/storm-core/src/jvm/backtype/storm/tuple/Tuple.java @@ -29,7 +29,8 @@ import java.util.List; * Storm needs to know how to serialize all the values in a tuple. By default, Storm * knows how to serialize the primitive types, strings, and byte arrays. If you want to * use another type, you'll need to implement and register a serializer for that type. - * See {@link http://github.com/nathanmarz/storm/wiki/Serialization} for more info. + * See <a href="https://storm.apache.org/documentation/Serialization.html">Serialization Documentation</a> + * for more info. */ public interface Tuple extends ITuple{ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/utils/ShellUtils.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/utils/ShellUtils.java b/storm-core/src/jvm/backtype/storm/utils/ShellUtils.java index 1065ff9..c566cb4 100644 --- a/storm-core/src/jvm/backtype/storm/utils/ShellUtils.java +++ b/storm-core/src/jvm/backtype/storm/utils/ShellUtils.java @@ -274,7 +274,7 @@ abstract public class ShellUtils { } } - /** return an array containing the command name & its parameters */ + /** return an array containing the command name and its parameters */ protected abstract String[] getExecString(); /** Parse the execution result */ http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/utils/StormBoundedExponentialBackoffRetry.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/utils/StormBoundedExponentialBackoffRetry.java b/storm-core/src/jvm/backtype/storm/utils/StormBoundedExponentialBackoffRetry.java index 4aa5556..0360043 100644 --- a/storm-core/src/jvm/backtype/storm/utils/StormBoundedExponentialBackoffRetry.java +++ b/storm-core/src/jvm/backtype/storm/utils/StormBoundedExponentialBackoffRetry.java @@ -35,8 +35,8 @@ public class StormBoundedExponentialBackoffRetry extends BoundedExponentialBacko * storm. It calculates threshold for exponentially increasing sleeptime * for retries. Beyond this threshold, the sleeptime increase is linear. * Also adds jitter for exponential/linear retry. - * It guarantees currSleepTimeMs >= prevSleepTimeMs and - * baseSleepTimeMs <= currSleepTimeMs <= maxSleepTimeMs + * It guarantees currSleepTimeMs >= prevSleepTimeMs and + * baseSleepTimeMs <= currSleepTimeMs <= maxSleepTimeMs */ public StormBoundedExponentialBackoffRetry(int baseSleepTimeMs, int maxSleepTimeMs, int maxRetries) { http://git-wip-us.apache.org/repos/asf/storm/blob/e1829807/storm-core/src/jvm/backtype/storm/utils/WritableUtils.java ---------------------------------------------------------------------- diff --git a/storm-core/src/jvm/backtype/storm/utils/WritableUtils.java b/storm-core/src/jvm/backtype/storm/utils/WritableUtils.java index 8516f97..fbd4f2f 100644 --- a/storm-core/src/jvm/backtype/storm/utils/WritableUtils.java +++ b/storm-core/src/jvm/backtype/storm/utils/WritableUtils.java @@ -219,7 +219,7 @@ public final class WritableUtils { /** * Serializes an integer to a binary stream with zero-compressed encoding. - * For -120 <= i <= 127, only one byte is used with the actual value. + * For -120 <= i <= 127, only one byte is used with the actual value. * For other values of i, the first byte value indicates whether the * integer is positive or negative, and the number of bytes that follow. * If the first byte value v is between -121 and -124, the following integer @@ -238,7 +238,7 @@ public final class WritableUtils { /** * Serializes a long to a binary stream with zero-compressed encoding. - * For -112 <= i <= 127, only one byte is used with the actual value. + * For -112 <= i <= 127, only one byte is used with the actual value. * For other values of i, the first byte value indicates whether the * long is positive or negative, and the number of bytes that follow. * If the first byte value v is between -113 and -120, the following long