You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2022/03/12 15:35:53 UTC
[incubator-inlong] branch master updated: [INLONG-2961][DataProxy][Sort] Fix check style errors (#3087)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git
The following commit(s) were added to refs/heads/master by this push:
new 56b375b [INLONG-2961][DataProxy][Sort] Fix check style errors (#3087)
56b375b is described below
commit 56b375bccffd1a9b6c5382df3de3ff3488734c92
Author: ciscozhou <45...@users.noreply.github.com>
AuthorDate: Sat Mar 12 23:35:49 2022 +0800
[INLONG-2961][DataProxy][Sort] Fix check style errors (#3087)
---
.../apache/inlong/dataproxy/source/ConfStringUtils.java | 13 +++++++++++++
.../inlong/dataproxy/source/ServerMessageHandler.java | 15 +++++++++++++++
.../inlong/dataproxy/source/tcp/InlongTcpSource.java | 5 +++++
.../org/apache/inlong/dataproxy/utils/EventLoopUtil.java | 6 ++++++
.../org/apache/inlong/dataproxy/utils/MessageUtils.java | 8 ++++++++
.../standalone/sink/cls/DefaultEvent2LogItemHandler.java | 4 ++--
.../sort/standalone/sink/cls/IEvent2LogItemHandler.java | 6 +++---
.../sort/standalone/source/sortsdk/FetchCallback.java | 2 +-
.../sort/standalone/source/sortsdk/SortSdkSource.java | 4 ++--
.../standalone/source/sortsdk/SubscribeFetchResult.java | 2 +-
.../sink/elasticsearch/TestEsOutputChannel.java | 2 +-
.../standalone/sink/elasticsearch/TestEsSinkContext.java | 6 +++---
.../tubemq/manager/controller/group/GroupController.java | 4 ++--
.../manager/controller/topic/TopicWebController.java | 4 ++--
.../inlong/tubemq/manager/service/NodeServiceImpl.java | 5 ++---
.../tubemq/manager/service/interfaces/BrokerService.java | 2 ++
.../tubemq/manager/service/interfaces/MasterService.java | 2 +-
.../tubemq/manager/service/interfaces/NodeService.java | 6 +++---
18 files changed, 72 insertions(+), 24 deletions(-)
diff --git a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ConfStringUtils.java b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ConfStringUtils.java
index 618cde6..0d61db5 100644
--- a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ConfStringUtils.java
+++ b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ConfStringUtils.java
@@ -18,6 +18,13 @@
package org.apache.inlong.dataproxy.source;
public class ConfStringUtils {
+
+ /**
+ * Check ip format
+ *
+ * @param ip ip
+ * @return Boolean
+ */
public static boolean isValidIp(String ip) {
if (ip == null || ip.trim().isEmpty()) {
return false;
@@ -39,6 +46,12 @@ public class ConfStringUtils {
return b;
}
+ /**
+ * Check ip port
+ *
+ * @param port Port
+ * @return Boolean
+ */
public static boolean isValidPort(int port) {
if (port < 0 || port > 65535) {
return false;
diff --git a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ServerMessageHandler.java b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ServerMessageHandler.java
index 9aa60e3..7eb2792 100644
--- a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ServerMessageHandler.java
+++ b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/ServerMessageHandler.java
@@ -129,6 +129,21 @@ public class ServerMessageHandler extends ChannelInboundHandlerAdapter {
//
private final DataProxyMetricItemSet metricItemSet;
+ /**
+ * Constructor
+ *
+ * @param source AbstractSource
+ * @param serviceDecoder ServiceDecoder
+ * @param allChannels ChannelGroup
+ * @param topic Topic
+ * @param attr String
+ * @param filterEmptyMsg Boolean
+ * @param maxCons maxCons
+ * @param isCompressed Is compressed
+ * @param monitorIndex MonitorIndex
+ * @param monitorIndexExt MonitorIndexExt
+ * @param protocolType protocolType
+ */
public ServerMessageHandler(AbstractSource source, ServiceDecoder serviceDecoder,
ChannelGroup allChannels,
String topic, String attr, Boolean filterEmptyMsg,
diff --git a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/tcp/InlongTcpSource.java b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/tcp/InlongTcpSource.java
index ed9d98a..2d3e8d0 100644
--- a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/tcp/InlongTcpSource.java
+++ b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/source/tcp/InlongTcpSource.java
@@ -106,6 +106,11 @@ public class InlongTcpSource extends SimpleTcpSource
}
}
+ /**
+ * get ChannelInitializerFactory
+ *
+ * @return ChannelInitializer
+ */
public ChannelInitializer getChannelInitializerFactory() {
LOG.info(new StringBuffer("load msgFactory=").append(msgFactoryName)
.append(" and serviceDecoderName=").append(serviceDecoderName).toString());
diff --git a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/EventLoopUtil.java b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/EventLoopUtil.java
index 679a30b..378573f 100644
--- a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/EventLoopUtil.java
+++ b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/EventLoopUtil.java
@@ -84,6 +84,12 @@ public class EventLoopUtil {
return toCompletableFutureVoid(eventLoopGroup.shutdownGracefully());
}
+ /**
+ * get CompletableFuture<Void> by Future
+ *
+ * @param future Future
+ * @return CompletableFuture<Void>
+ */
public static CompletableFuture<Void> toCompletableFutureVoid(Future<?> future) {
Objects.requireNonNull(future, "future cannot be null");
diff --git a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/MessageUtils.java b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/MessageUtils.java
index 02b83c8..fe4647b 100644
--- a/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/MessageUtils.java
+++ b/inlong-dataproxy/dataproxy-source/src/main/java/org/apache/inlong/dataproxy/utils/MessageUtils.java
@@ -47,6 +47,14 @@ public class MessageUtils {
return isSyncSendForOrder(syncSend);
}
+ /**
+ * Convert String to ByteBuf
+ *
+ * @param backattrs
+ * @param msgType message type
+ * @param sequenceId sequence Id
+ * @return ByteBuf
+ */
public static ByteBuf getResponsePackage(String backattrs, MsgType msgType, String sequenceId) {
int binTotalLen = 1 + 4 + 2 + 2;
if (null != backattrs) {
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/DefaultEvent2LogItemHandler.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/DefaultEvent2LogItemHandler.java
index c5bc676..2a8f060 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/DefaultEvent2LogItemHandler.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/DefaultEvent2LogItemHandler.java
@@ -39,10 +39,10 @@ public class DefaultEvent2LogItemHandler implements IEvent2LogItemHandler {
private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
/**
- * Parse event to List<LogItem> format.
+ * Parse event to {@literal List<LogItem>} format.
*
* @param context Context of CLS sink.
- * @param event Event to be pares to List<LogItem>
+ * @param event Event to be pares to {@literal List<LogItem>}
* @return Prepared data structure to send.
*/
@Override
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
index 3d69036..2ffc198 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
@@ -23,15 +23,15 @@ import org.apache.inlong.sort.standalone.channel.ProfileEvent;
import java.util.List;
/**
- * Handler to pares profile event to CLS List<LogItem> format.
+ * Handler to pares profile event to CLS {@literal List<LogItem>} format.
*/
public interface IEvent2LogItemHandler {
/**
- * Parse event into CLS List<LogItem> format.
+ * Parse event into CLS {@literal List<LogItem>} format.
*
* @param context Context of CLS sink.
- * @param event Event to be pares to List<LogItem>
+ * @param event Event to be pares to {@literal List<LogItem>}
* @return List<LogItem>
*/
List<LogItem> parse(ClsSinkContext context, ProfileEvent event);
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/FetchCallback.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/FetchCallback.java
index c603f7c..1d71caa 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/FetchCallback.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/FetchCallback.java
@@ -125,7 +125,7 @@ public class FetchCallback implements ReadCallback {
/**
* The callback function that SortSDK invoke when fetch messages batch
*
- * @param messageRecordList {@link List<MessageRecord>}
+ * @param messageRecordList List
*/
@Override
public void onFinishedBatch(List<MessageRecord> messageRecordList) {
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SortSdkSource.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SortSdkSource.java
index e9a7837..06b2da3 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SortSdkSource.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SortSdkSource.java
@@ -131,8 +131,8 @@ public final class SortSdkSource extends AbstractSource implements Configurable,
* <p> Create new clients with new sort task id, and remove the finished or scheduled ones. </p>
*
* <p> Current version of SortSdk <b>DO NOT</b> support to get the corresponding sort id of {@link SortClient}.
- * Hence, the maintenance of mapping of <SortId, SortClient> should be done by Source itself. Which is not elegant,
- * the <b>REMOVE</b> of expire clients will <b>NOT</b> be supported right now. </p>
+ * Hence, the maintenance of mapping of {@literal sortId, SortClient} should be done by Source itself. Which
+ * is not elegant, the <b>REMOVE</b> of expire clients will <b>NOT</b> be supported right now. </p>
*/
private void reload() {
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SubscribeFetchResult.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SubscribeFetchResult.java
index 3572597..0df07e9 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SubscribeFetchResult.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/source/sortsdk/SubscribeFetchResult.java
@@ -66,7 +66,7 @@ public class SubscribeFetchResult {
* @param sortId String
* @param msgKey String
* @param offset String
- * @param headers {@link Map<String,String>}
+ * @param headers Map
* @param recTime long
* @param body byte[]
*/
diff --git a/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsOutputChannel.java b/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsOutputChannel.java
index cf21494..f8d2984 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsOutputChannel.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsOutputChannel.java
@@ -58,7 +58,7 @@ public class TestEsOutputChannel {
* mock
*
* @return
- * @throws Exception
+ * @throws Exception exception
*/
public static EsOutputChannel mock() throws Exception {
EsOutputChannel output = PowerMockito.mock(EsOutputChannel.class);
diff --git a/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsSinkContext.java b/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsSinkContext.java
index 4f7cd3f..1cafb7c 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsSinkContext.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/test/java/org/apache/inlong/sort/standalone/sink/elasticsearch/TestEsSinkContext.java
@@ -56,9 +56,9 @@ public class TestEsSinkContext {
/**
* mock
*
- * @param dispatchQueue
- * @return
- * @throws Exception
+ * @param dispatchQueue
+ * @return EsSinkContext
+ * @throws Exception exception
*/
public static EsSinkContext mock(LinkedBlockingQueue<EsIndexRequest> dispatchQueue) throws Exception {
PowerMockito.mockStatic(MetricRegister.class);
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/group/GroupController.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/group/GroupController.java
index 3b47b80..d2bda3a 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/group/GroupController.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/group/GroupController.java
@@ -94,7 +94,7 @@ public class GroupController {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@GetMapping("/")
public @ResponseBody
@@ -139,7 +139,7 @@ public class GroupController {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@GetMapping("/blackGroup")
public @ResponseBody
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/topic/TopicWebController.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/topic/TopicWebController.java
index 264cac4..727e644 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/topic/TopicWebController.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/controller/topic/TopicWebController.java
@@ -103,7 +103,7 @@ public class TopicWebController {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@GetMapping("/consumerAuth")
public @ResponseBody
@@ -118,7 +118,7 @@ public class TopicWebController {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@GetMapping("/topicConfig")
public @ResponseBody
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/NodeServiceImpl.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/NodeServiceImpl.java
index 82f9ec3..1edd1a8 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/NodeServiceImpl.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/NodeServiceImpl.java
@@ -89,7 +89,6 @@ public class NodeServiceImpl implements NodeService {
*
* @param masterEntry - node entry
* @return
- * @throws IOException
*/
@Override
public TubeHttpBrokerInfoList requestBrokerStatus(MasterEntry masterEntry) {
@@ -118,7 +117,7 @@ public class NodeServiceImpl implements NodeService {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@Override
public TubeMQResult cloneBrokersWithTopic(CloneBrokersReq req) throws Exception {
@@ -311,7 +310,7 @@ public class NodeServiceImpl implements NodeService {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
@Override
public TubeMQResult cloneTopicToBrokers(CloneTopicReq req) throws Exception {
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/BrokerService.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/BrokerService.java
index f451bae..697b675 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/BrokerService.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/BrokerService.java
@@ -73,6 +73,8 @@ public interface BrokerService {
TubeMQResult cloneOffset(String brokerIp, int brokerWebPort, CloneOffsetReq req);
/**
+ * delete offset
+ *
* @param brokerIp
* @param brokerWebPort
* @param req
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/MasterService.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/MasterService.java
index a7e57e5..9886b09 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/MasterService.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/MasterService.java
@@ -80,7 +80,7 @@ public interface MasterService {
*
* @param queryBody
* @return
- * @throws Exception
+ * @throws Exception exception
*/
String getQueryUrl(Map<String, String> queryBody) throws Exception;
diff --git a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/NodeService.java b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/NodeService.java
index bdc78dc..e9509c1 100644
--- a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/NodeService.java
+++ b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/interfaces/NodeService.java
@@ -46,7 +46,7 @@ public interface NodeService {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
TubeMQResult cloneBrokersWithTopic(CloneBrokersReq req) throws Exception;
@@ -67,7 +67,7 @@ public interface NodeService {
* @param req
* @param masterEntry
* @return
- * @throws Exception
+ * @throws Exception exception
*/
TubeMQResult addTopicToBrokers(AddTopicReq req, MasterEntry masterEntry) throws Exception;
@@ -92,7 +92,7 @@ public interface NodeService {
*
* @param req
* @return
- * @throws Exception
+ * @throws Exception exception
*/
TubeMQResult cloneTopicToBrokers(CloneTopicReq req) throws Exception;