From 6a787deff741b3005d99b0ff8f92c58bc0660ca4 Mon Sep 17 00:00:00 2001 From: Ady Liu Date: Tue, 15 Mar 2016 19:55:54 +0800 Subject: [PATCH] fixed all error of javadoc --- .../com/sohu/jafka/api/CreaterRequest.java | 1 - .../sohu/jafka/api/MultiFetchResponse.java | 3 +- .../com/sohu/jafka/api/OffsetRequest.java | 2 - .../com/sohu/jafka/api/ProducerRequest.java | 2 - .../java/com/sohu/jafka/cluster/Broker.java | 1 - .../sohu/jafka/consumer/ConsumerConfig.java | 2 - .../com/sohu/jafka/consumer/TopicCount.java | 6 +-- .../consumer/ZookeeperConsumerConnector.java | 45 +++++++++---------- src/main/java/com/sohu/jafka/log/Log.java | 3 +- .../sohu/jafka/message/FileMessageSet.java | 4 +- .../java/com/sohu/jafka/message/Message.java | 3 +- .../java/com/sohu/jafka/mx/LogStatsMBean.java | 2 +- .../sohu/jafka/producer/ProducerConfig.java | 2 +- .../jafka/producer/async/CallbackHandler.java | 2 +- .../com/sohu/jafka/server/ServerRegister.java | 7 ++- .../java/com/sohu/jafka/utils/Mx4jLoader.java | 1 - .../sohu/jafka/utils/zookeeper/ZkUtils.java | 4 +- 17 files changed, 37 insertions(+), 53 deletions(-) diff --git a/src/main/java/com/sohu/jafka/api/CreaterRequest.java b/src/main/java/com/sohu/jafka/api/CreaterRequest.java index 812c450..0940cdd 100644 --- a/src/main/java/com/sohu/jafka/api/CreaterRequest.java +++ b/src/main/java/com/sohu/jafka/api/CreaterRequest.java @@ -28,7 +28,6 @@ * Create Operation *

* This operation creates topic in a broker or enlarge the partition number of topic. - *

