This is an automated email from the ASF dual-hosted git repository.
healchow 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 70bcbb64b [INLONG-4324][TubeMQ] Add Java doc for some methods (#4331)
70bcbb64b is described below
commit 70bcbb64be5fa411fe7ea1d0301f1e1a3cfafb1b
Author: Lizhen <[email protected]>
AuthorDate: Tue May 24 11:48:20 2022 +0800
[INLONG-4324][TubeMQ] Add Java doc for some methods (#4331)
---
.../tubemq/manager/controller/group/GroupController.java | 12 +++++++++---
.../inlong/tubemq/manager/executors/AddTopicExecutor.java | 6 ++++++
.../inlong/tubemq/manager/service/TaskServiceImpl.java | 5 +++++
.../inlong/tubemq/manager/service/tube/BrokerConf.java | 5 +++++
.../tubemq/manager/service/tube/TubeHttpTopicInfoList.java | 8 ++++++++
5 files changed, 33 insertions(+), 3 deletions(-)
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 f84cadf55..0a502cf51 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
@@ -60,10 +60,16 @@ public class GroupController {
@Autowired
private TopicServiceImpl topicService;
+ /**
+ * Consumer group related request operations
+ *
+ * @param method method type
+ * @param req incoming data
+ * @return return request data
+ */
+ @ResponseBody
@PostMapping("")
- public @ResponseBody
- TubeMQResult groupMethodProxy(
- @RequestParam String method, @RequestBody String req) {
+ public TubeMQResult groupMethodProxy(@RequestParam String method,
@RequestBody String req) {
switch (method) {
case TubeConst.ADD:
return batchAddGroup(gson.fromJson(req,
BatchAddGroupAuthReq.class));
diff --git
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/executors/AddTopicExecutor.java
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/executors/AddTopicExecutor.java
index 3fc1bbc7f..d96bf76a7 100644
---
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/executors/AddTopicExecutor.java
+++
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/executors/AddTopicExecutor.java
@@ -67,6 +67,12 @@ public class AddTopicExecutor {
@Autowired
MasterService masterService;
+ /**
+ * Add topic info
+ *
+ * @param clusterId this is the cluster id
+ * @param topicTasks topic info
+ */
@Async("asyncExecutor")
public void addTopicConfig(Long clusterId, List<TopicTaskEntry>
topicTasks) {
if (CollectionUtils.isEmpty(topicTasks)) {
diff --git
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/TaskServiceImpl.java
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/TaskServiceImpl.java
index 496ab7fd9..2797db544 100644
---
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/TaskServiceImpl.java
+++
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/TaskServiceImpl.java
@@ -151,6 +151,11 @@ public class TaskServiceImpl implements TaskService {
updateCreateTopicTaskStatus(clusterId);
}
+ /**
+ * Modify the status of creating a topic task
+ *
+ * @param clusterId this is the cluster id
+ */
@Transactional(rollbackOn = Exception.class)
public void updateCreateTopicTaskStatus(long clusterId) {
List<TopicTaskEntry> topicTasks = topicTaskRepository
diff --git
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/BrokerConf.java
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/BrokerConf.java
index 75ab7736e..8e9600205 100644
---
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/BrokerConf.java
+++
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/BrokerConf.java
@@ -40,6 +40,11 @@ public class BrokerConf {
private Integer memCacheFlushIntegervl;
private String deletePolicy;
+ /**
+ * broker configuration info
+ *
+ * @param other broker info
+ */
public BrokerConf(BrokerConf other) {
this.brokerIp = other.brokerIp;
this.brokerPort = other.brokerPort;
diff --git
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/TubeHttpTopicInfoList.java
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/TubeHttpTopicInfoList.java
index 839f83d0a..11fc249e9 100644
---
a/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/TubeHttpTopicInfoList.java
+++
b/inlong-tubemq/tubemq-manager/src/main/java/org/apache/inlong/tubemq/manager/service/tube/TubeHttpTopicInfoList.java
@@ -110,6 +110,14 @@ public class TubeHttpTopicInfoList {
return data.get(0).getTopicInfo();
}
+ /**
+ * topic add information
+ *
+ * @param brokerIds this is the broker ids
+ * @param targetTopicNames The topic name of the target
+ * @param token authorized key
+ * @return topic data
+ */
public AddTopicReq getAddTopicReq(List<Integer> brokerIds, List<String>
targetTopicNames, String token) {
AddTopicReq req = new AddTopicReq();