* * @author adyliu (imxylz@gmail.com) * @since 1.2 diff --git a/src/main/java/com/sohu/jafka/api/MultiFetchResponse.java b/src/main/java/com/sohu/jafka/api/MultiFetchResponse.java index c23b01e..afb2a38 100644 --- a/src/main/java/com/sohu/jafka/api/MultiFetchResponse.java +++ b/src/main/java/com/sohu/jafka/api/MultiFetchResponse.java @@ -39,9 +39,8 @@ public class MultiFetchResponse implements Iterable { * create a multi-response *

* buffer format: size+errorCode(short)+payload+size+errorCode(short)+payload+... - *
+ *

* size = 2(short)+length(payload) - *

* * @param buffer the whole data buffer * @param numSets response count diff --git a/src/main/java/com/sohu/jafka/api/OffsetRequest.java b/src/main/java/com/sohu/jafka/api/OffsetRequest.java index f331311..78030e7 100644 --- a/src/main/java/com/sohu/jafka/api/OffsetRequest.java +++ b/src/main/java/com/sohu/jafka/api/OffsetRequest.java @@ -31,7 +31,6 @@ * Jafka will returns all offsets earlier than given time with max number * limit. The fist offset of result is the biggest and the the last is the * smallest. - *

* * @author adyliu (imxylz@gmail.com) * @since 1.0 @@ -74,7 +73,6 @@ public class OffsetRequest implements Request { *
  • time>0: the log file offset which lastmodified time earlier * than the time
    • * - *

    */ public long time; diff --git a/src/main/java/com/sohu/jafka/api/ProducerRequest.java b/src/main/java/com/sohu/jafka/api/ProducerRequest.java index 36fb240..e216f77 100644 --- a/src/main/java/com/sohu/jafka/api/ProducerRequest.java +++ b/src/main/java/com/sohu/jafka/api/ProducerRequest.java @@ -39,8 +39,6 @@ * message: bytes * * - *

    - * * @author adyliu (imxylz@gmail.com) * @since 1.0 */ diff --git a/src/main/java/com/sohu/jafka/cluster/Broker.java b/src/main/java/com/sohu/jafka/cluster/Broker.java index da05987..7af69d8 100644 --- a/src/main/java/com/sohu/jafka/cluster/Broker.java +++ b/src/main/java/com/sohu/jafka/cluster/Broker.java @@ -72,7 +72,6 @@ public Broker(int id, String creatorId, String host, int port,boolean autocreate * the broker info saved in zookeeper *

    * format: creatorId:host:port - *

    * * @return broker info saved in zookeeper */ diff --git a/src/main/java/com/sohu/jafka/consumer/ConsumerConfig.java b/src/main/java/com/sohu/jafka/consumer/ConsumerConfig.java index 3c09104..2f7e745 100644 --- a/src/main/java/com/sohu/jafka/consumer/ConsumerConfig.java +++ b/src/main/java/com/sohu/jafka/consumer/ConsumerConfig.java @@ -31,7 +31,6 @@ *
  • groupid: the consumer group name
    • *
  • zk.connect: the zookeeper connection string
    • * - *

    * * @author adyliu (imxylz@gmail.com) * @since 1.0 @@ -79,7 +78,6 @@ public class ConsumerConfig extends ZKConfig { *
  • groupid: the consumer group name
    • *
  • zk.connect: the zookeeper connection string
    • * - *

    * * @param props config properties */ diff --git a/src/main/java/com/sohu/jafka/consumer/TopicCount.java b/src/main/java/com/sohu/jafka/consumer/TopicCount.java index 04daa15..7ce8304 100644 --- a/src/main/java/com/sohu/jafka/consumer/TopicCount.java +++ b/src/main/java/com/sohu/jafka/consumer/TopicCount.java @@ -42,7 +42,7 @@ public class TopicCount { /** * @param consumerIdString groupid-consumerid - * @param topicCountMap map: topic->threadCount + * @param topicCountMap map: topic->threadCount */ public TopicCount(String consumerIdString, Map topicCountMap) { this.consumerIdString = consumerIdString; @@ -50,7 +50,7 @@ public TopicCount(String consumerIdString, Map topicCountMap) { } /** * - * @return topic->(consumerIdString-0,consumerIdString-1..) + * @return topic->(consumerIdString-0,consumerIdString-1..) */ public Map> getConsumerThreadIdsPerTopic() { Map> consumerThreadIdsPerTopicMap = new HashMap>(); @@ -89,7 +89,7 @@ public boolean equals(Object obj) { return true; } /** - * topic->count map + * topic->count map * @return json map */ public String toJsonString() { diff --git a/src/main/java/com/sohu/jafka/consumer/ZookeeperConsumerConnector.java b/src/main/java/com/sohu/jafka/consumer/ZookeeperConsumerConnector.java index e66d518..29f148d 100644 --- a/src/main/java/com/sohu/jafka/consumer/ZookeeperConsumerConnector.java +++ b/src/main/java/com/sohu/jafka/consumer/ZookeeperConsumerConnector.java @@ -67,72 +67,68 @@ /** * This class handles the consumers interaction with zookeeper - *

    + * * Directories: *

    * 1. Consumer id registry: - *

    + * * 

    - * /consumers/[group_id]/ids[consumer_id] -> topic1,...topicN
+ * /consumers/[group_id]/ids[consumer_id] -- topic1,...topicN
  *
    - *

    + * * A consumer has a unique consumer id within a consumer group. A consumer registers its id as * an ephemeral znode and puts all topics that it subscribes to as the value of the znode. The * znode is deleted when the client is gone. A consumer subscribes to event changes of the * consumer id registry within its group. - *

    *

    * The consumer id is picked up from configuration, instead of the sequential id assigned by * ZK. Generated sequential ids are hard to recover during temporary connection loss to ZK, * since it's difficult for the client to figure out whether the creation of a sequential znode * has succeeded or not. More details can be found at * (http://wiki.apache.org/hadoop/ZooKeeper/ErrorHandling) - *

    *

    * 2. Broker node registry: - *

    * 

    - * /brokers/[0...N] --> { "host" : "host:port",
+ * /brokers/[0...N] -- { "host" : "host:port",
  *                        "topics" : {"topic1": ["partition1" ... "partitionN"], ...,
  *                                    "topicN": ["partition1" ... "partitionN"] } }
  *
    - *

    * This is a list of all present broker brokers. A unique logical node id is configured on each * broker node. A broker node registers itself on start-up and creates a znode with the logical * node id under /brokers. - *

    + * * The value of the znode is a JSON String that contains - *

    + * * 

      * (1) the host name and the port the broker is listening to,
  * (2) a list of topics that the broker serves,
  * (3) a list of logical partitions assigned to each topic on the broker.
  *
    - *

    + * * A consumer subscribes to event changes of the broker node registry. - *

    - *

    + * + * *

    * 3. Partition owner registry: - *

    + * * 

    - * /consumers/[group_id]/owner/[topic]/[broker_id-partition_id] --> consumer_node_id
+ * /consumers/[group_id]/owner/[topic]/[broker_id-partition_id] -- consumer_node_id
  *
    - *

    + * * This stores the mapping before broker partitions and consumers. Each partition is owned by a * unique consumer within a consumer group. The mapping is reestablished after each * rebalancing. - *

    - *

    + * + * *

    * 4. Consumer offset tracking: - *

    + * * 

    - * /consumers/[group_id]/offsets/[topic]/[broker_id-partition_id] --> offset_counter_value
+ * /consumers/[group_id]/offsets/[topic]/[broker_id-partition_id] -- offset_counter_value
  *
    - *

    + * * Each consumer tracks the offset of the latest message consumed for each partition. - *

    + * * * @author adyliu (imxylz@gmail.com) * @since 1.0 @@ -816,9 +812,8 @@ public void handleStateChanged(KeeperState state) throws Exception { /** * register consumer data in zookeeper *

    - * register path: /consumers/groupid/ids/groupid-consumerid
    + * register path: /consumers/groupid/ids/groupid-consumerid
    * data: {topic:count,topic:count} - *

    * * @param zkGroupDirs zookeeper group path * @param consumerIdString groupid-consumerid diff --git a/src/main/java/com/sohu/jafka/log/Log.java b/src/main/java/com/sohu/jafka/log/Log.java index 9a858c5..0199f6d 100644 --- a/src/main/java/com/sohu/jafka/log/Log.java +++ b/src/main/java/com/sohu/jafka/log/Log.java @@ -165,7 +165,8 @@ public int getNumberOfSegments() { return segments.getView().size(); } /** - * delete all log segments in this topic-partition
    + * delete all log segments in this topic-partition + *

    * The log directory will be removed also. * @return segment counts deleted */ diff --git a/src/main/java/com/sohu/jafka/message/FileMessageSet.java b/src/main/java/com/sohu/jafka/message/FileMessageSet.java index 4a6b6f9..7f01529 100644 --- a/src/main/java/com/sohu/jafka/message/FileMessageSet.java +++ b/src/main/java/com/sohu/jafka/message/FileMessageSet.java @@ -149,7 +149,7 @@ protected MessageAndOffset makeNext() { } /** - * the max offset(next message id).
    + * the max offset(next message id).
    * The #getSizeInBytes() maybe is larger than {@link #highWaterMark()} * while some messages were cached in memory(not flush to disk). */ @@ -279,7 +279,7 @@ void checkMutable() { } /** - * The max offset(next message id) persisted in the log file.
    + * The max offset(next message id) persisted in the log file.
    * Messages with smaller offsets have persisted in file. * * @return max offset diff --git a/src/main/java/com/sohu/jafka/message/Message.java b/src/main/java/com/sohu/jafka/message/Message.java index 9d59583..0d949e0 100644 --- a/src/main/java/com/sohu/jafka/message/Message.java +++ b/src/main/java/com/sohu/jafka/message/Message.java @@ -38,8 +38,7 @@ * 3. 4 byte CRC32 of the payload * 4. N - 6 byte payload * - * - *

    + * * * @author adyliu (imxylz@gmail.com) * @since 1.0 diff --git a/src/main/java/com/sohu/jafka/mx/LogStatsMBean.java b/src/main/java/com/sohu/jafka/mx/LogStatsMBean.java index eb80ace..0e8b191 100644 --- a/src/main/java/com/sohu/jafka/mx/LogStatsMBean.java +++ b/src/main/java/com/sohu/jafka/mx/LogStatsMBean.java @@ -23,7 +23,7 @@ * For the last writeable file: *
      *
    • size
      • - *

      + *
    * * @author adyliu (imxylz@gmail.com) * @since 1.0 diff --git a/src/main/java/com/sohu/jafka/producer/ProducerConfig.java b/src/main/java/com/sohu/jafka/producer/ProducerConfig.java index 1d03ac8..fdd236b 100644 --- a/src/main/java/com/sohu/jafka/producer/ProducerConfig.java +++ b/src/main/java/com/sohu/jafka/producer/ProducerConfig.java @@ -204,7 +204,7 @@ public int getZkReadRetries() { * a VIP. If the zk.connect option is used instead, this will not have any effect because * with the zk-based producer, brokers are not re-selected upon retry. So retries would go * to the same (potentially still down) broker. (KAFKA-253 will help address this.) - *

    + *
    * see https://github.com/apache/kafka/commit/d6b1de35f6b9cd5370c7812790fea8e61618f461 */ public int getNumRetries() { diff --git a/src/main/java/com/sohu/jafka/producer/async/CallbackHandler.java b/src/main/java/com/sohu/jafka/producer/async/CallbackHandler.java index 8a66b17..3d870d1 100644 --- a/src/main/java/com/sohu/jafka/producer/async/CallbackHandler.java +++ b/src/main/java/com/sohu/jafka/producer/async/CallbackHandler.java @@ -27,7 +27,7 @@ * producer * * @author adyliu (imxylz@gmail.com) - * @see {@link AbstractCallbackHandler} + * @see AbstractCallbackHandler * @since 1.0 */ public interface CallbackHandler { diff --git a/src/main/java/com/sohu/jafka/server/ServerRegister.java b/src/main/java/com/sohu/jafka/server/ServerRegister.java index 73fbf08..4a56793 100644 --- a/src/main/java/com/sohu/jafka/server/ServerRegister.java +++ b/src/main/java/com/sohu/jafka/server/ServerRegister.java @@ -38,10 +38,10 @@ /** * Handles the server's interaction with zookeeper. The server needs to register the following * paths: - *

    + *

    * 

      *   /topics/[topic]/[node_id-partition_num]
- *   /brokers/[0...N] --> host:port
+ *   /brokers/[0...N] -- host:port
  *
    * * @author adyliu (imxylz@gmail.com) @@ -113,9 +113,8 @@ private int getPartitions(String topic) { /** * register broker in the zookeeper *

    - * path: /brokers/ids/
    + * path: /brokers/ids/<id>
    * data: creator:host:port - *

    */ public void registerBrokerInZk() { logger.info("Registering broker " + brokerIdPath); diff --git a/src/main/java/com/sohu/jafka/utils/Mx4jLoader.java b/src/main/java/com/sohu/jafka/utils/Mx4jLoader.java index b164bdf..451f198 100644 --- a/src/main/java/com/sohu/jafka/utils/Mx4jLoader.java +++ b/src/main/java/com/sohu/jafka/utils/Mx4jLoader.java @@ -31,7 +31,6 @@ *

    * see https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/utils/ * Mx4jTool.java - *

    * * @author adyliu (imxylz@gmail.com) * @since 1.0 diff --git a/src/main/java/com/sohu/jafka/utils/zookeeper/ZkUtils.java b/src/main/java/com/sohu/jafka/utils/zookeeper/ZkUtils.java index ce19d79..061cda4 100644 --- a/src/main/java/com/sohu/jafka/utils/zookeeper/ZkUtils.java +++ b/src/main/java/com/sohu/jafka/utils/zookeeper/ZkUtils.java @@ -119,7 +119,7 @@ public static TopicCount getTopicCount(ZkClient zkClient, String group, String c * * @param zkClient the zookeeper client * @param topics topic names - * @return topic->(brokerid-0,brokerid-1...brokerid2-0,brokerid2-1...) + * @return topic->(brokerid-0,brokerid-1...brokerid2-0,brokerid2-1...) */ public static Map> getPartitionsForTopics(ZkClient zkClient, Collection topics) { Map> ret = new HashMap>(); @@ -146,7 +146,7 @@ public static Map> getPartitionsForTopics(ZkClient zkClient * * @param zkClient the zookeeper client * @param group the group name - * @return topic->(consumerIdStringA-0,consumerIdStringA-1...consumerIdStringB-0,consumerIdStringB-1) + * @return topic->(consumerIdStringA-0,consumerIdStringA-1...consumerIdStringB-0,consumerIdStringB-1) */ public static Map> getConsumersPerTopic(ZkClient zkClient, String group) { ZkGroupDirs dirs = new ZkGroupDirs(group);