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/05/15 02:59:05 UTC
[incubator-inlong] branch master updated: [INLONG-4179][Manager] Add Java docs for manager (#4180)
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 aaa6608de [INLONG-4179][Manager] Add Java docs for manager (#4180)
aaa6608de is described below
commit aaa6608dee7c87bcfc9cb667761d79126dba643b
Author: fuweng11 <76...@users.noreply.github.com>
AuthorDate: Sun May 15 10:59:01 2022 +0800
[INLONG-4179][Manager] Add Java docs for manager (#4180)
---
.../manager/client/AutoPush2HiveExample.java | 3 +
.../inlong/manager/client/Binlog2KafkaExample.java | 3 +
.../inlong/manager/client/File2HiveExample.java | 3 +
.../inlong/manager/client/Kafka2HiveExample.java | 3 +
.../inlong/manager/client/cli/CommandBase.java | 3 +
.../inlong/manager/client/cli/CommandCreate.java | 3 +
.../inlong/manager/client/cli/CommandDescribe.java | 3 +
.../inlong/manager/client/cli/CommandList.java | 3 +
.../inlong/manager/client/cli/CommandToolMain.java | 3 +
.../inlong/manager/client/cli/CommandUtil.java | 3 +
.../inlong/manager/client/cli/CreateGroupConf.java | 3 +
.../client/cli/converter/FileConverter.java | 3 +
.../inlong/manager/client/cli/pojo/GroupInfo.java | 3 +
.../inlong/manager/client/cli/pojo/SinkInfo.java | 3 +
.../inlong/manager/client/cli/pojo/SourceInfo.java | 3 +
.../inlong/manager/client/cli/pojo/StreamInfo.java | 3 +
.../manager/client/cli/util/CharsetAdapter.java | 3 +
.../manager/client/cli/util/DataFormatAdapter.java | 3 +
.../inlong/manager/client/cli/util/GsonUtil.java | 3 +
.../manager/client/cli/util/MQBaseConfAdapter.java | 3 +
.../manager/client/cli/util/SeparatorAdapter.java | 3 +
.../client/cli/util/SortBaseConfAdapter.java | 3 +
.../manager/client/cli/util/StreamSinkAdapter.java | 3 +
.../client/cli/util/StreamSourceAdapter.java | 3 +
.../manager/client/cli/validator/GroupStatus.java | 3 +
.../inlong/manager/client/cli/TestCommand.java | 3 +
.../manager/client/api/FlinkSortBaseConf.java | 3 +
.../inlong/manager/client/api/InlongClient.java | 6 +-
.../inlong/manager/client/api/InlongGroup.java | 7 +-
.../inlong/manager/client/api/InlongGroupConf.java | 3 +
.../manager/client/api/InlongGroupContext.java | 3 +
.../inlong/manager/client/api/InlongStream.java | 44 +-----------
.../manager/client/api/InlongStreamBuilder.java | 3 +
.../manager/client/api/InlongStreamConf.java | 3 +
.../inlong/manager/client/api/MQBaseConf.java | 3 +
.../inlong/manager/client/api/PulsarBaseConf.java | 3 +
.../inlong/manager/client/api/SortBaseConf.java | 3 +
.../manager/client/api/TdmqPulsarBaseConf.java | 3 +
.../inlong/manager/client/api/TubeBaseConf.java | 3 +
.../manager/client/api/UserDefinedSortConf.java | 3 +
.../client/api/auth/DefaultAuthentication.java | 3 +
.../client/api/auth/SecretAuthentication.java | 3 +
.../client/api/auth/SecretTokenAuthentication.java | 3 +
.../client/api/auth/TokenAuthentication.java | 3 +
.../manager/client/api/impl/BlankInlongGroup.java | 3 +
.../api/impl/DefaultInlongStreamBuilder.java | 3 +
.../manager/client/api/impl/InlongClientImpl.java | 3 +
.../manager/client/api/impl/InlongGroupImpl.java | 3 +
.../manager/client/api/impl/InlongStreamImpl.java | 3 +
.../client/api/impl/LowLevelInlongClientImpl.java | 3 +
.../client/api/inner/InnerGroupContext.java | 3 +
.../client/api/inner/InnerStreamContext.java | 3 +
.../manager/client/api/sink/ClickHouseSink.java | 3 +
.../inlong/manager/client/api/sink/HiveSink.java | 3 +
.../inlong/manager/client/api/sink/KafkaSink.java | 3 +
.../manager/client/api/source/AgentFileSource.java | 3 +
.../manager/client/api/source/AutoPushSource.java | 3 +
.../manager/client/api/source/KafkaSource.java | 3 +
.../client/api/source/MySQLBinlogSource.java | 3 +
.../manager/client/api/source/MySQLSource.java | 3 +
.../api/transform/MultiDependencyTransform.java | 3 +
.../api/transform/SingleDependencyTransform.java | 3 +
.../client/api/impl/InlongStreamImplTest.java | 3 +
.../api/impl/InnerInlongManagerClientTest.java | 3 +
.../inlong/manager/common/beans/ClusterBean.java | 3 +
.../manager/common/beans/ReTryConfigBean.java | 3 +
.../common/conversion/ConversionHandle.java | 6 ++
.../common/conversion/ConversionStatusContext.java | 6 ++
.../common/conversion/ConversionStrategy.java | 3 +
.../manager/common/conversion/DaysToMinute.java | 3 +
.../manager/common/conversion/DaysToSeconds.java | 3 +
.../inlong/manager/common/conversion/GBToMB.java | 3 +
.../manager/common/conversion/HoursToMinute.java | 3 +
.../manager/common/conversion/HoursToSeconds.java | 3 +
.../inlong/manager/common/conversion/MBToMB.java | 3 +
.../common/conversion/SecondsToSeconds.java | 3 +
.../inlong/manager/common/conversion/TBToMB.java | 3 +
.../manager/common/enums/ApplicationEnv.java | 3 +
.../inlong/manager/common/enums/DataFormat.java | 3 +
.../manager/common/exceptions/BaseException.java | 3 +
.../common/exceptions/BusinessException.java | 3 +
.../manager/common/pojo/audit/AuditInfo.java | 3 +
.../manager/common/pojo/audit/AuditRequest.java | 3 +
.../inlong/manager/common/pojo/audit/AuditVO.java | 3 +
.../pojo/commonserver/CommonDbServerInfo.java | 3 +
.../pojo/commonserver/CommonFileServerListVo.java | 3 +
.../common/pojo/dataproxy/DataProxyResponse.java | 3 +
.../manager/common/pojo/group/DataSchemaInfo.java | 1 -
.../common/pojo/group/InlongGroupResponse.java | 3 +
.../common/pojo/pulsar/PulsarTopicBean.java | 3 +
.../common/pojo/sink/ck/ClickHouseColumnInfo.java | 3 +
.../common/pojo/sink/ck/ClickHouseTableInfo.java | 3 +
.../common/pojo/source/SourceListResponse.java | 2 +-
.../manager/common/pojo/source/SourceRequest.java | 2 +-
.../manager/common/pojo/source/SourceResponse.java | 2 +-
.../autopush/AutoPushSourceListResponse.java | 3 +
.../source/binlog/BinlogSourceListResponse.java | 2 +-
.../pojo/source/binlog/BinlogSourceRequest.java | 2 +-
.../pojo/source/binlog/BinlogSourceResponse.java | 2 +-
.../pojo/source/file/FileSourceListResponse.java | 2 +-
.../common/pojo/source/file/FileSourceRequest.java | 2 +-
.../pojo/source/file/FileSourceResponse.java | 2 +-
.../stream/InlongStreamConfigLogListResponse.java | 3 +
.../stream/InlongStreamConfigLogPageRequest.java | 3 +
.../pojo/stream/InlongStreamConfigLogRequest.java | 3 +
.../common/pojo/stream/InlongStreamResponse.java | 3 +
.../manager/common/pojo/stream/SinkField.java | 3 +
.../manager/common/pojo/stream/StreamField.java | 3 +
.../manager/common/pojo/stream/StreamNode.java | 3 +
.../common/pojo/stream/StreamNodeRelationship.java | 3 +
.../manager/common/pojo/stream/StreamPipeline.java | 3 +
.../manager/common/pojo/stream/StreamSink.java | 3 +
.../manager/common/pojo/stream/StreamSource.java | 3 +
.../common/pojo/stream/StreamTransform.java | 3 +
.../common/pojo/transform/TransformDefinition.java | 3 +
.../pojo/tubemq/AddTubeConsumeGroupRequest.java | 3 +
.../common/pojo/tubemq/AddTubeMqTopicRequest.java | 3 +
.../common/pojo/tubemq/QueryTubeTopicRequest.java | 3 +
.../common/pojo/tubemq/TubeClusterResponse.java | 3 +
.../common/pojo/tubemq/TubeManagerResponse.java | 3 +
.../common/pojo/user/PasswordChangeRequest.java | 3 +
.../manager/common/pojo/user/UserDetailListVO.java | 3 +
.../common/pojo/user/UserDetailPageRequest.java | 3 +
.../inlong/manager/common/pojo/user/UserInfo.java | 3 +
.../manager/common/pojo/user/UserRoleCode.java | 3 +
.../inlong/manager/common/util/AgentConstants.java | 3 +
.../manager/common/util/InlongCollectionUtils.java | 3 +
.../manager/common/util/StreamParseUtils.java | 3 +
.../common/pojo/stream/StreamPipelineTest.java | 3 +
.../pojo/transform/TransformDefinitionTest.java | 3 +
.../common/util/InlongCollectionUtilsTest.java | 3 +
.../manager/dao/entity/AgentSysConfigEntity.java | 3 +
.../inlong/manager/dao/entity/AuditEntity.java | 3 +
.../inlong/manager/dao/entity/CacheClusterExt.java | 4 --
.../inlong/manager/dao/entity/CityZoneEntity.java | 3 +
.../inlong/manager/dao/entity/CityZoneInfo.java | 3 +
.../manager/dao/entity/CommonDbServerEntity.java | 3 +
.../manager/dao/entity/CommonFileServerEntity.java | 3 +
.../dao/entity/ComponentHeartbeatEntity.java | 3 +
.../dao/entity/ConsumptionPulsarEntity.java | 3 +
.../dao/entity/DBCollectorDetailTaskEntity.java | 3 +
.../inlong/manager/dao/entity/DataNodeEntity.java | 3 +
.../manager/dao/entity/DataProxyClusterEntity.java | 3 +
.../manager/dao/entity/DataSchemaEntity.java | 3 +
.../dao/entity/DataSourceCmdConfigEntity.java | 3 +
.../manager/dao/entity/GroupHeartbeatEntity.java | 3 +
.../manager/dao/entity/InlongClusterEntity.java | 3 +
.../dao/entity/InlongClusterNodeEntity.java | 3 +
.../manager/dao/entity/InlongGroupEntity.java | 3 +
.../manager/dao/entity/InlongGroupExtEntity.java | 3 +
.../dao/entity/InlongGroupPulsarEntity.java | 3 +
.../manager/dao/entity/InlongStreamEntity.java | 3 +
.../dao/entity/InlongStreamFieldEntity.java | 3 +
.../manager/dao/entity/OperationLogEntity.java | 3 +
.../inlong/manager/dao/entity/RoleEntity.java | 3 +
.../dao/entity/SortClusterConfigEntity.java | 3 +
.../manager/dao/entity/SortSourceConfigEntity.java | 3 +
.../manager/dao/entity/SortTaskIdParamEntity.java | 3 +
.../dao/entity/SortTaskSinkParamEntity.java | 3 +
.../manager/dao/entity/SourceDbDetailEntity.java | 3 +
.../manager/dao/entity/SourceFileBasicEntity.java | 3 +
.../manager/dao/entity/SourceFileDetailEntity.java | 3 +
.../manager/dao/entity/StreamConfigLogEntity.java | 3 +
.../manager/dao/entity/StreamHeartbeatEntity.java | 3 +
.../manager/dao/entity/StreamSinkEntity.java | 3 +
.../manager/dao/entity/StreamSinkExtEntity.java | 3 +
.../manager/dao/entity/StreamSinkFieldEntity.java | 3 +
.../manager/dao/entity/StreamSourceEntity.java | 3 +
.../dao/entity/StreamSourceFieldEntity.java | 3 +
.../manager/dao/entity/StreamTransformEntity.java | 3 +
.../dao/entity/StreamTransformFieldEntity.java | 3 +
.../dao/entity/ThirdPartyClusterEntity.java | 3 +
.../inlong/manager/dao/entity/UserEntity.java | 3 +
.../inlong/manager/dao/entity/UserRoleEntity.java | 3 +
.../manager/dao/entity/WorkflowApproverEntity.java | 3 +
.../dao/mapper/StreamSourceEntityMapper.java | 8 +--
.../dao/mapper/StreamSourceFieldEntityMapper.java | 10 +--
.../inlong/manager/dao/RestTemplateConfig.java | 3 +
.../manager/dao/config/JDBCSourceConfigTest.java | 3 +
.../dao/mapper/InlongGroupEntityMapperTest.java | 3 +
.../manager/plugin/FlinkSortProcessPlugin.java | 3 +
.../plugin/eventselect/DeleteProcessSelector.java | 3 +
.../plugin/eventselect/RestartProcessSelector.java | 3 +
.../plugin/eventselect/StartupProcessSelector.java | 3 +
.../plugin/eventselect/SuspendProcessSelector.java | 3 +
.../manager/plugin/flink/FlinkOperation.java | 2 +-
.../inlong/manager/plugin/flink/FlinkService.java | 3 +
.../plugin/flink/IntegrationTaskRunner.java | 3 +
.../manager/plugin/flink/TaskRunService.java | 3 +
.../manager/plugin/flink/dto/FlinkConfig.java | 3 +
.../inlong/manager/plugin/flink/dto/FlinkInfo.java | 3 +
.../manager/plugin/flink/dto/JarEntryInfo.java | 3 +
.../manager/plugin/flink/dto/JarFileInfo.java | 3 +
.../manager/plugin/flink/dto/JarListInfo.java | 3 +
.../manager/plugin/flink/dto/JarRunRequest.java | 3 +
.../inlong/manager/plugin/flink/dto/Jars.java | 3 +
.../inlong/manager/plugin/flink/dto/LoginConf.java | 3 +
.../plugin/flink/dto/StopWithSavepointRequest.java | 3 +
.../manager/plugin/flink/enums/Constants.java | 3 +
.../plugin/listener/DeleteSortListener.java | 3 +
.../plugin/listener/RestartSortListener.java | 3 +
.../plugin/listener/StartupSortListener.java | 3 +
.../plugin/listener/SuspendSortListener.java | 3 +
.../inlong/manager/plugin/util/FlinkUtils.java | 36 +++++-----
.../plugin/listener/DeleteSortListenerTest.java | 3 +
.../plugin/listener/RestartSortListenerTest.java | 3 +
.../plugin/listener/StartupSortListenerTest.java | 3 +
.../plugin/listener/SuspendSortListenerTest.java | 3 +
.../inlong/manager/service/core/AuditService.java | 3 +
.../service/core/CommonDBServerService.java | 66 ++++++++++++++++++
.../service/core/CommonFileServerService.java | 78 ++++++++++++++++++++++
.../service/core/DBCollectorTaskService.java | 15 +++++
.../manager/service/core/DataSchemaService.java | 1 -
.../manager/service/core/InlongStreamService.java | 4 +-
.../inlong/manager/service/core/RoleService.java | 1 -
.../service/core/SortClusterConfigService.java | 1 +
.../manager/service/core/SortSourceService.java | 1 +
.../service/core/SortTaskIdParamService.java | 1 +
.../service/core/SortTaskSinkParamService.java | 3 +-
.../service/core/StreamConfigLogService.java | 15 +++++
.../service/core/WorkflowApproverService.java | 3 +-
.../service/core/impl/AgentServiceImpl.java | 29 ++++++--
.../service/core/impl/AuditServiceImpl.java | 9 +--
.../core/impl/CommonDBServerServiceImpl.java | 16 ++++-
.../core/impl/CommonFileServerServiceImpl.java | 16 +++++
.../manager/service/core/impl/SortServiceImpl.java | 4 +-
.../core/impl/SortTaskIdParamServiceImpl.java | 4 +-
.../core/impl/SortTaskSinkParamServiceImpl.java | 4 +-
.../core/impl/StreamConfigLogServiceImpl.java | 15 +++++
.../manager/service/core/impl/UserServiceImpl.java | 2 +-
.../service/core/operationlog/OperationLog.java | 3 +
.../core/operationlog/OperationLogPool.java | 3 +
.../manager/service/core/plugin/JarHell.java | 9 +++
.../service/core/plugin/PluginClassLoader.java | 6 ++
.../service/mq/CreateTubeGroupTaskListener.java | 3 +
.../manager/service/mq/PulsarEventSelector.java | 3 +
.../manager/service/mq/TubeEventSelector.java | 3 +
.../manager/service/mq/TubeMqOptService.java | 3 +
.../manager/service/mq/util/PulsarUtils.java | 9 +++
.../resource/ck/ClickHouseResourceOperator.java | 3 +
.../service/resource/es/ElasticsearchConfig.java | 3 +
.../service/sink/ck/ClickHouseSinkOperation.java | 2 +-
.../service/sink/iceberg/IcebergSinkOperation.java | 3 +
.../service/sort/light/LightGroupSortListener.java | 3 +
.../service/sort/light/LightGroupSortSelector.java | 3 +
.../service/sort/util/ExtractNodeUtils.java | 8 +--
.../service/sort/util/FieldRelationShipUtils.java | 3 +
.../service/sort/util/FilterFunctionUtils.java | 3 +
.../manager/service/sort/util/LoadNodeUtils.java | 3 +
.../service/sort/util/NodeRelationShipUtils.java | 3 +
.../manager/service/sort/util/SinkInfoUtils.java | 3 +
.../manager/service/sort/util/SourceInfoUtils.java | 2 +-
.../service/source/file/FileSourceOperation.java | 3 +
.../listener/AbstractSourceOperateListener.java | 15 +++++
.../source/listener/SourceDeleteEventSelector.java | 3 +
.../source/listener/SourceDeleteListener.java | 3 +
.../listener/SourceRestartEventSelector.java | 3 +
.../source/listener/SourceRestartListener.java | 3 +
.../source/listener/SourceStopEventSelector.java | 3 +
.../source/listener/SourceStopListener.java | 3 +
.../workflow/ServiceTaskListenerFactory.java | 12 ++++
.../service/workflow/WorkflowExecuteLog.java | 3 +
.../light/SuspendLightGroupWorkflowDefinition.java | 3 +
.../listener/light/LightGroupCompleteListener.java | 3 +
.../listener/light/LightGroupFailedListener.java | 3 +
.../listener/light/LightGroupInitListener.java | 3 +
.../light/LightGroupUpdateCompleteListener.java | 3 +
.../light/LightGroupUpdateFailedListener.java | 3 +
.../listener/light/LightGroupUpdateListener.java | 3 +
.../inlong/manager/service/RestTemplateConfig.java | 3 +
.../inlong/manager/service/ServiceBaseTest.java | 3 +
.../service/core/impl/AgentServiceTest.java | 6 ++
.../service/core/impl/AuditServiceTest.java | 3 +
.../service/core/impl/HeartbeatServiceTest.java | 3 +
.../core/impl/InlongGroupProcessOperationTest.java | 6 ++
.../service/core/impl/SortServiceImplTest.java | 13 ++--
.../manager/service/core/plugin/JarHellTest.java | 3 +
.../service/core/plugin/PluginClassLoaderTest.java | 3 +
.../service/core/plugin/PluginServiceTest.java | 3 +
.../core/sink/ClickHouseStreamSinkServiceTest.java | 6 ++
.../core/sink/HiveStreamSinkServiceTest.java | 3 +
.../core/sink/IcebergStreamSinkServiceTest.java | 6 ++
.../core/sink/KafkaStreamSinkServiceTest.java | 6 ++
.../core/source/StreamSourceServiceTest.java | 3 +
.../service/mocks/MockDeleteSortListener.java | 3 +
.../service/mocks/MockDeleteSourceListener.java | 3 +
.../inlong/manager/service/mocks/MockPlugin.java | 3 +
.../service/mocks/MockRestartSortListener.java | 3 +
.../service/mocks/MockRestartSourceListener.java | 3 +
.../service/mocks/MockStopSortListener.java | 3 +
.../service/mocks/MockStopSourceListener.java | 3 +
.../manager/service/mq/util/PulsarUtilsTest.java | 3 +
.../manager/service/sort/DisableZkForSortTest.java | 9 +++
.../source/listener/DataSourceListenerTest.java | 3 +
.../transform/StreamTransformServiceTest.java | 3 +
.../workflow/ServiceTaskListenerFactoryTest.java | 3 +
.../service/workflow/WorkflowServiceImplTest.java | 3 +
.../group/CreateGroupWorkflowDefinitionTest.java | 3 +
.../org/apache/inlong/manager/test/BaseTest.java | 3 +
.../manager/web/auth/AuthenticationFilter.java | 3 +
.../inlong/manager/web/auth/ShiroConfig.java | 3 +
.../manager/web/auth/WebAuthorizingRealm.java | 10 +--
.../manager/web/auth/impl/InlongShiroImpl.java | 3 +
.../web/config/ControllerExceptionHandler.java | 3 +
.../manager/web/controller/AnnoController.java | 3 +
.../manager/web/controller/AuditController.java | 3 +
.../web/controller/CommonDBServerController.java | 3 +
.../web/controller/CommonFileServerController.java | 3 +
.../web/controller/HeartbeatController.java | 3 +
.../controller/StreamConfigLogWebController.java | 3 +
.../web/controller/openapi/AgentController.java | 3 +
.../controller/openapi/DBCollectorController.java | 3 +
.../controller/openapi/DataProxyController.java | 3 +
.../openapi/OpenHeartbeatController.java | 3 +
.../web/controller/openapi/SortController.java | 3 +
.../openapi/StreamConfigLogController.java | 3 +
.../manager/web/config/RestTemplateConfigTest.java | 3 +
.../web/controller/openapi/SortControllerTest.java | 3 +
.../workflow/definition/WorkflowProcess.java | 24 +++++++
.../manager/workflow/definition/WorkflowTask.java | 15 +++++
.../event/EventListenerManagerFactory.java | 9 +++
.../manager/workflow/event/ListenerResult.java | 31 +++++++++
.../workflow/event/LogableEventListener.java | 3 +
.../event/task/DataSourceOperateListener.java | 3 +
.../event/task/LogableTaskEventListener.java | 2 +-
.../workflow/event/task/QueueOperateListener.java | 3 +
.../workflow/event/task/SinkOperateListener.java | 3 +
.../workflow/event/task/SortOperateListener.java | 3 +
.../inlong/manager/workflow/plugin/Plugin.java | 3 +
.../manager/workflow/plugin/PluginBinder.java | 3 +
.../manager/workflow/plugin/ProcessPlugin.java | 3 +
331 files changed, 1311 insertions(+), 138 deletions(-)
diff --git a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/AutoPush2HiveExample.java b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/AutoPush2HiveExample.java
index c18c3f0f5..88339ad2c 100644
--- a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/AutoPush2HiveExample.java
+++ b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/AutoPush2HiveExample.java
@@ -45,6 +45,9 @@ import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
+/**
+ * Test class for auto push to hive.
+ */
public class AutoPush2HiveExample {
// Manager web url
diff --git a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Binlog2KafkaExample.java b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Binlog2KafkaExample.java
index e0156b92b..2533135fd 100644
--- a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Binlog2KafkaExample.java
+++ b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Binlog2KafkaExample.java
@@ -42,6 +42,9 @@ import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
+/**
+ * Test class for binlog to kafka.
+ */
@Slf4j
public class Binlog2KafkaExample {
diff --git a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/File2HiveExample.java b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/File2HiveExample.java
index 877004455..cf079271c 100644
--- a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/File2HiveExample.java
+++ b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/File2HiveExample.java
@@ -45,6 +45,9 @@ import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
+/**
+ * Test class for file to hive.
+ */
public class File2HiveExample {
// Manager web url
diff --git a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Kafka2HiveExample.java b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Kafka2HiveExample.java
index fcc58a6dc..f0e1a254f 100644
--- a/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Kafka2HiveExample.java
+++ b/inlong-manager/manager-client-examples/src/test/java/org/apache/inlong/manager/client/Kafka2HiveExample.java
@@ -47,6 +47,9 @@ import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
+/**
+ * Test class for kafka to hive.
+ */
@Slf4j
public class Kafka2HiveExample {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandBase.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandBase.java
index c9a03cc3e..572eca597 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandBase.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandBase.java
@@ -21,6 +21,9 @@ import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.ParameterException;
+/**
+ * Class for parse command.
+ */
abstract class CommandBase {
protected final JCommander jcommander;
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandCreate.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandCreate.java
index e79f727c5..f34967eed 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandCreate.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandCreate.java
@@ -26,6 +26,9 @@ import org.apache.inlong.manager.client.api.InlongStreamBuilder;
import java.io.File;
+/**
+ * Create resource by json file.
+ */
@Parameters(commandDescription = "Create resource by json file")
public class CommandCreate extends CommandBase {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandDescribe.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandDescribe.java
index c65e17a8b..6390e7a16 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandDescribe.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandDescribe.java
@@ -29,6 +29,9 @@ import org.apache.inlong.manager.common.pojo.stream.FullStreamResponse;
import java.util.List;
+/**
+ * Get commond describe info of resources.
+ */
@Parameters(commandDescription = "Display details of one or more resources")
public class CommandDescribe extends CommandBase {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandList.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandList.java
index 7b88353c0..48b7afaed 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandList.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandList.java
@@ -38,6 +38,9 @@ import org.apache.inlong.manager.common.pojo.stream.InlongStreamInfo;
import java.util.ArrayList;
import java.util.List;
+/**
+ * Get main infomation of resources.
+ */
@Parameters(commandDescription = "Displays main information for one or more resources")
public class CommandList extends CommandBase {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandToolMain.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandToolMain.java
index fba20df50..bc07c8546 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandToolMain.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandToolMain.java
@@ -24,6 +24,9 @@ import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
+/**
+ * Command tool main.
+ */
public class CommandToolMain {
protected final Map<String, Class<?>> commandMap = new HashMap<>();
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandUtil.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandUtil.java
index 130468e1d..c79d4cbb0 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandUtil.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CommandUtil.java
@@ -34,6 +34,9 @@ import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Properties;
+/**
+ * Util of command for creat connect by config file.
+ */
abstract class CommandUtil {
private static final String CONFIG_FILE = "application.properties";
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CreateGroupConf.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CreateGroupConf.java
index 824ec10b7..8a647fa88 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CreateGroupConf.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/CreateGroupConf.java
@@ -26,6 +26,9 @@ import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import java.util.List;
+/**
+ * The config of group, including stream config, stream source, stream sink, etc.
+ */
@Data
public class CreateGroupConf {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/converter/FileConverter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/converter/FileConverter.java
index 95c4bdbbe..906a87cff 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/converter/FileConverter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/converter/FileConverter.java
@@ -21,6 +21,9 @@ import com.beust.jcommander.IStringConverter;
import java.io.File;
+/**
+ * File converter.
+ */
public class FileConverter implements IStringConverter<File> {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/GroupInfo.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/GroupInfo.java
index bd3f63bcd..37db1666d 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/GroupInfo.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/GroupInfo.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.client.api.InlongGroupContext.InlongGroupStatus
import java.util.Date;
+/**
+ * Group info, including inlong group id, inlong group name, etc.
+ */
@Data
public class GroupInfo {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SinkInfo.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SinkInfo.java
index 609a550b6..b8c48b136 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SinkInfo.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SinkInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.Date;
+/**
+ * Sink info, including sink type, sink name, etc.
+ */
@Data
public class SinkInfo {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SourceInfo.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SourceInfo.java
index 3d89e7f94..ab62eae42 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SourceInfo.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/SourceInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.Date;
+/**
+ * Source info, including source type, source name, etc.
+ */
@Data
public class SourceInfo {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/StreamInfo.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/StreamInfo.java
index e94db2fe4..5a59950af 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/StreamInfo.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/pojo/StreamInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.Date;
+/**
+ * Stream info, including stream name, data type, data encoding, etc.
+ */
@Data
public class StreamInfo {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/CharsetAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/CharsetAdapter.java
index 463592182..3eaa15336 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/CharsetAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/CharsetAdapter.java
@@ -25,6 +25,9 @@ import com.google.gson.JsonParseException;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
+/**
+ * Charset adapter.
+ */
public class CharsetAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/DataFormatAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/DataFormatAdapter.java
index a82da52b3..7524ca600 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/DataFormatAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/DataFormatAdapter.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.enums.DataFormat;
import java.lang.reflect.Type;
+/**
+ * Data format adapter.
+ */
public class DataFormatAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/GsonUtil.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/GsonUtil.java
index eba5a5d60..21cd557fa 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/GsonUtil.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/GsonUtil.java
@@ -28,6 +28,9 @@ import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import java.nio.charset.Charset;
+/**
+ * Util of gson for register each type of adapter, such as charsetAdapter, streamSourceAdapter, etc.
+ */
public class GsonUtil {
public static Gson gsonBuilder() {
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/MQBaseConfAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/MQBaseConfAdapter.java
index 27162fe72..796706507 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/MQBaseConfAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/MQBaseConfAdapter.java
@@ -30,6 +30,9 @@ import org.apache.inlong.manager.client.api.TubeBaseConf;
import java.lang.reflect.Type;
+/**
+ * MQ base config adapter.
+ */
public class MQBaseConfAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SeparatorAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SeparatorAdapter.java
index fcf2b8a15..6fe712cbb 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SeparatorAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SeparatorAdapter.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.client.api.DataSeparator;
import java.lang.reflect.Type;
+/**
+ * Separator adapter.
+ */
public class SeparatorAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SortBaseConfAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SortBaseConfAdapter.java
index 507d30b62..164ae628e 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SortBaseConfAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/SortBaseConfAdapter.java
@@ -29,6 +29,9 @@ import org.apache.inlong.manager.client.api.UserDefinedSortConf;
import java.lang.reflect.Type;
+/**
+ * Sort base config adapter.
+ */
public class SortBaseConfAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSinkAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSinkAdapter.java
index 8f2b69242..f1351051f 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSinkAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSinkAdapter.java
@@ -31,6 +31,9 @@ import org.apache.inlong.manager.common.enums.SinkType;
import java.lang.reflect.Type;
+/**
+ * Stream sink adapter.
+ */
public class StreamSinkAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSourceAdapter.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSourceAdapter.java
index ee7dcb52a..bbf7f613d 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSourceAdapter.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/util/StreamSourceAdapter.java
@@ -31,6 +31,9 @@ import org.apache.inlong.manager.common.enums.SourceType;
import java.lang.reflect.Type;
+/**
+ * Stream source adapter.
+ */
public class StreamSourceAdapter implements JsonDeserializer {
@Override
diff --git a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/validator/GroupStatus.java b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/validator/GroupStatus.java
index 0f4ea0114..63782434b 100644
--- a/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/validator/GroupStatus.java
+++ b/inlong-manager/manager-client-tools/src/main/java/org/apache/inlong/manager/client/cli/validator/GroupStatus.java
@@ -22,6 +22,9 @@ import com.beust.jcommander.ParameterException;
import org.apache.commons.lang3.EnumUtils;
import org.apache.inlong.manager.client.api.InlongGroupContext.InlongGroupStatus;
+/**
+ * Class for inlong group status verification.
+ */
public class GroupStatus implements IParameterValidator {
@Override
diff --git a/inlong-manager/manager-client-tools/src/test/java/org/apache/inlong/manager/client/cli/TestCommand.java b/inlong-manager/manager-client-tools/src/test/java/org/apache/inlong/manager/client/cli/TestCommand.java
index e41937a42..83129af93 100644
--- a/inlong-manager/manager-client-tools/src/test/java/org/apache/inlong/manager/client/cli/TestCommand.java
+++ b/inlong-manager/manager-client-tools/src/test/java/org/apache/inlong/manager/client/cli/TestCommand.java
@@ -21,6 +21,9 @@ import lombok.extern.slf4j.Slf4j;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Command service test for {@link CommandToolMain}
+ */
@Slf4j
public class TestCommand {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/FlinkSortBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/FlinkSortBaseConf.java
index e65150423..6583f7214 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/FlinkSortBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/FlinkSortBaseConf.java
@@ -26,6 +26,9 @@ import org.apache.inlong.manager.client.api.auth.Authentication;
import java.util.Map;
+/**
+ * Flink sort base config.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Base configuration for flink cluster")
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongClient.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongClient.java
index 28012fab4..a510f8ca3 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongClient.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongClient.java
@@ -78,9 +78,9 @@ public interface InlongClient {
/**
* List group state
*
- * @param groupNames
- * @return
- * @throws Exception
+ * @param groupNames inlong group name list
+ * @return map of inlong group status list
+ * @throws Exception the exception
*/
Map<String, InlongGroupStatus> listGroupState(List<String> groupNames) throws Exception;
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroup.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroup.java
index e031b634e..ba6c1bb45 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroup.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroup.java
@@ -31,8 +31,8 @@ public interface InlongGroup {
/**
* Create snapshot for Inlong group
*
- * @return
- * @throws Exception
+ * @return inlong group context
+ * @throws Exception the exception
*/
InlongGroupContext context() throws Exception;
@@ -48,8 +48,7 @@ public interface InlongGroup {
/**
* Update Inlong group on updated conf
*
- * @return
- * @throws Exception
+ * @throws Exception the exception
*/
void update(InlongGroupConf conf) throws Exception;
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupConf.java
index ae2910192..e96174cc5 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupConf.java
@@ -23,6 +23,9 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
+/**
+ * Inlong group config.
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupContext.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupContext.java
index cd85ad250..ebfed2cd6 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupContext.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongGroupContext.java
@@ -37,6 +37,9 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
+/**
+ * Inlong group context.
+ */
@Data
@Slf4j
public class InlongGroupContext implements Serializable {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStream.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStream.java
index e1869311e..2dc87bf43 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStream.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStream.java
@@ -26,127 +26,89 @@ import org.apache.inlong.manager.common.pojo.stream.StreamTransform;
import java.util.List;
import java.util.Map;
+/**
+ * Inlong stream.
+ */
public abstract class InlongStream {
/**
* Return name of stream.
- *
- * @return
*/
public abstract String getName();
/**
* Return field definitions of stream.
- *
- * @return
*/
public abstract List<StreamField> listFields();
/**
* Return data sources defined in stream, key is source name which must be unique within one stream scope.
- *
- * @return
*/
public abstract Map<String, StreamSource> getSources();
/**
* Return data sinks defined in stream, key is sink name which must be unique within one stream scope.
- *
- * @return
*/
public abstract Map<String, StreamSink> getSinks();
/**
* Return data transform node defined in stream(split,string replace etc)
* key is transform name which must be unique within one stream scope.
- *
- * @return
*/
public abstract Map<String, StreamTransform> getTransforms();
/**
* Add data source to stream, this method will throw exception when source name already exists in stream.
- *
- * @param source
- * @return
*/
public abstract InlongStream addSource(StreamSource source);
/**
* Add data sink to stream, this method will throw exception when sink name already exists in stream.
- *
- * @param sink
- * @return
*/
public abstract InlongStream addSink(StreamSink sink);
/**
* Add data transform node to stream, this method will throw exception when transform name already exists in stream.
- *
- * @param transform
- * @return
*/
public abstract InlongStream addTransform(StreamTransform transform);
/**
* Delete data source by source name.
- *
- * @param sourceName
- * @return
*/
public abstract InlongStream deleteSource(String sourceName);
/**
* Delete data sink by sink name.
- *
- * @param sinkName
- * @return
*/
public abstract InlongStream deleteSink(String sinkName);
/**
* Delete data transform node by transform name.
- *
- * @param transformName
- * @return
*/
public abstract InlongStream deleteTransform(String transformName);
/**
* Update data source by source name, add new one if source name not exists.
- *
- * @param source
- * @return
*/
public abstract InlongStream updateSource(StreamSource source);
/**
* Update data sink by sink name, add new one if sink name not exists.
- *
- * @param sink
- * @return
*/
public abstract InlongStream updateSink(StreamSink sink);
/**
* Update data transform node by transform name, add new one if transform name not exists.
- *
- * @param transform
- * @return
*/
public abstract InlongStream updateTransform(StreamTransform transform);
/**
* Create stream pipeline by sources, transforms, sinks defined in stream.
- *
- * @return
*/
public abstract StreamPipeline createPipeline();
/**
* Update stream definition in manager service, which must be invoked after add/delete/update source/sink/transform.
- *
- * @return
*/
public abstract InlongStream update();
}
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamBuilder.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamBuilder.java
index 803164ed1..1c7bd0d07 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamBuilder.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamBuilder.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.common.pojo.stream.StreamTransform;
import java.util.List;
+/**
+ * Inlong stream builder.
+ */
public abstract class InlongStreamBuilder {
/**
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamConf.java
index 8d7065c2f..cfc2dc09a 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/InlongStreamConf.java
@@ -28,6 +28,9 @@ import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.List;
+/**
+ * Inlong stream config.
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/MQBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/MQBaseConf.java
index 950e2ee51..83e7b8334 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/MQBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/MQBaseConf.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.common.enums.MQType;
import java.io.Serializable;
+/**
+ * MQ base config.
+ */
@Data
@ApiModel("Base configuration for message queue")
public abstract class MQBaseConf implements Serializable {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/PulsarBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/PulsarBaseConf.java
index bce79e37b..391c09622 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/PulsarBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/PulsarBaseConf.java
@@ -26,6 +26,9 @@ import lombok.NoArgsConstructor;
import org.apache.inlong.manager.client.api.auth.Authentication;
import org.apache.inlong.manager.common.enums.MQType;
+/**
+ * Base configuration for Pulsar.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/SortBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/SortBaseConf.java
index 608870d98..1e66e3956 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/SortBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/SortBaseConf.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.client.api;
import io.swagger.annotations.ApiModel;
import lombok.Data;
+/**
+ * Sort configuration for inlong group.
+ */
@Data
@ApiModel("Sort configuration for inlong group")
public abstract class SortBaseConf {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TdmqPulsarBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TdmqPulsarBaseConf.java
index 151df13e0..e88c51ede 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TdmqPulsarBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TdmqPulsarBaseConf.java
@@ -24,6 +24,9 @@ import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import org.apache.inlong.manager.common.enums.MQType;
+/**
+ * Tdmq Pulsar base config.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TubeBaseConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TubeBaseConf.java
index fc0934d39..8be92ad1e 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TubeBaseConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/TubeBaseConf.java
@@ -25,6 +25,9 @@ import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import org.apache.inlong.manager.common.enums.MQType;
+/**
+ * Base configuration for Tube.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/UserDefinedSortConf.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/UserDefinedSortConf.java
index 8bb09a51e..ffcc3144a 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/UserDefinedSortConf.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/UserDefinedSortConf.java
@@ -25,6 +25,9 @@ import lombok.EqualsAndHashCode;
import java.util.Map;
+/**
+ * Base configuration for user defined sort functions.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Base configuration for user defined sort functions")
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/DefaultAuthentication.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/DefaultAuthentication.java
index e6ddf66d9..fa8fe5426 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/DefaultAuthentication.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/DefaultAuthentication.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.client.api.util.AssertUtil;
import java.util.Map;
+/**
+ * Default authentication.
+ */
@NoArgsConstructor
public class DefaultAuthentication implements Authentication {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretAuthentication.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretAuthentication.java
index 6d46e6ef6..1fd8ff6af 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretAuthentication.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretAuthentication.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.client.api.util.AssertUtil;
import java.util.Map;
+/**
+ * Secret authentication.
+ */
@NoArgsConstructor
public class SecretAuthentication implements Authentication {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretTokenAuthentication.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretTokenAuthentication.java
index 0837b023d..d69dd6bd7 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretTokenAuthentication.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/SecretTokenAuthentication.java
@@ -24,6 +24,9 @@ import lombok.SneakyThrows;
import java.util.Map;
+/**
+ * Secret token authentication.
+ */
@NoArgsConstructor
public class SecretTokenAuthentication extends SecretAuthentication {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/TokenAuthentication.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/TokenAuthentication.java
index cd63bed24..953730509 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/TokenAuthentication.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/auth/TokenAuthentication.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.client.api.util.AssertUtil;
import java.util.Map;
+/**
+ * Token authentication.
+ */
@NoArgsConstructor
public class TokenAuthentication implements Authentication {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/BlankInlongGroup.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/BlankInlongGroup.java
index bfb470fc7..72dd0071d 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/BlankInlongGroup.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/BlankInlongGroup.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.client.api.SortBaseConf;
import java.util.List;
+/**
+ * Check inlong group if is exist.
+ */
public class BlankInlongGroup implements InlongGroup {
@Override
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/DefaultInlongStreamBuilder.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/DefaultInlongStreamBuilder.java
index f3bd61cae..020959f0b 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/DefaultInlongStreamBuilder.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/DefaultInlongStreamBuilder.java
@@ -50,6 +50,9 @@ import org.apache.inlong.manager.common.pojo.transform.TransformResponse;
import java.util.List;
import java.util.Map;
+/**
+ * Default inlong stream builder.
+ */
public class DefaultInlongStreamBuilder extends InlongStreamBuilder {
private InlongStreamImpl inlongStream;
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongClientImpl.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongClientImpl.java
index a87710612..c55d24b3a 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongClientImpl.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongClientImpl.java
@@ -44,6 +44,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Inlong client service implementation.
+ */
@Slf4j
public class InlongClientImpl implements InlongClient {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongGroupImpl.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongGroupImpl.java
index c2d13e9bf..44b74b930 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongGroupImpl.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongGroupImpl.java
@@ -55,6 +55,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Inlong group service implementation.
+ */
public class InlongGroupImpl implements InlongGroup {
private InlongGroupConf groupConf;
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongStreamImpl.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongStreamImpl.java
index ebfba5909..ff2d5e312 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongStreamImpl.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/InlongStreamImpl.java
@@ -57,6 +57,9 @@ import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
+/**
+ * Inlong stream service implementation.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
public class InlongStreamImpl extends InlongStream {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/LowLevelInlongClientImpl.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/LowLevelInlongClientImpl.java
index 806bcc7bb..72d146bff 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/LowLevelInlongClientImpl.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/impl/LowLevelInlongClientImpl.java
@@ -32,6 +32,9 @@ import org.apache.inlong.manager.common.util.HttpUtils;
import java.util.Map;
+/**
+ * Low level inlong client service implementation.
+ */
@Slf4j
public class LowLevelInlongClientImpl implements LowLevelInlongClient {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerGroupContext.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerGroupContext.java
index dfe0290b5..c85d9dbab 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerGroupContext.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerGroupContext.java
@@ -32,6 +32,9 @@ import org.apache.inlong.manager.common.pojo.stream.InlongStreamApproveRequest;
import java.util.List;
import java.util.Map;
+/**
+ * InnerGroupContext.
+ */
@Data
@NoArgsConstructor
public class InnerGroupContext {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerStreamContext.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerStreamContext.java
index 86220b5dc..dd385f841 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerStreamContext.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/inner/InnerStreamContext.java
@@ -29,6 +29,9 @@ import org.apache.inlong.manager.common.pojo.transform.TransformRequest;
import java.util.List;
import java.util.Map;
+/**
+ * InnerStreamContext.
+ */
@Data
@NoArgsConstructor
public class InnerStreamContext {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/ClickHouseSink.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/ClickHouseSink.java
index 553e01f94..20f7cdbcf 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/ClickHouseSink.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/ClickHouseSink.java
@@ -31,6 +31,9 @@ import org.apache.inlong.manager.common.enums.SinkType;
import java.util.List;
+/**
+ * ClickHouse sink.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/HiveSink.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/HiveSink.java
index ba166ffd9..912e8be7e 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/HiveSink.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/HiveSink.java
@@ -36,6 +36,9 @@ import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.List;
+/**
+ * Hive sink.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/KafkaSink.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/KafkaSink.java
index b54bb14c8..6ae542b49 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/KafkaSink.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/sink/KafkaSink.java
@@ -30,6 +30,9 @@ import org.apache.inlong.manager.common.enums.SinkType;
import java.util.List;
+/**
+ * Kafka sink.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AgentFileSource.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AgentFileSource.java
index 095086152..3fb83c79d 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AgentFileSource.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AgentFileSource.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.common.enums.DataFormat;
import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import org.apache.inlong.manager.common.enums.SourceType;
+/**
+ * Agent file source.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AutoPushSource.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AutoPushSource.java
index 53562ef28..af3179653 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AutoPushSource.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/AutoPushSource.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.common.enums.DataFormat;
import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import org.apache.inlong.manager.common.enums.SourceType;
+/**
+ * Agent push source.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/KafkaSource.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/KafkaSource.java
index 2b9c1dcf6..e68bc8a89 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/KafkaSource.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/KafkaSource.java
@@ -28,6 +28,9 @@ import org.apache.inlong.manager.common.pojo.source.kafka.KafkaOffset;
import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import org.apache.inlong.manager.common.enums.SourceType;
+/**
+ * Kafka source.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLBinlogSource.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLBinlogSource.java
index 0e06580ac..efea2838f 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLBinlogSource.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLBinlogSource.java
@@ -30,6 +30,9 @@ import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import java.util.List;
+/**
+ * MySQL binlog source.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLSource.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLSource.java
index eba051f09..e205acfda 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLSource.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/source/MySQLSource.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.common.enums.DataFormat;
import org.apache.inlong.manager.common.pojo.stream.StreamSource;
import org.apache.inlong.manager.common.enums.SourceType;
+/**
+ * MySQL source.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/MultiDependencyTransform.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/MultiDependencyTransform.java
index 14d4abf67..46d5e4a65 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/MultiDependencyTransform.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/MultiDependencyTransform.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.common.pojo.transform.TransformDefinition;
import java.util.List;
+/**
+ * StreamTransform with multiple pre stream nodes, such as join.
+ */
@ApiModel("StreamTransform with multiple pre stream nodes, such as join")
public class MultiDependencyTransform extends StreamTransform {
diff --git a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/SingleDependencyTransform.java b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/SingleDependencyTransform.java
index 0a353e3b1..61c58a2c2 100644
--- a/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/SingleDependencyTransform.java
+++ b/inlong-manager/manager-client/src/main/java/org/apache/inlong/manager/client/api/transform/SingleDependencyTransform.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.common.pojo.stream.StreamTransform;
import org.apache.inlong.manager.client.api.util.AssertUtil;
import org.apache.inlong.manager.common.pojo.transform.TransformDefinition;
+/**
+ * StreamTransform with one pre stream node, such as filter, splitter, etc.
+ */
@ApiModel("StreamTransform with one pre stream node, such as filter, splitter, etc")
public class SingleDependencyTransform extends StreamTransform {
diff --git a/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InlongStreamImplTest.java b/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InlongStreamImplTest.java
index 14e660c23..175f69c99 100644
--- a/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InlongStreamImplTest.java
+++ b/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InlongStreamImplTest.java
@@ -37,6 +37,9 @@ import org.assertj.core.util.Lists;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Test class for creat inlong stream.
+ */
public class InlongStreamImplTest {
@Test
diff --git a/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InnerInlongManagerClientTest.java b/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InnerInlongManagerClientTest.java
index 3c51ea383..e0b843311 100644
--- a/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InnerInlongManagerClientTest.java
+++ b/inlong-manager/manager-client/src/test/java/org/apache/inlong/manager/client/api/impl/InnerInlongManagerClientTest.java
@@ -27,6 +27,9 @@ import org.junit.Test;
import java.util.List;
+/**
+ * Test class for get stream info list.
+ */
@Slf4j
public class InnerInlongManagerClientTest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ClusterBean.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ClusterBean.java
index 56297555b..ad4e3e063 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ClusterBean.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ClusterBean.java
@@ -21,6 +21,9 @@ import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
+/**
+ * Cluster bean, including default tenant, app name, etc.
+ */
@Data
@Component
public class ClusterBean {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ReTryConfigBean.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ReTryConfigBean.java
index c9fa1ab2f..13345c385 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ReTryConfigBean.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/beans/ReTryConfigBean.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.beans;
import lombok.Data;
import org.springframework.stereotype.Component;
+/**
+ * Re try config bean, including max attempts, delay, max delay, multiplier.
+ */
@Data
@Component
public class ReTryConfigBean {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionHandle.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionHandle.java
index c34e5f144..b8ef4120d 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionHandle.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionHandle.java
@@ -22,6 +22,9 @@ import java.util.Map;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
+/**
+ * Unit conversion handle.
+ */
@Slf4j
@Component
public class ConversionHandle {
@@ -40,6 +43,9 @@ public class ConversionHandle {
unitMap.put("mb_mb", new MBToMB());
}
+ /**
+ * Unit conversion handle.
+ */
public Integer handleConversion(Integer value, String type) {
if (unitMap == null) {
this.loadStrategy();
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStatusContext.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStatusContext.java
index f502c5e2d..be8df7112 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStatusContext.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStatusContext.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Conversion status context.
+ */
public class ConversionStatusContext {
private final ConversionStrategy conversionStrategy;
@@ -25,6 +28,9 @@ public class ConversionStatusContext {
this.conversionStrategy = conversionStrategy;
}
+ /**
+ * Excute unit conversion.
+ */
public Integer executeConversion(Integer value) {
return conversionStrategy.unitConversion(value);
}
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStrategy.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStrategy.java
index fdd263d53..f524cccda 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStrategy.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/ConversionStrategy.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Conversion strategy.
+ */
public interface ConversionStrategy {
Integer unitConversion(Integer value);
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToMinute.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToMinute.java
index 658bb1cd9..c90f73282 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToMinute.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToMinute.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Convert days to minute.
+ */
public class DaysToMinute implements ConversionStrategy {
@Override
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToSeconds.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToSeconds.java
index a2344746b..ff60dca5a 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToSeconds.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/DaysToSeconds.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Convert days to seconds.
+ */
public class DaysToSeconds implements ConversionStrategy {
@Override
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/GBToMB.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/GBToMB.java
index c513e5456..714d5920d 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/GBToMB.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/GBToMB.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.common.conversion;
import org.springframework.stereotype.Component;
+/**
+ * Convert GB to MB.
+ */
@Component
public class GBToMB implements ConversionStrategy {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToMinute.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToMinute.java
index 4d76e4ebe..8d6db8358 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToMinute.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToMinute.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.common.conversion;
import org.springframework.stereotype.Component;
+/**
+ * Convert hours to minute.
+ */
@Component
public class HoursToMinute implements ConversionStrategy {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToSeconds.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToSeconds.java
index 781d0695c..2ed48ae1d 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToSeconds.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/HoursToSeconds.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.common.conversion;
import org.springframework.stereotype.Component;
+/**
+ * Convert hours to seconds.
+ */
@Component
public class HoursToSeconds implements ConversionStrategy {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/MBToMB.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/MBToMB.java
index 4a5c3f9a8..d4fad0bdc 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/MBToMB.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/MBToMB.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Convert MB to MB.
+ */
public class MBToMB implements ConversionStrategy {
@Override
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/SecondsToSeconds.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/SecondsToSeconds.java
index 75c95da6d..cfe07fa27 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/SecondsToSeconds.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/SecondsToSeconds.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Convert seconds to seconds.
+ */
public class SecondsToSeconds implements ConversionStrategy {
@Override
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/TBToMB.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/TBToMB.java
index c7f527ef8..07f198d66 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/TBToMB.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/conversion/TBToMB.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.conversion;
+/**
+ * Convert TB to TB.
+ */
public class TBToMB implements ConversionStrategy {
@Override
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ApplicationEnv.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ApplicationEnv.java
index 8cfc1f7c7..ff561eb51 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ApplicationEnv.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ApplicationEnv.java
@@ -49,6 +49,9 @@ public enum ApplicationEnv {
Function.identity()
);
+ /**
+ * Get application environment by name.
+ */
public static ApplicationEnv forName(String name) {
String nameUpper = StringUtils.upperCase(name);
if (!NAME_MAP.containsKey(nameUpper)) {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/DataFormat.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/DataFormat.java
index af1fa0f6d..6ae1cf133 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/DataFormat.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/DataFormat.java
@@ -39,6 +39,9 @@ public enum DataFormat {
this.name = name;
}
+ /**
+ * Get dataformat for inlong by name.
+ */
public static DataFormat forName(String name) {
for (DataFormat dataFormat : values()) {
if (dataFormat.getName().equals(name.toLowerCase(Locale.ROOT))) {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BaseException.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BaseException.java
index 5824bb1cb..58a9dab3b 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BaseException.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BaseException.java
@@ -21,6 +21,9 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
+/**
+ * Base exception.
+ */
@Data
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BusinessException.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BusinessException.java
index aac5cd066..beea8bc05 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BusinessException.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/exceptions/BusinessException.java
@@ -22,6 +22,9 @@ import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
+/**
+ * Business exception.
+ */
@Data
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditInfo.java
index 1fdfa95b3..9dc150e4a 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditInfo.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.pojo.audit;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
+/**
+ * Audit info, including audit count, audit log timestamp.
+ */
@Data
public class AuditInfo {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditRequest.java
index dad983183..555bf477e 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditRequest.java
@@ -27,6 +27,9 @@ import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import java.util.List;
+/**
+ * The request info of audit.
+ */
@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel("Audit query request")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditVO.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditVO.java
index 2584085d4..cb12b5fcd 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditVO.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/audit/AuditVO.java
@@ -21,6 +21,9 @@ import io.swagger.annotations.ApiModelProperty;
import java.util.List;
import lombok.Data;
+/**
+ * The VO of audit.
+ */
@Data
public class AuditVO {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonDbServerInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonDbServerInfo.java
index 4de29b71c..bb9e179c4 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonDbServerInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonDbServerInfo.java
@@ -25,6 +25,9 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
+/**
+ * Common database server info, including connetion name, database type, etc.
+ */
@Data
@Builder
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonFileServerListVo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonFileServerListVo.java
index 9dfdc4b75..8a2454c0d 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonFileServerListVo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/commonserver/CommonFileServerListVo.java
@@ -25,6 +25,9 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
+/**
+ * The VO of common file server list.
+ */
@Data
@Builder
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/dataproxy/DataProxyResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/dataproxy/DataProxyResponse.java
index 6dd8e25dc..9eb8dc57c 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/dataproxy/DataProxyResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/dataproxy/DataProxyResponse.java
@@ -21,6 +21,9 @@ import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
+/**
+ * The response info of ata proxy.
+ */
@Data
@ApiModel("DataProxy response")
public class DataProxyResponse {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/DataSchemaInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/DataSchemaInfo.java
index abaf6726b..4f3ad5e31 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/DataSchemaInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/DataSchemaInfo.java
@@ -23,7 +23,6 @@ import lombok.Data;
/**
* Data schema info
- *
*/
@Data
@ApiModel("Data schema info")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/InlongGroupResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/InlongGroupResponse.java
index aaf83fa26..1fc5b82b2 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/InlongGroupResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/group/InlongGroupResponse.java
@@ -29,6 +29,9 @@ import javax.validation.constraints.NotNull;
import java.util.Date;
import java.util.List;
+/**
+ * The response info of inlong group.
+ */
@Data
@Builder
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/pulsar/PulsarTopicBean.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/pulsar/PulsarTopicBean.java
index 69d1d6e55..d7b902cb3 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/pulsar/PulsarTopicBean.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/pulsar/PulsarTopicBean.java
@@ -22,6 +22,9 @@ import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
+/**
+ * Pulsar topic bean, including tenant, namespace, etc.
+ */
@Data
@Builder
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseColumnInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseColumnInfo.java
index ce46fac1d..c3a8ae20e 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseColumnInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseColumnInfo.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.common.pojo.sink.ck;
import lombok.Data;
+/**
+ * ClickHouse column info.
+ */
@Data
public class ClickHouseColumnInfo {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseTableInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseTableInfo.java
index b26ba7b53..25e806b38 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseTableInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/sink/ck/ClickHouseTableInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.List;
+/**
+ * ClickHouse table info.
+ */
@Data
public class ClickHouseTableInfo {
// Basic attributes
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceListResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceListResponse.java
index 860bc1b43..a1c3aab30 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceListResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceListResponse.java
@@ -24,7 +24,7 @@ import lombok.Data;
import java.util.Date;
/**
- * Response of the source list
+ * Response info of the source list
*/
@Data
public class SourceListResponse {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceRequest.java
index 177423797..19ccca4a7 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceRequest.java
@@ -28,7 +28,7 @@ import javax.validation.constraints.NotNull;
import java.util.List;
/**
- * Request of source
+ * Request info of source
*/
@Data
@ApiModel("Request of source")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceResponse.java
index f0a678191..8a5be5858 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/SourceResponse.java
@@ -27,7 +27,7 @@ import java.util.Date;
import java.util.List;
/**
- * Response of the stream source
+ * Response info of the stream source
*/
@Data
@ApiModel("Response of the stream source")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/autopush/AutoPushSourceListResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/autopush/AutoPushSourceListResponse.java
index d619c2d28..68ddeeecd 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/autopush/AutoPushSourceListResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/autopush/AutoPushSourceListResponse.java
@@ -23,6 +23,9 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import org.apache.inlong.manager.common.pojo.source.SourceListResponse;
+/**
+ * Response info of auto push source list.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Response of DataProxy SDK source paging list")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceListResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceListResponse.java
index b5779fab4..8ae188fc9 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceListResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceListResponse.java
@@ -24,7 +24,7 @@ import lombok.EqualsAndHashCode;
import org.apache.inlong.manager.common.pojo.source.SourceListResponse;
/**
- * Response of binlog source list
+ * Response info of binlog source list
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceRequest.java
index a7f0d8ab7..ea31cfcb4 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceRequest.java
@@ -27,7 +27,7 @@ import org.apache.inlong.manager.common.pojo.source.SourceRequest;
import org.apache.inlong.manager.common.util.JsonTypeDefine;
/**
- * Request of the binlog source info
+ * Request info of the binlog source info
*/
@Data
@ToString(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceResponse.java
index ad1b87eaf..a3a2f798c 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/binlog/BinlogSourceResponse.java
@@ -26,7 +26,7 @@ import org.apache.inlong.manager.common.enums.SourceType;
import org.apache.inlong.manager.common.pojo.source.SourceResponse;
/**
- * Response of the binlog source
+ * Response info of the binlog source
*/
@Data
@ToString(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceListResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceListResponse.java
index 33ebff47b..e151884d7 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceListResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceListResponse.java
@@ -25,7 +25,7 @@ import org.apache.inlong.manager.common.enums.SourceType;
import org.apache.inlong.manager.common.pojo.source.SourceListResponse;
/**
- * Response of File source list
+ * Response info of File source list
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceRequest.java
index 69569f22a..121c5dd33 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceRequest.java
@@ -27,7 +27,7 @@ import org.apache.inlong.manager.common.pojo.source.SourceRequest;
import org.apache.inlong.manager.common.util.JsonTypeDefine;
/**
- * Request of File Source Info
+ * Request info of File Source Info
*/
@Data
@ToString(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceResponse.java
index 44edfd3ff..6787a8f0b 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/source/file/FileSourceResponse.java
@@ -26,7 +26,7 @@ import org.apache.inlong.manager.common.enums.SourceType;
import org.apache.inlong.manager.common.pojo.source.SourceResponse;
/**
- * Response of the File source
+ * Response info of the File source
*/
@Data
@ToString(callSuper = true)
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogListResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogListResponse.java
index a0e936426..1f46984b2 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogListResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogListResponse.java
@@ -23,6 +23,9 @@ import lombok.Data;
import java.util.Date;
+/**
+ * Inlong stream config log list response.
+ */
@Data
@ApiModel("Inlong stream config log query response")
public class InlongStreamConfigLogListResponse {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogPageRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogPageRequest.java
index 3ca7587e7..cd37f67c5 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogPageRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogPageRequest.java
@@ -25,6 +25,9 @@ import lombok.EqualsAndHashCode;
import org.apache.inlong.manager.common.beans.PageRequest;
import org.springframework.format.annotation.DateTimeFormat;
+/**
+ * Inlong stream config log page request.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Inlong stream config log query request")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogRequest.java
index 61f99d21f..4122ce195 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamConfigLogRequest.java
@@ -21,6 +21,9 @@ import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
+/**
+ * Inlong stream config log request.
+ */
@Data
@ApiModel("Inlong stream config log")
public class InlongStreamConfigLogRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamResponse.java
index 94cfc9b98..c2dcc511f 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/InlongStreamResponse.java
@@ -28,6 +28,9 @@ import lombok.NoArgsConstructor;
import java.util.Date;
import java.util.List;
+/**
+ * Inlong stream response.
+ */
@Data
@Builder
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/SinkField.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/SinkField.java
index 683ea9c54..97f40e6d7 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/SinkField.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/SinkField.java
@@ -24,6 +24,9 @@ import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import org.apache.inlong.manager.common.enums.FieldType;
+/**
+ * Sink field info.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamField.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamField.java
index 381576015..69b331fba 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamField.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamField.java
@@ -25,6 +25,9 @@ import lombok.NoArgsConstructor;
import org.apache.inlong.manager.common.enums.FieldType;
import org.apache.inlong.manager.common.enums.MetaFieldType;
+/**
+ * Stream filed, including field name, field type, etc.
+ */
@Data
@NoArgsConstructor
@AllArgsConstructor
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNode.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNode.java
index cc0491cdd..39ac2a0b7 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNode.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNode.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.util.Preconditions;
import java.util.List;
import java.util.Set;
+/**
+ * Stream node, including data node name, pre node name, post node name, field list.
+ */
@Data
public class StreamNode {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNodeRelationship.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNodeRelationship.java
index 280e6c0e4..791edb987 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNodeRelationship.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamNodeRelationship.java
@@ -23,6 +23,9 @@ import org.apache.inlong.manager.common.util.Preconditions;
import java.util.Set;
+/**
+ * Stream node relationship info, including input node name list, output node name list.
+ */
@Data
public class StreamNodeRelationship {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamPipeline.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamPipeline.java
index cceedc94e..dd50cbcbd 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamPipeline.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamPipeline.java
@@ -32,6 +32,9 @@ import java.util.Map;
import java.util.Queue;
import java.util.Set;
+/**
+ * Stream pipeline, save stream node relationship list.
+ */
@Data
public class StreamPipeline {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSink.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSink.java
index a11a737fb..a2165f1db 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSink.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSink.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.common.enums.SinkType;
import java.util.List;
import java.util.Map;
+/**
+ * Stream sink configuration, including sink name, properties, etc.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Stream sink configuration")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSource.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSource.java
index 7c111f2e5..04cddd52f 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSource.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamSource.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.enums.DataFormat;
import org.apache.inlong.manager.common.enums.SourceStatus;
import org.apache.inlong.manager.common.enums.SourceType;
+/**
+ * Stream source configuration, including source name, agent ip, etc.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Stream source configuration")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamTransform.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamTransform.java
index 4b0655044..a4b2d09ab 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamTransform.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/stream/StreamTransform.java
@@ -23,6 +23,9 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import org.apache.inlong.manager.common.pojo.transform.TransformDefinition;
+/**
+ * Stream Transform configuration
+ */
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("Stream Transform configuration")
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinition.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinition.java
index 263f17a3f..3f95b314d 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinition.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinition.java
@@ -21,6 +21,9 @@ import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import org.apache.inlong.manager.common.enums.TransformType;
+/**
+ * A class to define operation to transform.
+ */
@Data
public abstract class TransformDefinition {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeConsumeGroupRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeConsumeGroupRequest.java
index cb636ad16..e6315dc70 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeConsumeGroupRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeConsumeGroupRequest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.pojo.tubemq;
import java.util.List;
import lombok.Data;
+/**
+ * The request info of add tube consume group.
+ */
@Data
public class AddTubeConsumeGroupRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeMqTopicRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeMqTopicRequest.java
index e8cce0093..56db8c717 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeMqTopicRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/AddTubeMqTopicRequest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.pojo.tubemq;
import java.util.List;
import lombok.Data;
+/**
+ * The request info of add tube mq topic.
+ */
@Data
public class AddTubeMqTopicRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/QueryTubeTopicRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/QueryTubeTopicRequest.java
index c65c636a1..a51df26d5 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/QueryTubeTopicRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/QueryTubeTopicRequest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.pojo.tubemq;
import lombok.Builder;
import lombok.Data;
+/**
+ * The request info of query tube topic.
+ */
@Data
@Builder
public class QueryTubeTopicRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeClusterResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeClusterResponse.java
index 673cdeeb1..4ee5ac577 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeClusterResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeClusterResponse.java
@@ -21,6 +21,9 @@ import java.util.List;
import lombok.Data;
import lombok.EqualsAndHashCode;
+/**
+ * The response info of tube cluster.
+ */
@Data
@EqualsAndHashCode(callSuper = true)
public class TubeClusterResponse extends TubeManagerResponse {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeManagerResponse.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeManagerResponse.java
index 7dbcc9e93..34ebb63c0 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeManagerResponse.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/tubemq/TubeManagerResponse.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.common.pojo.tubemq;
import lombok.Data;
+/**
+ * The response info of tube manager.
+ */
@Data
public class TubeManagerResponse {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/PasswordChangeRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/PasswordChangeRequest.java
index c7d3fdb93..6c3f40e25 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/PasswordChangeRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/PasswordChangeRequest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.common.pojo.user;
import lombok.Data;
import lombok.EqualsAndHashCode;
+/**
+ * Password change request.
+ */
@Data
@EqualsAndHashCode(callSuper = false)
public class PasswordChangeRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailListVO.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailListVO.java
index ad20506f7..31069e4f0 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailListVO.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailListVO.java
@@ -21,6 +21,9 @@ import java.util.Date;
import lombok.Data;
import lombok.EqualsAndHashCode;
+/**
+ * User detail list VO.
+ */
@Data
@EqualsAndHashCode(callSuper = false)
public class UserDetailListVO {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailPageRequest.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailPageRequest.java
index 149deb3a1..bab42ab88 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailPageRequest.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserDetailPageRequest.java
@@ -21,6 +21,9 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import org.apache.inlong.manager.common.beans.PageRequest;
+/**
+ * User detail page request.
+ */
@Data
@EqualsAndHashCode(callSuper = false)
public class UserDetailPageRequest extends PageRequest {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserInfo.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserInfo.java
index 82670b7d0..18c9b8b29 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserInfo.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserInfo.java
@@ -23,6 +23,9 @@ import lombok.Data;
import org.apache.inlong.manager.common.enums.UserTypeEnum;
import org.apache.inlong.manager.common.util.Preconditions;
+/**
+ * User info, including username, password, etc.
+ */
@Data
@ApiModel("User info")
public class UserInfo {
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserRoleCode.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserRoleCode.java
index 8262a7732..c9a5b0b15 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserRoleCode.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/pojo/user/UserRoleCode.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.pojo.user;
+/**
+ * User role code.
+ */
public class UserRoleCode {
public static final String ADMIN = "Admin";
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/AgentConstants.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/AgentConstants.java
index ad491f5e1..e73ded72f 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/AgentConstants.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/AgentConstants.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.common.util;
+/**
+ * Agent constants.
+ */
public class AgentConstants {
public static String NAME = "name";
public static String IP = "ip";
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/InlongCollectionUtils.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/InlongCollectionUtils.java
index 8f74cd64c..c363af4e4 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/InlongCollectionUtils.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/InlongCollectionUtils.java
@@ -23,6 +23,9 @@ import java.util.Map;
import java.util.function.Function;
import org.apache.commons.collections.CollectionUtils;
+/**
+ * Utils of inlong collection.
+ */
public class InlongCollectionUtils {
/**
diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/StreamParseUtils.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/StreamParseUtils.java
index c3fc2a0d5..8b76adc59 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/StreamParseUtils.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/util/StreamParseUtils.java
@@ -38,6 +38,9 @@ import org.apache.inlong.manager.common.pojo.transform.splitter.SplitterDefiniti
import java.util.List;
+/**
+ * Utils of stream parse.
+ */
public class StreamParseUtils {
public static final String LEFT_NODE = "leftNode";
diff --git a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/stream/StreamPipelineTest.java b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/stream/StreamPipelineTest.java
index 456f67578..1fb6bc785 100644
--- a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/stream/StreamPipelineTest.java
+++ b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/stream/StreamPipelineTest.java
@@ -22,6 +22,9 @@ import org.apache.commons.lang3.tuple.Pair;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Stream pipeline service test for check has circle.
+ */
public class StreamPipelineTest {
@Test
diff --git a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinitionTest.java b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinitionTest.java
index 763ac04d5..d7c40b9df 100644
--- a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinitionTest.java
+++ b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/pojo/transform/TransformDefinitionTest.java
@@ -38,6 +38,9 @@ import org.junit.Test;
import java.util.List;
import java.util.concurrent.TimeUnit;
+/**
+ * Transform definition service test.
+ */
public class TransformDefinitionTest {
public class BlankStreamNode extends StreamNode {
diff --git a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/util/InlongCollectionUtilsTest.java b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/util/InlongCollectionUtilsTest.java
index 744f6218a..d80c6eb44 100644
--- a/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/util/InlongCollectionUtilsTest.java
+++ b/inlong-manager/manager-common/src/test/java/org/apache/inlong/manager/common/util/InlongCollectionUtilsTest.java
@@ -23,6 +23,9 @@ import java.util.function.Function;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Inlong collection util test.
+ */
public class InlongCollectionUtilsTest {
@Test
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AgentSysConfigEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AgentSysConfigEntity.java
index 77da70d19..3212c94e1 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AgentSysConfigEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AgentSysConfigEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import java.io.Serializable;
import lombok.Data;
+/**
+ * Agent system config info, including retry thread info, message queue info, etc.
+ */
@Data
public class AgentSysConfigEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AuditEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AuditEntity.java
index 73ced7355..a888e463f 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AuditEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/AuditEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Audit info, including ip, docker id, thread id, etc.
+ */
@Data
public class AuditEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CacheClusterExt.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CacheClusterExt.java
index 5c89df8df..3f728bd79 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CacheClusterExt.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CacheClusterExt.java
@@ -83,8 +83,6 @@ public class CacheClusterExt {
/**
* getJIsDeleted
- *
- * @return
*/
public Integer getJIsDeleted() {
return isDeleted;
@@ -92,8 +90,6 @@ public class CacheClusterExt {
/**
* setIsDeleted
- *
- * @param isDeleted
*/
public void setIsDeleted(Integer isDeleted) {
this.isDeleted = isDeleted;
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneEntity.java
index 036d79e81..9ce0fc71d 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import java.io.Serializable;
import lombok.Data;
+/**
+ * City zone entity, including city id, city name, zone id.
+ */
@Data
public class CityZoneEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneInfo.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneInfo.java
index 735c896e6..9f37bb2ae 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneInfo.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CityZoneInfo.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.dao.entity;
import lombok.Data;
+/**
+ * City zone info, including ip, city id, zone id.
+ */
@Data
public class CityZoneInfo {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonDbServerEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonDbServerEntity.java
index 17e652ee0..be2c8a190 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonDbServerEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonDbServerEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Common database server info, including connection name, username, password, etc.
+ */
@Data
public class CommonDbServerEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonFileServerEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonFileServerEntity.java
index f26f8e6bc..22005b176 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonFileServerEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/CommonFileServerEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Common file server entity, including ip, port, username, password, etc.
+ */
@Data
public class CommonFileServerEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ComponentHeartbeatEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ComponentHeartbeatEntity.java
index b5406d1ec..5c8b5e1f8 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ComponentHeartbeatEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ComponentHeartbeatEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Common heartbeat server entity, including status info and time info.
+ */
@Data
public class ComponentHeartbeatEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ConsumptionPulsarEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ConsumptionPulsarEntity.java
index 675126b32..a524d592a 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ConsumptionPulsarEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ConsumptionPulsarEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import java.io.Serializable;
import lombok.Data;
+/**
+ * Data consumption table, including group name, group id, topic, etc
+ */
@Data
public class ConsumptionPulsarEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DBCollectorDetailTaskEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DBCollectorDetailTaskEntity.java
index d09817996..f94c91189 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DBCollectorDetailTaskEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DBCollectorDetailTaskEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Database collector detail task entity.
+ */
@Data
public class DBCollectorDetailTaskEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataNodeEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataNodeEntity.java
index 15bdf0545..1b25fdb02 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataNodeEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataNodeEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Data node entity, including id, name, type, etc.
+ */
@Data
public class DataNodeEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataProxyClusterEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataProxyClusterEntity.java
index 087d724e7..a8ba8df8e 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataProxyClusterEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataProxyClusterEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Data proxy cluster entity, including id, name, address, etc.
+ */
@Data
public class DataProxyClusterEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSchemaEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSchemaEntity.java
index 5a5432526..6c7a0afec 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSchemaEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSchemaEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import java.io.Serializable;
import lombok.Data;
+/**
+ * Data schema entity, including name, agent type, etc.
+ */
@Data
public class DataSchemaEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSourceCmdConfigEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSourceCmdConfigEntity.java
index 619a0bbbd..2456fd8ec 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSourceCmdConfigEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/DataSourceCmdConfigEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Data source command config entity, including cmd type, specified data time, etc.
+ */
@Data
public class DataSourceCmdConfigEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/GroupHeartbeatEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/GroupHeartbeatEntity.java
index c054cef03..b24d351b4 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/GroupHeartbeatEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/GroupHeartbeatEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Group heartbeat entity.
+ */
@Data
public class GroupHeartbeatEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterEntity.java
index 2baf87bad..db06ff35b 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Inlong cluster entity, including name, type, cluster tag, etc.
+ */
@Data
public class InlongClusterEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterNodeEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterNodeEntity.java
index 0ded49141..3dc2a4a1a 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterNodeEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongClusterNodeEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Inlong cluster node entity, including parent id, type, ip, etc.
+ */
@Data
public class InlongClusterNodeEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupEntity.java
index 30aa3936d..bf4e1c5c1 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Inlong group entity, including inlong group id, name, etc.
+ */
@Data
public class InlongGroupEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupExtEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupExtEntity.java
index a0701147a..63205e24f 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupExtEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupExtEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * InlongGroupExtEntity, including key name, key value, etc.
+ */
@Data
public class InlongGroupExtEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupPulsarEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupPulsarEntity.java
index dc730fb52..33996d225 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupPulsarEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongGroupPulsarEntity.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * InlongGroupPulsarEntity, including inlong group id, ensemble, etc.
+ */
@Data
public class InlongGroupPulsarEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamEntity.java
index f289e928a..0150c9387 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Inlong stream entity, including inlong stream id, inlong group id, etc.
+ */
@Data
public class InlongStreamEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamFieldEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamFieldEntity.java
index e8fd0287e..e2a1f8ecb 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamFieldEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/InlongStreamFieldEntity.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Inlong stream field entity, including inlong gourp id, inlong stream id, etc.
+ */
@Data
public class InlongStreamFieldEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/OperationLogEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/OperationLogEntity.java
index 6442f3cc6..34909e097 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/OperationLogEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/OperationLogEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Operation log entity, including operation type, request url, etc.
+ */
@Data
public class OperationLogEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/RoleEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/RoleEntity.java
index 99a25023d..3492b84e2 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/RoleEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/RoleEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Role entity, including role code, role name, etc.
+ */
@Data
public class RoleEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortClusterConfigEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortClusterConfigEntity.java
index f9f031953..a6a983446 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortClusterConfigEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortClusterConfigEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Sort cluster config entity, including cluster name, task name, sink type.
+ */
@Data
@Builder
public class SortClusterConfigEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortSourceConfigEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortSourceConfigEntity.java
index eca7fc498..31a4fa09e 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortSourceConfigEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortSourceConfigEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Sort source config entity, including cluster name, task name, zone name, topic, etc.
+ */
@Data
@Builder
public class SortSourceConfigEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskIdParamEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskIdParamEntity.java
index 72adcdcc7..a176f102b 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskIdParamEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskIdParamEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import lombok.Builder;
import lombok.Data;
+/**
+ * Sort task id param entity, including task name, group id, etc.
+ */
@Data
@Builder
public class SortTaskIdParamEntity {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskSinkParamEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskSinkParamEntity.java
index b298c5fcb..e0ec319e2 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskSinkParamEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SortTaskSinkParamEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Sort task sink param entity, including task name, sink type, etc.
+ */
@Data
@Builder
public class SortTaskSinkParamEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceDbDetailEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceDbDetailEntity.java
index e18ee0fba..3da22d57b 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceDbDetailEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceDbDetailEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Source database Detail entity, including table name, connection name, etc.
+ */
@Data
public class SourceDbDetailEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileBasicEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileBasicEntity.java
index bdaacb531..3188a78e9 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileBasicEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileBasicEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Source file basic entity, including file rolling type, upload max siez, etc.
+ */
@Data
public class SourceFileBasicEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileDetailEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileDetailEntity.java
index b7494ba55..c70dbd80a 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileDetailEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/SourceFileDetailEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Source file detail entity, including servername, username, password, etc.
+ */
@Data
public class SourceFileDetailEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamConfigLogEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamConfigLogEntity.java
index dfbd0c8db..d8dcb6e1c 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamConfigLogEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamConfigLogEntity.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.dao.entity;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Stream config log entity, including version, componet name, etc.
+ */
public class StreamConfigLogEntity implements Serializable {
private String ip;
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamHeartbeatEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamHeartbeatEntity.java
index 6e74b885e..892c9dd41 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamHeartbeatEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamHeartbeatEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Stream heartbeat entity, inlcuding status heartbeat, component, etc.
+ */
@Data
public class StreamHeartbeatEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkEntity.java
index cc64ee62e..0ade2b981 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Stream sink entity, including sink type, sink name, etc.
+ */
@Data
public class StreamSinkEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkExtEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkExtEntity.java
index 7075d5aad..e6d782745 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkExtEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkExtEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Stream sink ext entity, including key name, key value, etc.
+ */
@Data
public class StreamSinkExtEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkFieldEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkFieldEntity.java
index 89ccebce2..95413263d 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkFieldEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSinkFieldEntity.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Stream sink field entity, including field name, field length, etc.
+ */
@Data
public class StreamSinkFieldEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceEntity.java
index d51e62886..f4008e16b 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * Stream source entity, including source type, source name, etc.
+ */
@Data
public class StreamSourceEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceFieldEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceFieldEntity.java
index bd845d5d2..665812386 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceFieldEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamSourceFieldEntity.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Stream source field entity, including field name, field value, etc.
+ */
@Data
public class StreamSourceFieldEntity implements Serializable {
private Integer id;
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformEntity.java
index b6efc4d60..33d2b1e77 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * StreamTransformEntity.
+ */
@Data
public class StreamTransformEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformFieldEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformFieldEntity.java
index a7d72b3e1..49ed97fa1 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformFieldEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/StreamTransformFieldEntity.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.io.Serializable;
+/**
+ * Stream transform field entity, including transform type, transform id, etc.
+ */
@Data
public class StreamTransformFieldEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ThirdPartyClusterEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ThirdPartyClusterEntity.java
index 0e13b79fa..96014f10a 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ThirdPartyClusterEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/ThirdPartyClusterEntity.java
@@ -22,6 +22,9 @@ import lombok.Data;
import java.io.Serializable;
import java.util.Date;
+/**
+ * ThirdPartyClusterEntity.
+ */
@Data
public class ThirdPartyClusterEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserEntity.java
index 15333a413..52ccba49d 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * User entity, including username, password, etc.
+ */
@Data
public class UserEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserRoleEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserRoleEntity.java
index d881f1891..a1d9d805c 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserRoleEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/UserRoleEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * User role entity, including username, role code, etc.
+ */
@Data
public class UserRoleEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/WorkflowApproverEntity.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/WorkflowApproverEntity.java
index 8cb8dbc3a..4b38a5dc0 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/WorkflowApproverEntity.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/entity/WorkflowApproverEntity.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Date;
import lombok.Data;
+/**
+ * Workflow approver entity, including process name, task name, filter key, etc.
+ */
@Data
public class WorkflowApproverEntity implements Serializable {
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceEntityMapper.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceEntityMapper.java
index 8f17751dd..f35172261 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceEntityMapper.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceEntityMapper.java
@@ -36,8 +36,8 @@ public interface StreamSourceEntityMapper {
/**
* Only used for agent collector, which will select all tasks related include deleted tasks.
*
- * @param id
- * @return
+ * @param id stream source id
+ * @return stream source info
*/
StreamSourceEntity selectForAgentTask(Integer id);
@@ -119,10 +119,6 @@ public interface StreamSourceEntityMapper {
/**
* Physical delete stream sources.
- *
- * @param groupId
- * @param streamId
- * @return
*/
int deleteByRelatedId(@Param("groupId") String groupId, @Param("streamId") String streamId);
diff --git a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceFieldEntityMapper.java b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceFieldEntityMapper.java
index 340a93160..de5960ef3 100644
--- a/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceFieldEntityMapper.java
+++ b/inlong-manager/manager-dao/src/main/java/org/apache/inlong/manager/dao/mapper/StreamSourceFieldEntityMapper.java
@@ -35,8 +35,8 @@ public interface StreamSourceFieldEntityMapper {
/**
* Selete undeleted source field by source id.
*
- * @param sourceId
- * @return
+ * @param sourceId source id
+ * @return stream source field list
*/
List<StreamSourceFieldEntity> selectBySourceId(@Param("sourceId") Integer sourceId);
@@ -47,15 +47,15 @@ public interface StreamSourceFieldEntityMapper {
/**
* Insert all field list
*
- * @param fieldList
+ * @param fieldList stream source field list
*/
void insertAll(@Param("list") List<StreamSourceFieldEntity> fieldList);
/**
* Delete all field list by sourceId
*
- * @param sourceId
- * @return
+ * @param sourceId source id
+ * @return number of records deleted
*/
int deleteAll(@Param("sourceId") Integer sourceId);
diff --git a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/RestTemplateConfig.java b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/RestTemplateConfig.java
index 4e6ed65e4..4a5e7b804 100644
--- a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/RestTemplateConfig.java
+++ b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/RestTemplateConfig.java
@@ -42,6 +42,9 @@ import org.springframework.web.client.RestTemplate;
import java.nio.charset.StandardCharsets;
import java.util.List;
+/**
+ * Test class for rest template config.
+ */
@Data
@Configuration
@ConditionalOnMissingBean(RestTemplate.class)
diff --git a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/config/JDBCSourceConfigTest.java b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/config/JDBCSourceConfigTest.java
index 2f79024e7..db2e36318 100644
--- a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/config/JDBCSourceConfigTest.java
+++ b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/config/JDBCSourceConfigTest.java
@@ -26,6 +26,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import javax.sql.DataSource;
+/**
+ * JDBC source config test for {@link JDBCSourceConfig}
+ */
public class JDBCSourceConfigTest extends DaoBaseTest {
@Autowired
diff --git a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/mapper/InlongGroupEntityMapperTest.java b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/mapper/InlongGroupEntityMapperTest.java
index 1de728ade..2f82b0624 100644
--- a/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/mapper/InlongGroupEntityMapperTest.java
+++ b/inlong-manager/manager-dao/src/test/java/org/apache/inlong/manager/dao/mapper/InlongGroupEntityMapperTest.java
@@ -25,6 +25,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import java.util.Date;
+/**
+ * Inlong group entity mapper test for {@link InlongGroupEntityMapper}
+ */
public class InlongGroupEntityMapperTest extends DaoBaseTest {
@Autowired
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/FlinkSortProcessPlugin.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/FlinkSortProcessPlugin.java
index 8386ff352..04407ab04 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/FlinkSortProcessPlugin.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/FlinkSortProcessPlugin.java
@@ -34,6 +34,9 @@ import org.apache.inlong.manager.workflow.plugin.ProcessPlugin;
import java.util.LinkedHashMap;
import java.util.Map;
+/**
+ * Plugin of flink sort process.
+ */
@Slf4j
public class FlinkSortProcessPlugin implements ProcessPlugin {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/DeleteProcessSelector.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/DeleteProcessSelector.java
index 715db2807..088e63a75 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/DeleteProcessSelector.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/DeleteProcessSelector.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of delete process event.
+ */
@Slf4j
public class DeleteProcessSelector implements EventSelector {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/RestartProcessSelector.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/RestartProcessSelector.java
index 58f5c3436..2dfc25ae3 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/RestartProcessSelector.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/RestartProcessSelector.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of restart process event.
+ */
@Slf4j
public class RestartProcessSelector implements EventSelector {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/StartupProcessSelector.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/StartupProcessSelector.java
index eaa44f906..49980eaa0 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/StartupProcessSelector.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/StartupProcessSelector.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.ProcessForm;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of startup process event.
+ */
@Slf4j
public class StartupProcessSelector implements EventSelector {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/SuspendProcessSelector.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/SuspendProcessSelector.java
index 8dae98a8f..58b07ec3e 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/SuspendProcessSelector.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/eventselect/SuspendProcessSelector.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of suspend process event.
+ */
@Slf4j
public class SuspendProcessSelector implements EventSelector {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkOperation.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkOperation.java
index 27fcf8a41..d47da9576 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkOperation.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkOperation.java
@@ -34,7 +34,7 @@ import static org.apache.flink.api.common.JobStatus.RUNNING;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.findFiles;
/**
- * Flink task operation.
+ * Flink task operation, such restart or stop flink job.
*/
@Slf4j
public class FlinkOperation {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkService.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkService.java
index 68483479f..2986a1ccf 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkService.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/FlinkService.java
@@ -48,6 +48,9 @@ import java.util.concurrent.CompletableFuture;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+/**
+ * Flink service, such as save or get flink config info, etc.
+ */
@Slf4j
public class FlinkService {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/IntegrationTaskRunner.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/IntegrationTaskRunner.java
index c321c925e..5d1541549 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/IntegrationTaskRunner.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/IntegrationTaskRunner.java
@@ -27,6 +27,9 @@ import org.apache.inlong.manager.plugin.flink.enums.TaskCommitType;
import static org.apache.flink.api.common.JobStatus.FINISHED;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.getExceptionStackMsg;
+/**
+ * Integration task runner for start, restart or stop flink service.
+ */
@Slf4j
public class IntegrationTaskRunner implements Runnable {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/TaskRunService.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/TaskRunService.java
index 072fe79f0..51109e2c7 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/TaskRunService.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/TaskRunService.java
@@ -24,6 +24,9 @@ import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
+/**
+ * Task run service.
+ */
public class TaskRunService {
private static final ExecutorService executorService;
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkConfig.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkConfig.java
index 3bde24ffe..dd2f58ae9 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkConfig.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkConfig.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.plugin.flink.dto;
import lombok.Data;
+/**
+ * Flink config, including address, port, job manager port, etc.
+ */
@Data
public class FlinkConfig {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkInfo.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkInfo.java
index c3e767512..b3af2b3d0 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkInfo.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/FlinkInfo.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.common.pojo.stream.InlongStreamInfo;
import java.util.List;
+/**
+ * Flink infomation, including end point, job name, source type, etc.
+ */
@Data
public class FlinkInfo {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarEntryInfo.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarEntryInfo.java
index aedf0128b..53d34f116 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarEntryInfo.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarEntryInfo.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.plugin.flink.dto;
import lombok.Data;
+/**
+ * Jar entry info, including name, description.
+ */
@Data
public class JarEntryInfo {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarFileInfo.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarFileInfo.java
index d8a915c0a..10ffe7d78 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarFileInfo.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarFileInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.List;
+/**
+ * Jar file info, including id, name, uploaded, entry, etc.
+ */
@Data
public class JarFileInfo {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarListInfo.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarListInfo.java
index 43455a5be..c43276c4c 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarListInfo.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarListInfo.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.List;
+/**
+ * Jar list info, including address, file list.
+ */
@Data
public class JarListInfo {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarRunRequest.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarRunRequest.java
index ab071399b..93721a908 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarRunRequest.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/JarRunRequest.java
@@ -21,6 +21,9 @@ import lombok.Data;
import java.util.List;
+/**
+ * The request info of jar run.
+ */
@Data
public class JarRunRequest {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/Jars.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/Jars.java
index 495233444..0d6b03db3 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/Jars.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/Jars.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.plugin.flink.dto;
import lombok.Data;
+/**
+ * Jars info, including filename and status.
+ */
@Data
public class Jars {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/LoginConf.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/LoginConf.java
index 868d84b7d..6d5558d5d 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/LoginConf.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/LoginConf.java
@@ -19,6 +19,9 @@ package org.apache.inlong.manager.plugin.flink.dto;
import lombok.Data;
+/**
+ * Login config, including rest address, rest port and jab manaer port.
+ */
@Data
public class LoginConf {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/StopWithSavepointRequest.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/StopWithSavepointRequest.java
index 13808023c..ebfb1dc60 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/StopWithSavepointRequest.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/dto/StopWithSavepointRequest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.plugin.flink.dto;
import lombok.Getter;
import lombok.Setter;
+/**
+ * Request info of stop with save point.
+ */
@Getter
@Setter
public class StopWithSavepointRequest {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/enums/Constants.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/enums/Constants.java
index 2f60164b3..97beea4af 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/enums/Constants.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/flink/enums/Constants.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.plugin.flink.enums;
+/**
+ * Constants info, including properties, dataflow info and rest api url info.
+ */
public class Constants {
//properties
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/DeleteSortListener.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/DeleteSortListener.java
index c7b1107d7..bb6581291 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/DeleteSortListener.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/DeleteSortListener.java
@@ -40,6 +40,9 @@ import java.util.stream.Collectors;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.getExceptionStackMsg;
+/**
+ * Listener of delete sort.
+ */
@Slf4j
public class DeleteSortListener implements SortOperateListener {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/RestartSortListener.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/RestartSortListener.java
index b81c72ee6..9e0a96d05 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/RestartSortListener.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/RestartSortListener.java
@@ -44,6 +44,9 @@ import java.util.stream.Collectors;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.getExceptionStackMsg;
+/**
+ * Listener of restart sort.
+ */
@Slf4j
public class RestartSortListener implements SortOperateListener {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/StartupSortListener.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/StartupSortListener.java
index 1a4e9de7e..ede84db6f 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/StartupSortListener.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/StartupSortListener.java
@@ -44,6 +44,9 @@ import java.util.stream.Collectors;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.getExceptionStackMsg;
+/**
+ * Listener of startup sort.
+ */
@Slf4j
public class StartupSortListener implements SortOperateListener {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/SuspendSortListener.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/SuspendSortListener.java
index c822b828e..29853dea2 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/SuspendSortListener.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/listener/SuspendSortListener.java
@@ -40,6 +40,9 @@ import java.util.stream.Collectors;
import static org.apache.inlong.manager.plugin.util.FlinkUtils.getExceptionStackMsg;
+/**
+ * Listener of suspend sort.
+ */
@Slf4j
public class SuspendSortListener implements SortOperateListener {
diff --git a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/util/FlinkUtils.java b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/util/FlinkUtils.java
index affd77c66..54f601052 100644
--- a/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/util/FlinkUtils.java
+++ b/inlong-manager/manager-plugins/src/main/java/org/apache/inlong/manager/plugin/util/FlinkUtils.java
@@ -34,6 +34,9 @@ import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+/**
+ * Util of flink.
+ */
@Slf4j
public class FlinkUtils {
@@ -43,9 +46,6 @@ public class FlinkUtils {
/**
* getLatestFlinkVersion
- *
- * @param supportedFlink
- * @return
*/
public static String getLatestFlinkVersion(String[] supportedFlink) {
if (Objects.isNull(supportedFlink)) {
@@ -65,8 +65,6 @@ public class FlinkUtils {
/**
* print exception
- * @param throwable
- * @return
*/
public static String getExceptionStackMsg(Throwable throwable) {
StringWriter stringWriter = new StringWriter();
@@ -77,9 +75,9 @@ public class FlinkUtils {
/**
* fetch sort-single-tenant jar path
*
- * @param baseDirName
- * @param pattern
- * @return
+ * @param baseDirName base directory name.
+ * @param pattern pattern of file
+ * @return sort-single-tenant jar path
*/
public static String findFiles(String baseDirName, String pattern) {
File baseDir = new File(baseDirName);
@@ -109,10 +107,6 @@ public class FlinkUtils {
/**
* get value
- *
- * @param key
- * @param defaultValue
- * @return
*/
public static String getValue(String key, String defaultValue) {
return StringUtils.isNotEmpty(key) ? key : defaultValue;
@@ -121,8 +115,8 @@ public class FlinkUtils {
/**
* getConfigDirectory
*
- * @param name
- * @return
+ * @param name config file name
+ * @return config file directory
*/
public static String getConfigDirectory(String name) {
return BASE_DIRECTORY + File.separator + name;
@@ -131,10 +125,10 @@ public class FlinkUtils {
/**
* writeConfigToFile
*
- * @param configJobDirectory
- * @param configFileName
- * @param content
- * @return
+ * @param configJobDirectory job config directory
+ * @param configFileName config file name
+ * @param content contents of the file to be written
+ * @return whether success
*/
public static boolean writeConfigToFile(String configJobDirectory, String configFileName, String content) {
File file = new File(configJobDirectory);
@@ -156,10 +150,10 @@ public class FlinkUtils {
}
/**
- * delete configuration file
+ * Delete configuration file
*
- * @param name
- * @return
+ * @param name file config info
+ * @return whether sucess
*/
public static boolean deleteConfigFile(String name) {
String configDirectory = getConfigDirectory(name);
diff --git a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/DeleteSortListenerTest.java b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/DeleteSortListenerTest.java
index b850f1882..32e34ae8c 100644
--- a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/DeleteSortListenerTest.java
+++ b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/DeleteSortListenerTest.java
@@ -31,6 +31,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Test class for delete sort listener.
+ */
public class DeleteSortListenerTest {
@Test
diff --git a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/RestartSortListenerTest.java b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/RestartSortListenerTest.java
index 072576b46..8c4e3cd74 100644
--- a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/RestartSortListenerTest.java
+++ b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/RestartSortListenerTest.java
@@ -30,6 +30,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Test class for restart sort listener.
+ */
public class RestartSortListenerTest {
@Test
diff --git a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/StartupSortListenerTest.java b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/StartupSortListenerTest.java
index c72a7a4d4..fc15e1a96 100644
--- a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/StartupSortListenerTest.java
+++ b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/StartupSortListenerTest.java
@@ -30,6 +30,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Test class for start up sort listener.
+ */
public class StartupSortListenerTest {
@Test
diff --git a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/SuspendSortListenerTest.java b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/SuspendSortListenerTest.java
index 08ce7905d..9351e6f3c 100644
--- a/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/SuspendSortListenerTest.java
+++ b/inlong-manager/manager-plugins/src/test/java/org/apache/inlong/manager/plugin/listener/SuspendSortListenerTest.java
@@ -30,6 +30,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Test class for suspend sort listener.
+ */
public class SuspendSortListenerTest {
@Test
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/AuditService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/AuditService.java
index 0433f5cc3..45a56ed75 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/AuditService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/AuditService.java
@@ -22,6 +22,9 @@ import java.util.List;
import org.apache.inlong.manager.common.pojo.audit.AuditRequest;
import org.apache.inlong.manager.common.pojo.audit.AuditVO;
+/**
+ * The service interface for audit.
+ */
public interface AuditService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonDBServerService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonDBServerService.java
index bc9f8945e..2f1bcb96e 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonDBServerService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonDBServerService.java
@@ -23,25 +23,91 @@ import org.apache.inlong.manager.common.pojo.commonserver.CommonDbServerInfo;
import org.apache.inlong.manager.common.pojo.commonserver.CommonDbServerListVo;
import org.apache.inlong.manager.common.pojo.commonserver.CommonDbServerPageRequest;
+/**
+ * The service interface for common database server.
+ */
public interface CommonDBServerService {
+ /**
+ * Save common database server info.
+ *
+ * @param commonDbServerInfo common database server info.
+ * @return the id of common database server info.
+ */
int save(CommonDbServerInfo commonDbServerInfo) throws Exception;
+ /**
+ * Get common database server info by id.
+ *
+ * @param id common database server info id.
+ * @return the common database server info.
+ */
CommonDbServerInfo get(int id) throws Exception;
+ /**
+ * Delete common database server info by id.
+ *
+ * @param id common database server info id.
+ */
void delete(int id) throws Exception;
+ /**
+ * Update common database server info.
+ *
+ * @param commonDbServerInfo common database server info.
+ * @return the updated common database server info .
+ */
CommonDbServerInfo update(CommonDbServerInfo commonDbServerInfo) throws Exception;
+ /**
+ * Get common database server info list by username.
+ *
+ * @param user the username of database.
+ * @return common database server info list.
+ */
List<CommonDbServerInfo> getByUser(String user) throws Exception;
+ /**
+ * Add visible persion for common database server.
+ *
+ * @param id common database server info id.
+ * @param visiblePerson the visible person of common database server.
+ * @return the updated common database server info.
+ */
CommonDbServerInfo addVisiblePerson(Integer id, String visiblePerson);
+ /**
+ * Delete visible persion for common database server.
+ *
+ * @param id common database server info id.
+ * @param visiblePerson the visiblePerson of common database server.
+ * @return the updated common database server info.
+ */
CommonDbServerInfo deleteVisiblePerson(Integer id, String visiblePerson);
+ /**
+ * Add visible group for common database server.
+ *
+ * @param id common database server info id.
+ * @param visibleGroup the visible group of common database server.
+ * @return the updated common database server info.
+ */
CommonDbServerInfo addVisibleGroup(Integer id, String visibleGroup);
+ /**
+ * Delete visiable group for common database server.
+ *
+ * @param id common database server info id.
+ * @param visibleGroup the visible group of common database server.
+ * @return the updated common database server info.
+ */
CommonDbServerInfo deleteVisibleGroup(Integer id, String visibleGroup);
+ /**
+ * Query common database server for list by condition
+ *
+ * @param request The common database server request of query condition
+ * @return The result of query
+ */
PageInfo<CommonDbServerListVo> listByCondition(CommonDbServerPageRequest request) throws Exception;
}
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonFileServerService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonFileServerService.java
index 725000c46..6d78ebfb4 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonFileServerService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/CommonFileServerService.java
@@ -23,29 +23,107 @@ import org.apache.inlong.manager.common.pojo.commonserver.CommonFileServerInfo;
import org.apache.inlong.manager.common.pojo.commonserver.CommonFileServerListVo;
import org.apache.inlong.manager.common.pojo.commonserver.CommonFileServerPageRequest;
+/**
+ * The service interface for common file server.
+ */
public interface CommonFileServerService {
+ /**
+ * Create common file server.
+ *
+ * @param commonFileServerInfo common file server info.
+ * @return the id of common file server info.
+ */
int create(CommonFileServerInfo commonFileServerInfo) throws Exception;
+ /**
+ * Get common file server info.
+ *
+ * @param id common file server info id.
+ * @return the common file server info.
+ */
CommonFileServerInfo get(int id) throws Exception;
+ /**
+ * Delete common file server info by id.
+ *
+ * @param id common file server info id.
+ */
void delete(int id) throws Exception;
+ /**
+ * Update common file server info.
+ *
+ * @param commonFileServerInfo common file server info.
+ * @return the updated common file server info .
+ */
CommonFileServerInfo update(CommonFileServerInfo commonFileServerInfo) throws Exception;
+ /**
+ * Freeze Common file server.
+ *
+ * @param id the id of common file server.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo freeze(int id);
+ /**
+ * Unfreeze Common file server.
+ *
+ * @param id the id of file.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo unfreeze(int id);
+ /**
+ * Get common file server info list by username.
+ *
+ * @param user the username for common file server.
+ * @return common file server info list.
+ */
List<CommonFileServerInfo> getByUser(String user);
+ /**
+ * Add visible person for common file server.
+ *
+ * @param id common database server info id.
+ * @param visiblePerson the visible persion of common file server.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo addVisiblePerson(Integer id, String visiblePerson);
+ /**
+ * Delete visible person for common file server.
+ *
+ * @param id common database server info id.
+ * @param visiblePerson the visible person of common database server.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo deleteVisiblePerson(Integer id, String visiblePerson);
+ /**
+ * Add visible group for common file server.
+ *
+ * @param id common database server info id.
+ * @param visibleGroup the visible group of common file server.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo addVisibleGroup(Integer id, String visibleGroup);
+ /**
+ * Delete visible group for common file server.
+ *
+ * @param id common file server info id.
+ * @param visibleGroup the visible group of common file server.
+ * @return the updated common file server info.
+ */
CommonFileServerInfo deleteVisibleGroup(Integer id, String visibleGroup);
+ /**
+ * Query common file server for list by condition
+ *
+ * @param request The common file server request of query condition
+ * @return The result of query
+ */
PageInfo<CommonFileServerListVo> listByCondition(CommonFileServerPageRequest request) throws Exception;
}
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DBCollectorTaskService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DBCollectorTaskService.java
index 5ebda8bf7..1f2cd1cf2 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DBCollectorTaskService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DBCollectorTaskService.java
@@ -21,9 +21,24 @@ import org.apache.inlong.manager.common.pojo.dbcollector.DBCollectorReportTaskRe
import org.apache.inlong.manager.common.pojo.dbcollector.DBCollectorTaskInfo;
import org.apache.inlong.manager.common.pojo.dbcollector.DBCollectorTaskRequest;
+/**
+ * Database collector task service layer interface for inlong group
+ */
public interface DBCollectorTaskService {
+ /**
+ * Get task by request condition.
+ *
+ * @param req request conditions.
+ * @return Database collector task info.
+ */
DBCollectorTaskInfo getTask(DBCollectorTaskRequest req);
+ /**
+ * Report task.
+ *
+ * @param req request conditions
+ * @return whether succeed
+ */
Integer reportTask(DBCollectorReportTaskRequest req);
}
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DataSchemaService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DataSchemaService.java
index a4d76cb6d..7ca13eb6c 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DataSchemaService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/DataSchemaService.java
@@ -23,7 +23,6 @@ import java.util.List;
/**
* Data format service layer interface for inlong group
- *
*/
public interface DataSchemaService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/InlongStreamService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/InlongStreamService.java
index c3a9aee17..ba1a34879 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/InlongStreamService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/InlongStreamService.java
@@ -59,8 +59,8 @@ public interface InlongStreamService {
/**
* List streams contained in one group
*
- * @param groupId
- * @return
+ * @param groupId inlong group id.
+ * @return Inlong stream info list
*/
List<InlongStreamInfo> list(String groupId);
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/RoleService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/RoleService.java
index 4a523205c..92d7041a4 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/RoleService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/RoleService.java
@@ -21,7 +21,6 @@ import java.util.List;
/**
* Role service
- *
*/
public interface RoleService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortClusterConfigService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortClusterConfigService.java
index 1e98709dc..88a783b50 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortClusterConfigService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortClusterConfigService.java
@@ -28,6 +28,7 @@ public interface SortClusterConfigService {
/**
* Select list of task by cluster name.
+ *
* @param clusterName Name of sort cluster.
* @return List of tasks, including task name and sink type.
*/
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortSourceService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortSourceService.java
index b849f9d53..bdcbca751 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortSourceService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortSourceService.java
@@ -28,6 +28,7 @@ public interface SortSourceService {
/**
* Get cache zones by cluster name and task name.
+ *
* @param clusterName Target cluster name.
* @param taskName Target task name.
* @return SortSourceConfigResponse
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskIdParamService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskIdParamService.java
index 06be4ca31..12e3e271f 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskIdParamService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskIdParamService.java
@@ -27,6 +27,7 @@ public interface SortTaskIdParamService {
/**
* Select all id params by task name.
+ *
* @param taskName WorkflowTask name.
* @return List of all id params.
*/
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskSinkParamService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskSinkParamService.java
index 6526d65a1..9cb601c83 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskSinkParamService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/SortTaskSinkParamService.java
@@ -26,9 +26,10 @@ public interface SortTaskSinkParamService {
/**
* Select all sink params by task name and sink type.
+ *
* @param taskName Name of task;
* @param sinkType Type of sink;
- * @return
+ * @return map of sink params.
*/
Map<String, String> selectByTaskNameAndType(String taskName, String sinkType);
}
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/StreamConfigLogService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/StreamConfigLogService.java
index 79369c36f..779d66d8a 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/StreamConfigLogService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/StreamConfigLogService.java
@@ -22,10 +22,25 @@ import org.apache.inlong.manager.common.pojo.stream.InlongStreamConfigLogListRes
import org.apache.inlong.manager.common.pojo.stream.InlongStreamConfigLogPageRequest;
import org.apache.inlong.manager.common.pojo.stream.InlongStreamConfigLogRequest;
+/**
+ * Stream config log service.
+ */
public interface StreamConfigLogService {
+ /**
+ * Report config log.
+ *
+ * @param request request condition.
+ * @return whether succeed info.
+ */
String reportConfigLog(InlongStreamConfigLogRequest request);
+ /**
+ * Query inlong stream config log list based on conditions
+ *
+ * @param request Inlong stream config log paging query request
+ * @return Inlong stream config log paging list
+ */
PageInfo<InlongStreamConfigLogListResponse> listByCondition(
InlongStreamConfigLogPageRequest request);
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
index 8c24a531b..414a1baa0 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
@@ -17,11 +17,12 @@
package org.apache.inlong.manager.service.core;
-import java.util.List;
import org.apache.inlong.manager.common.pojo.workflow.WorkflowApprover;
import org.apache.inlong.manager.common.pojo.workflow.WorkflowApproverFilterContext;
import org.apache.inlong.manager.common.pojo.workflow.WorkflowApproverQuery;
+import java.util.List;
+
/**
* Workflow approver configuration service
*/
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AgentServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AgentServiceImpl.java
index 8a0e2bdec..39718b17a 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AgentServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AgentServiceImpl.java
@@ -57,6 +57,9 @@ import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
+/**
+ * Agent service layer implementation
+ */
@Service
public class AgentServiceImpl implements AgentService {
@@ -103,6 +106,11 @@ public class AgentServiceImpl implements AgentService {
}
}
+ /**
+ * Update task status by command.
+ *
+ * @param command command info.
+ */
private void updateTaskStatus(CommandEntity command) {
Integer taskId = command.getTaskId();
StreamSourceEntity current = sourceMapper.selectForAgentTask(taskId);
@@ -141,9 +149,6 @@ public class AgentServiceImpl implements AgentService {
}
}
- /**
- * Get task result by the request
- */
@Override
@Transactional(rollbackFor = Throwable.class, isolation = Isolation.READ_COMMITTED,
propagation = Propagation.REQUIRES_NEW)
@@ -237,7 +242,11 @@ public class AgentServiceImpl implements AgentService {
}
/**
- * Get the DataConfig from the stream source entity
+ * Get the DataConfig from the stream source entity.
+ *
+ * @param entity stream source entity.
+ * @param op operation code for add, delete, etc.
+ * @return data config.
*/
private DataConfig getDataConfig(StreamSourceEntity entity, int op) {
DataConfig dataConfig = new DataConfig();
@@ -265,11 +274,23 @@ public class AgentServiceImpl implements AgentService {
return dataConfig;
}
+ /**
+ * Get the Task type from the stream source entity.
+ *
+ * @param sourceEntity stream source info.
+ * @return task type
+ */
private int getTaskType(StreamSourceEntity sourceEntity) {
SourceType sourceType = SourceType.forType(sourceEntity.getSourceType());
return sourceType.getTaskType().getType();
}
+ /**
+ * Get the agent command config by the agent ip.
+ *
+ * @param taskRequest task request info.
+ * @return agent command config list.
+ */
private List<CmdConfig> getAgentCmdConfigs(TaskRequest taskRequest) {
return sourceCmdConfigMapper.queryCmdByAgentIp(taskRequest.getAgentIp()).stream().map(cmd -> {
CmdConfig cmdConfig = new CmdConfig();
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
index 85d2e9f2b..41588ca9e 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
@@ -53,6 +53,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
+/**
+ * Audit service layer implementation
+ */
@Service
public class AuditServiceImpl implements AuditService {
@@ -66,12 +69,6 @@ public class AuditServiceImpl implements AuditService {
@Autowired
private ElasticsearchApi elasticsearchApi;
- /**
- * Query audit data for list by condition
- *
- * @param request The audit request of query condition
- * @return The result of query
- */
@Override
public List<AuditVO> listByCondition(AuditRequest request) throws IOException {
LOGGER.info("begin query audit list request={}", request);
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonDBServerServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonDBServerServiceImpl.java
index e0f966c5c..9c1f5c75c 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonDBServerServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonDBServerServiceImpl.java
@@ -45,6 +45,9 @@ import java.util.Date;
import java.util.HashSet;
import java.util.List;
+/**
+ * Common database server service layer implementation
+ */
@Slf4j
@Service
public class CommonDBServerServiceImpl implements CommonDBServerService {
@@ -54,16 +57,23 @@ public class CommonDBServerServiceImpl implements CommonDBServerService {
@Autowired
private CommonDbServerEntityMapper commonDbServerMapper;
+ /**
+ * Check if the string length is right.
+ *
+ * @param text string.
+ * @param maxLength max length for string.
+ * @return true or false.
+ */
public static boolean checkStrLen(String text, int maxLength) {
// too large.
return text != null && text.length() > maxLength;
}
/**
- * Check if the IP string is valid
+ * Check if the IP string is valid.
*
- * @param text IP string
- * @return true or false
+ * @param text IP string.
+ * @return true or false.
*/
public static boolean ipCheck(String text) {
if (text != null && !text.isEmpty()) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonFileServerServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonFileServerServiceImpl.java
index 5f4acfb6b..a1f930f53 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonFileServerServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/CommonFileServerServiceImpl.java
@@ -45,6 +45,9 @@ import java.util.Date;
import java.util.HashSet;
import java.util.List;
+/**
+ * Common file server service layer implementation
+ */
@Slf4j
@Service
public class CommonFileServerServiceImpl implements CommonFileServerService {
@@ -54,11 +57,24 @@ public class CommonFileServerServiceImpl implements CommonFileServerService {
@Autowired
private CommonFileServerEntityMapper commonFileServerMapper;
+ /**
+ * Check if the string length is right.
+ *
+ * @param text string.
+ * @param maxLength max length for string.
+ * @return true or false.
+ */
public static boolean checkStrLen(String text, int maxLength) {
// too large.
return text != null && text.length() > maxLength;
}
+ /**
+ * Check if the IP string is valid.
+ *
+ * @param text IP string.
+ * @return true or false.
+ */
public static boolean ipCheck(String text) {
if (text != null && !text.isEmpty()) {
// Define regular expression
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortServiceImpl.java
index 101dc6544..4b3406b57 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortServiceImpl.java
@@ -41,7 +41,9 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
-/** Sort service implementation. */
+/**
+ * Sort service implementation.
+ */
@Service
public class SortServiceImpl implements SortService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskIdParamServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskIdParamServiceImpl.java
index 27723c8a5..cab343d49 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskIdParamServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskIdParamServiceImpl.java
@@ -28,7 +28,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
-/** Sort id params service implementation. */
+/**
+ * Sort id params service implementation.
+ */
@Service
public class SortTaskIdParamServiceImpl implements SortTaskIdParamService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskSinkParamServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskSinkParamServiceImpl.java
index ea1bcadee..0cf5af26f 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskSinkParamServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/SortTaskSinkParamServiceImpl.java
@@ -29,7 +29,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
-/** Sort sink params service implementation. */
+/**
+ * Sort sink params service implementation.
+ */
@Service
public class SortTaskSinkParamServiceImpl implements SortTaskSinkParamService {
private static final Logger LOGGER = LoggerFactory.getLogger(SortTaskSinkParamServiceImpl.class);
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/StreamConfigLogServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/StreamConfigLogServiceImpl.java
index 2a8b899fb..cf1d8ab2b 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/StreamConfigLogServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/StreamConfigLogServiceImpl.java
@@ -39,6 +39,9 @@ import java.time.Instant;
import java.util.Date;
import java.util.List;
+/**
+ * Stream config log service layer implementation
+ */
@Service
public class StreamConfigLogServiceImpl extends AbstractService<StreamConfigLogEntity>
implements StreamConfigLogService {
@@ -81,11 +84,23 @@ public class StreamConfigLogServiceImpl extends AbstractService<StreamConfigLogE
return pageInfo;
}
+ /**
+ * Batch insert stream config log.
+ *
+ * @param entryList stream config log list.
+ * @return whether succeed.
+ */
public boolean batchInsertEntities(List<StreamConfigLogEntity> entryList) {
streamConfigLogEntityMapper.insertOrUpdateAll(entryList);
return true;
}
+ /**
+ * Convert request to stream config log info.
+ *
+ * @param request stream config log list.
+ * @return the updated stream config log info.
+ */
public StreamConfigLogEntity convertData(InlongStreamConfigLogRequest request) {
StreamConfigLogEntity entity = new StreamConfigLogEntity();
entity.setComponentName(request.getComponentName());
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/UserServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/UserServiceImpl.java
index 2e201d9a9..7f003f9c4 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/UserServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/UserServiceImpl.java
@@ -44,7 +44,7 @@ import java.util.List;
import static org.apache.inlong.manager.common.util.SmallTools.getOverDueDate;
/**
- * User service
+ * User service layer implementation
*/
@Slf4j
@Service
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLog.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLog.java
index 32c1076b9..40d3b6607 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLog.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLog.java
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apache.inlong.manager.common.enums.OperationType;
+/**
+ * The interface of operation log
+ */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLogPool.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLogPool.java
index 4a5caceba..1318f987f 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLogPool.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/operationlog/OperationLogPool.java
@@ -36,6 +36,9 @@ import org.apache.inlong.manager.dao.mapper.OperationLogEntityMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
+/**
+ * Operation log thread pool
+ */
@Slf4j
@Component
public class OperationLogPool {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/JarHell.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/JarHell.java
index ede9758e0..472fbe8d0 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/JarHell.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/JarHell.java
@@ -26,6 +26,9 @@ import java.util.Collections;
import java.util.List;
import java.util.Objects;
+/**
+ * Class for deal with jar hell.
+ */
public class JarHell {
public static final JavaVersion CURRENT_VERSION = new JavaVersion(Lists.newArrayList(1, 8), null);
@@ -72,10 +75,16 @@ public class JarHell {
return new JavaVersion(version, prePart);
}
+ /**
+ * Check the string if is vaild.
+ */
public static boolean isValid(String value) {
return value.matches("^0*[0-9]+(\\.[0-9]+)*(-[a-zA-Z0-9]+)?$");
}
+ /**
+ * Java version class
+ */
public static class JavaVersion {
private final List<Integer> version;
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoader.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoader.java
index 581275de3..e64940a54 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoader.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoader.java
@@ -43,6 +43,9 @@ import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.stream.Collectors;
+/**
+ * Plugin class loader.
+ */
@Slf4j
public class PluginClassLoader extends URLClassLoader {
@@ -66,6 +69,9 @@ public class PluginClassLoader extends URLClassLoader {
loadPluginDefinition();
}
+ /**
+ * Get pluginClassLoader by plugin url.
+ */
public static PluginClassLoader getFromPluginUrl(String url, ClassLoader parent) {
checkClassLoader(parent);
checkUrl(url);
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/CreateTubeGroupTaskListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/CreateTubeGroupTaskListener.java
index 7861c8937..3f59958ce 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/CreateTubeGroupTaskListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/CreateTubeGroupTaskListener.java
@@ -37,6 +37,9 @@ import org.springframework.stereotype.Component;
import java.util.Collections;
+/**
+ * Event listener of create tube consumer group.
+ */
@Component
@Slf4j
public class CreateTubeGroupTaskListener implements QueueOperateListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/PulsarEventSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/PulsarEventSelector.java
index fce1729fe..dcf7c2bf5 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/PulsarEventSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/PulsarEventSelector.java
@@ -26,6 +26,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.ProcessForm;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of pulsar event for create pulsar resource.
+ */
@Slf4j
public class PulsarEventSelector implements EventSelector {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeEventSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeEventSelector.java
index 884bbc2c8..ef1fbd431 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeEventSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeEventSelector.java
@@ -24,6 +24,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.ProcessForm;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of tube event for create tube source.
+ */
@Slf4j
public class TubeEventSelector implements EventSelector {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeMqOptService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeMqOptService.java
index f16c117af..515d5e7e7 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeMqOptService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/TubeMqOptService.java
@@ -35,6 +35,9 @@ import org.springframework.http.HttpMethod;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
+/**
+ * TubeMq operation service, such as create new topic, consumer group, etc.
+ */
@Slf4j
@Service
public class TubeMqOptService {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/util/PulsarUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/util/PulsarUtils.java
index 8bcd53fbe..70dfe7f52 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/util/PulsarUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/mq/util/PulsarUtils.java
@@ -62,6 +62,9 @@ public class PulsarUtils {
return PulsarAdmin.builder().serviceHttpUrl(serviceHttpUrl).build();
}
+ /**
+ * Get pulsar admin info.
+ */
private static PulsarAdmin getPulsarAdmin(String serviceHttpUrl, String authentication, String authenticationType)
throws PulsarClientException {
if (InlongGroupSettings.DEFAULT_PULSAR_AUTHENTICATION_TYPE.equals(authenticationType)) {
@@ -73,10 +76,16 @@ public class PulsarUtils {
}
}
+ /**
+ * Get pulsar cluster info list.
+ */
public static List<String> getPulsarClusters(PulsarAdmin pulsarAdmin) throws PulsarAdminException {
return pulsarAdmin.clusters().getClusters();
}
+ /**
+ * Get pulsar cluster service url.
+ */
public static String getServiceUrl(PulsarAdmin pulsarAdmin, String pulsarCluster) throws PulsarAdminException {
return pulsarAdmin.clusters().getCluster(pulsarCluster).getServiceUrl();
}
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/ck/ClickHouseResourceOperator.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/ck/ClickHouseResourceOperator.java
index a0e363cab..91fd00b36 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/ck/ClickHouseResourceOperator.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/ck/ClickHouseResourceOperator.java
@@ -40,6 +40,9 @@ import java.util.List;
import static java.util.stream.Collectors.toList;
+/**
+ * Operator for clickHouse resource, such as create sink resource, clickHouse tables, etc.
+ */
@Service
public class ClickHouseResourceOperator implements SinkResourceOperator {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchConfig.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchConfig.java
index 733c69044..18f49cee3 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchConfig.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchConfig.java
@@ -33,6 +33,9 @@ import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
+/**
+ * Elasticsearch config information, including host, port, etc.
+ */
@Component
public class ElasticsearchConfig {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/ck/ClickHouseSinkOperation.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/ck/ClickHouseSinkOperation.java
index a29d34da4..f5f618ce4 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/ck/ClickHouseSinkOperation.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/ck/ClickHouseSinkOperation.java
@@ -55,7 +55,7 @@ import java.util.List;
import java.util.function.Supplier;
/**
- * ClickHouse sink operation
+ * Click house sink operation, such as save or update click house field, etc.
*/
@Service
public class ClickHouseSinkOperation implements StreamSinkOperation {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/iceberg/IcebergSinkOperation.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/iceberg/IcebergSinkOperation.java
index f98798b48..d0c01423c 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/iceberg/IcebergSinkOperation.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sink/iceberg/IcebergSinkOperation.java
@@ -53,6 +53,9 @@ import java.util.Date;
import java.util.List;
import java.util.function.Supplier;
+/**
+ * Iceberg sink operation, such as save or update iceberg field, etc.
+ */
@Service
public class IcebergSinkOperation implements StreamSinkOperation {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortListener.java
index d807670dc..da4e6b50c 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortListener.java
@@ -52,6 +52,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Event listener of creat light group sort config.
+ */
@Component
public class LightGroupSortListener implements SortOperateListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortSelector.java
index 438098234..459f108a0 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/light/LightGroupSortSelector.java
@@ -28,6 +28,9 @@ import org.apache.inlong.manager.workflow.event.EventSelector;
import java.util.List;
+/**
+ * Selector of light group sort.
+ */
@Slf4j
public class LightGroupSortSelector implements EventSelector {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/ExtractNodeUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/ExtractNodeUtils.java
index 6ac8612b4..073ba8c9e 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/ExtractNodeUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/ExtractNodeUtils.java
@@ -76,8 +76,8 @@ public class ExtractNodeUtils {
/**
* Create MySqlExtractNode based on BinlogSourceResponse
*
- * @param binlogSourceResponse
- * @return
+ * @param binlogSourceResponse binlog source response info
+ * @return MySql extract node info
*/
public static MySqlExtractNode createExtractNode(BinlogSourceResponse binlogSourceResponse) {
final String id = binlogSourceResponse.getSourceName();
@@ -133,8 +133,8 @@ public class ExtractNodeUtils {
/**
* Create KafkaExtractNode based KafkaSourceResponse
*
- * @param kafkaSourceResponse
- * @return
+ * @param kafkaSourceResponse kafka source response
+ * @return kafka extract node info
*/
public static KafkaExtractNode createExtractNode(KafkaSourceResponse kafkaSourceResponse) {
String id = kafkaSourceResponse.getSourceName();
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FieldRelationShipUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FieldRelationShipUtils.java
index 51769a38f..a558064b6 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FieldRelationShipUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FieldRelationShipUtils.java
@@ -48,6 +48,9 @@ import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
+/**
+ * Util for creat field relation ship.
+ */
public class FieldRelationShipUtils {
public static List<FieldRelationShip> createFieldRelationShips(TransformResponse transformResponse) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FilterFunctionUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FilterFunctionUtils.java
index b53f31917..572fb0ea9 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FilterFunctionUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/FilterFunctionUtils.java
@@ -53,6 +53,9 @@ import org.apache.inlong.sort.protocol.transformation.operator.OrOperator;
import java.util.List;
import java.util.stream.Collectors;
+/**
+ * Util for creat filter function.
+ */
public class FilterFunctionUtils {
public static List<FilterFunction> createFilterFunctions(TransformResponse transformResponse) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/LoadNodeUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/LoadNodeUtils.java
index 8072f5d94..358668fbf 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/LoadNodeUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/LoadNodeUtils.java
@@ -42,6 +42,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Util for loead node info.
+ */
public class LoadNodeUtils {
public static List<LoadNode> createLoadNodes(List<SinkResponse> sinkResponses) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/NodeRelationShipUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/NodeRelationShipUtils.java
index 444680ab1..c3e0c8734 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/NodeRelationShipUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/NodeRelationShipUtils.java
@@ -55,6 +55,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Util for creat node relation ship.
+ */
@Slf4j
public class NodeRelationShipUtils {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SinkInfoUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SinkInfoUtils.java
index cf070ec43..ebfb864f5 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SinkInfoUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SinkInfoUtils.java
@@ -51,6 +51,9 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
+/**
+ * Utils for create sink info, such as kafka sink, clickhouse sink, etc.
+ */
public class SinkInfoUtils {
private static final String DATA_FORMAT = "yyyyMMddHH";
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SourceInfoUtils.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SourceInfoUtils.java
index 833b21f48..8e5f4b6f0 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SourceInfoUtils.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/sort/util/SourceInfoUtils.java
@@ -39,7 +39,7 @@ import org.apache.inlong.sort.protocol.source.TubeSourceInfo;
import java.util.List;
/**
- * Utils for source info
+ * Utils for creat source info, such as pulsar source, tube MQ source.
*/
public class SourceInfoUtils {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/file/FileSourceOperation.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/file/FileSourceOperation.java
index 79e078be1..6c39f3fb6 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/file/FileSourceOperation.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/file/FileSourceOperation.java
@@ -40,6 +40,9 @@ import org.springframework.stereotype.Service;
import java.util.function.Supplier;
+/**
+ * File source operation, such as get or set file source info.
+ */
@Service
public class FileSourceOperation extends AbstractSourceOperation {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/AbstractSourceOperateListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/AbstractSourceOperateListener.java
index 2e77e0e23..71a613e16 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/AbstractSourceOperateListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/AbstractSourceOperateListener.java
@@ -49,6 +49,9 @@ import org.springframework.stereotype.Component;
import java.util.List;
import java.util.concurrent.TimeUnit;
+/**
+ * Event listener of operate resources, such as delete, stop, restart sources.
+ */
@Slf4j
@Component
public abstract class AbstractSourceOperateListener implements DataSourceOperateListener {
@@ -86,6 +89,9 @@ public abstract class AbstractSourceOperateListener implements DataSourceOperate
}
}
+ /**
+ * Operate stream sources ,such as delete, stop, restart.
+ */
protected void operateStreamSources(String groupId, String streamId, String operator,
List<SourceResponse> unOperatedSources) {
List<SourceResponse> sourceResponses = streamSourceService.listSource(groupId, streamId);
@@ -124,6 +130,12 @@ public abstract class AbstractSourceOperateListener implements DataSourceOperate
return false;
}
+ /**
+ * Creat source request by source type.
+ *
+ * @param sourceResponse source infomation.
+ * @return source request.
+ */
public SourceRequest createSourceRequest(SourceResponse sourceResponse) {
String sourceType = sourceResponse.getSourceType();
SourceType type = SourceType.valueOf(sourceType);
@@ -138,6 +150,9 @@ public abstract class AbstractSourceOperateListener implements DataSourceOperate
}
}
+ /**
+ * Operate stream sources ,such as delete, stop, restart.
+ */
public abstract void operateStreamSource(SourceRequest sourceRequest, String operator);
private GroupOperateType getOperateType(ProcessForm processForm) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteEventSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteEventSelector.java
index 23b2d134c..d38c43170 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteEventSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteEventSelector.java
@@ -23,6 +23,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of source delete event.
+ */
public class SourceDeleteEventSelector implements EventSelector {
@Override
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteListener.java
index 651545d07..16faeebb1 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceDeleteListener.java
@@ -21,6 +21,9 @@ import lombok.extern.slf4j.Slf4j;
import org.apache.inlong.manager.common.pojo.source.SourceRequest;
import org.springframework.stereotype.Component;
+/**
+ * Listener of source delete event.
+ */
@Slf4j
@Component
public class SourceDeleteListener extends AbstractSourceOperateListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartEventSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartEventSelector.java
index f82b31c8b..554c85546 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartEventSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartEventSelector.java
@@ -23,6 +23,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of source restart event.
+ */
public class SourceRestartEventSelector implements EventSelector {
@Override
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartListener.java
index dab7b43c5..7422c2312 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceRestartListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.service.source.listener;
import org.apache.inlong.manager.common.pojo.source.SourceRequest;
import org.springframework.stereotype.Component;
+/**
+ * Listener of source restart event.
+ */
@Component
public class SourceRestartListener extends AbstractSourceOperateListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopEventSelector.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopEventSelector.java
index 83035b53a..7b647d4b4 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopEventSelector.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopEventSelector.java
@@ -23,6 +23,9 @@ import org.apache.inlong.manager.common.pojo.workflow.form.UpdateGroupProcessFor
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.EventSelector;
+/**
+ * Selector of source stop event.
+ */
public class SourceStopEventSelector implements EventSelector {
@Override
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopListener.java
index 369f0a236..6203fccca 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/source/listener/SourceStopListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.service.source.listener;
import org.apache.inlong.manager.common.pojo.source.SourceRequest;
import org.springframework.stereotype.Component;
+/**
+ * Listener of source stop event.
+ */
@Component
public class SourceStopListener extends AbstractSourceOperateListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactory.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactory.java
index 8455a628e..6ada81f8d 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactory.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactory.java
@@ -60,6 +60,9 @@ import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Service task listener factory.
+ */
@Data
@Component
public class ServiceTaskListenerFactory implements PluginBinder, ServiceTaskListenerProvider {
@@ -148,6 +151,9 @@ public class ServiceTaskListenerFactory implements PluginBinder, ServiceTaskList
}
}
+ /**
+ * Get data source operate listener list.
+ */
public List<DataSourceOperateListener> getSourceOperateListener(WorkflowContext context) {
List<DataSourceOperateListener> listeners = new ArrayList<>();
for (Map.Entry<DataSourceOperateListener, EventSelector> entry : sourceOperateListeners.entrySet()) {
@@ -159,6 +165,9 @@ public class ServiceTaskListenerFactory implements PluginBinder, ServiceTaskList
return listeners;
}
+ /**
+ * Get queue operate listener list.
+ */
public List<QueueOperateListener> getQueueOperateListener(WorkflowContext context) {
List<QueueOperateListener> listeners = new ArrayList<>();
for (Map.Entry<QueueOperateListener, EventSelector> entry : queueOperateListeners.entrySet()) {
@@ -170,6 +179,9 @@ public class ServiceTaskListenerFactory implements PluginBinder, ServiceTaskList
return listeners;
}
+ /**
+ * Get sort operate listener list.
+ */
public List<SortOperateListener> getSortOperateListener(WorkflowContext context) {
List<SortOperateListener> listeners = new ArrayList<>();
for (Map.Entry<SortOperateListener, EventSelector> entry : sortOperateListeners.entrySet()) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/WorkflowExecuteLog.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/WorkflowExecuteLog.java
index f97b8a419..cf887705b 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/WorkflowExecuteLog.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/WorkflowExecuteLog.java
@@ -139,6 +139,9 @@ public class WorkflowExecuteLog {
@ApiModelProperty("Description")
private String description;
+ /**
+ * Get listener executor log.
+ */
public static ListenerExecutorLog fromEventLog(WorkflowEventLogEntity workflowEventLogEntity) {
ListenerExecutorLog executorLog = ListenerExecutorLog.builder()
.id(workflowEventLogEntity.getId())
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/light/SuspendLightGroupWorkflowDefinition.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/light/SuspendLightGroupWorkflowDefinition.java
index 8d0578e13..17ffc911a 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/light/SuspendLightGroupWorkflowDefinition.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/light/SuspendLightGroupWorkflowDefinition.java
@@ -33,6 +33,9 @@ import org.apache.inlong.manager.workflow.definition.WorkflowProcess;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
+/**
+ * Suspend light workflow definition for inlong group
+ */
@Slf4j
@Component
public class SuspendLightGroupWorkflowDefinition implements WorkflowDefinition {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupCompleteListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupCompleteListener.java
index dacb14dfc..6dbf66203 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupCompleteListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupCompleteListener.java
@@ -32,6 +32,9 @@ import org.apache.inlong.manager.workflow.event.process.ProcessEventListener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
+/**
+ * Listener of light group complete.
+ */
@Slf4j
@Component
public class LightGroupCompleteListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupFailedListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupFailedListener.java
index 9a585259e..d478ed74a 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupFailedListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupFailedListener.java
@@ -30,6 +30,9 @@ import org.apache.inlong.manager.workflow.event.process.ProcessEventListener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
+/**
+ * Listener of light group failed.
+ */
@Slf4j
@Component
public class LightGroupFailedListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupInitListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupInitListener.java
index 5aa43de08..6c2627705 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupInitListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupInitListener.java
@@ -36,6 +36,9 @@ import org.springframework.stereotype.Component;
import java.util.List;
+/**
+ * Listener of light group init.
+ */
@Slf4j
@Component
public class LightGroupInitListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateCompleteListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateCompleteListener.java
index bd47438b0..6b2fc678b 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateCompleteListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateCompleteListener.java
@@ -36,6 +36,9 @@ import org.springframework.stereotype.Component;
import java.util.List;
+/**
+ * Listener of light group update complete.
+ */
@Slf4j
@Component
public class LightGroupUpdateCompleteListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateFailedListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateFailedListener.java
index 0f8342a5c..4f84ad864 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateFailedListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateFailedListener.java
@@ -29,6 +29,9 @@ import org.apache.inlong.manager.workflow.event.process.ProcessEventListener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
+/**
+ * Listener of light group update failed.
+ */
@Slf4j
@Component
public class LightGroupUpdateFailedListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateListener.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateListener.java
index ee77a0558..f520c1073 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateListener.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/workflow/group/listener/light/LightGroupUpdateListener.java
@@ -34,6 +34,9 @@ import org.springframework.stereotype.Component;
import java.util.List;
+/**
+ * Listener of light group update.
+ */
@Slf4j
@Component
public class LightGroupUpdateListener implements ProcessEventListener {
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/RestTemplateConfig.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/RestTemplateConfig.java
index 858878f6f..9306364bc 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/RestTemplateConfig.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/RestTemplateConfig.java
@@ -42,6 +42,9 @@ import org.springframework.web.client.RestTemplate;
import java.nio.charset.StandardCharsets;
import java.util.List;
+/**
+ * Test class for rest template config.
+ */
@Data
@Configuration
@ConditionalOnMissingBean(RestTemplate.class)
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/ServiceBaseTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/ServiceBaseTest.java
index 1c8b12855..e1e218932 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/ServiceBaseTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/ServiceBaseTest.java
@@ -25,6 +25,9 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+/**
+ * Test class for base test service.
+ */
@SpringBootApplication
@SpringBootTest(classes = ServiceBaseTest.class)
@EnableWebMvc
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AgentServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AgentServiceTest.java
index 3723ce21e..9b6edbfc5 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AgentServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AgentServiceTest.java
@@ -43,6 +43,9 @@ public class AgentServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save source info.
+ */
public Integer saveSource() {
streamServiceTest.saveInlongStream(GLOBAL_GROUP_ID, GLOBAL_STREAM_ID, GLOBAL_OPERATOR);
@@ -54,6 +57,9 @@ public class AgentServiceTest extends ServiceBaseTest {
return sourceService.save(sourceInfo, GLOBAL_OPERATOR);
}
+ /**
+ * Test report snapshot.
+ */
@Test
public void testReportSnapshot() {
Integer id = this.saveSource();
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AuditServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AuditServiceTest.java
index e198b51ad..755e3a78e 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AuditServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/AuditServiceTest.java
@@ -31,6 +31,9 @@ import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+/**
+ * Audit service test for {@link AuditService}
+ */
public class AuditServiceTest extends ServiceBaseTest {
@Autowired
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/HeartbeatServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/HeartbeatServiceTest.java
index 06d0cc5d2..6cd3d7c93 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/HeartbeatServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/HeartbeatServiceTest.java
@@ -51,6 +51,9 @@ import java.util.List;
import static org.mockito.BDDMockito.given;
+/**
+ * Heartbeat service test.
+ */
@RunWith(SpringRunner.class)
public class HeartbeatServiceTest {
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/InlongGroupProcessOperationTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/InlongGroupProcessOperationTest.java
index 1b5468a80..45c947f81 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/InlongGroupProcessOperationTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/InlongGroupProcessOperationTest.java
@@ -34,6 +34,9 @@ import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+/**
+ * Inlong group process operation service test.
+ */
@EnableAutoConfiguration
public class InlongGroupProcessOperationTest extends ServiceBaseTest {
@@ -52,6 +55,9 @@ public class InlongGroupProcessOperationTest extends ServiceBaseTest {
@Autowired
private ServiceTaskListenerFactory serviceTaskListenerFactory;
+ /**
+ * Set some base infomation before satart process.
+ */
public void before() {
MockPlugin mockPlugin = new MockPlugin();
serviceTaskListenerFactory.acceptPlugin(mockPlugin);
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/SortServiceImplTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/SortServiceImplTest.java
index 9c3f0a30a..91069a55d 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/SortServiceImplTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/impl/SortServiceImplTest.java
@@ -32,16 +32,17 @@ import org.springframework.transaction.annotation.Transactional;
import java.util.HashMap;
import java.util.Map;
+/**
+ * Sort service test for {@link SortService}
+ */
public class SortServiceImplTest extends ServiceBaseTest {
- @Autowired
- private SortService sortService;
-
- @Autowired
- SortSourceConfigEntityMapper sourceMapper;
-
private static final String TEST_CLUSTER = "testCluster";
private static final String TEST_TASK = "testTask";
+ @Autowired
+ SortSourceConfigEntityMapper sourceMapper;
+ @Autowired
+ private SortService sortService;
@Test
@Transactional
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/JarHellTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/JarHellTest.java
index 83742c8e5..222c1cd19 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/JarHellTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/JarHellTest.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.service.core.plugin;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Test class for deal with jar hell.
+ */
public class JarHellTest {
@Test
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoaderTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoaderTest.java
index e7707e273..7402551af 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoaderTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginClassLoaderTest.java
@@ -28,6 +28,9 @@ import org.junit.Test;
import java.lang.reflect.InvocationTargetException;
import java.util.Map;
+/**
+ * Test class for load plugin.
+ */
public class PluginClassLoaderTest {
@Test
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginServiceTest.java
index c99f0b5d0..f185590f8 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/plugin/PluginServiceTest.java
@@ -27,6 +27,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import java.util.List;
import java.util.Objects;
+/**
+ * Test class for reload plugin.
+ */
public class PluginServiceTest extends ServiceBaseTest {
@Autowired
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/ClickHouseStreamSinkServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/ClickHouseStreamSinkServiceTest.java
index d53c95b77..36afe6647 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/ClickHouseStreamSinkServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/ClickHouseStreamSinkServiceTest.java
@@ -50,6 +50,9 @@ public class ClickHouseStreamSinkServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save sink info.
+ */
public Integer saveSink(String sinkName) {
streamServiceTest.saveInlongStream(globalGroupId, globalStreamId, globalOperator);
ClickHouseSinkRequest sinkInfo = new ClickHouseSinkRequest();
@@ -66,6 +69,9 @@ public class ClickHouseStreamSinkServiceTest extends ServiceBaseTest {
return sinkService.save(sinkInfo, globalOperator);
}
+ /**
+ * Delete kafka sink by sink id.
+ */
public void deleteKafkaSink(Integer sinkId) {
boolean result = sinkService.delete(sinkId, globalOperator);
Assert.assertTrue(result);
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/HiveStreamSinkServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/HiveStreamSinkServiceTest.java
index e8dae7372..cfde4fb46 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/HiveStreamSinkServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/HiveStreamSinkServiceTest.java
@@ -45,6 +45,9 @@ public class HiveStreamSinkServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save sink info.
+ */
public Integer saveSink() {
streamServiceTest.saveInlongStream(globalGroupId, globalStreamId, globalOperator);
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/IcebergStreamSinkServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/IcebergStreamSinkServiceTest.java
index 9bbe253b2..7b0e84f14 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/IcebergStreamSinkServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/IcebergStreamSinkServiceTest.java
@@ -30,6 +30,9 @@ import org.junit.Assert;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
+/**
+ * Iceberg stream sink service test..
+ */
public class IcebergStreamSinkServiceTest extends ServiceBaseTest {
private final String globalGroupId = "b_group1";
@@ -42,6 +45,9 @@ public class IcebergStreamSinkServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save sink info.
+ */
public Integer saveSink(String sinkName) {
streamServiceTest.saveInlongStream(globalGroupId, globalStreamId, globalOperator);
IcebergSinkRequest sinkInfo = new IcebergSinkRequest();
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/KafkaStreamSinkServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/KafkaStreamSinkServiceTest.java
index 4f7079e61..6c1369a93 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/KafkaStreamSinkServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/sink/KafkaStreamSinkServiceTest.java
@@ -49,6 +49,9 @@ public class KafkaStreamSinkServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save sink info.
+ */
public Integer saveSink(String sinkName) {
streamServiceTest.saveInlongStream(globalGroupId, globalStreamId, globalOperator);
KafkaSinkRequest sinkInfo = new KafkaSinkRequest();
@@ -63,6 +66,9 @@ public class KafkaStreamSinkServiceTest extends ServiceBaseTest {
return sinkService.save(sinkInfo, globalOperator);
}
+ /**
+ * Delete kafka sink info by sink id.
+ */
public void deleteKafkaSink(Integer kafkaSinkId) {
boolean result = sinkService.delete(kafkaSinkId, globalOperator);
Assert.assertTrue(result);
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/source/StreamSourceServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/source/StreamSourceServiceTest.java
index dff9e8f04..a1fbbcf90 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/source/StreamSourceServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/core/source/StreamSourceServiceTest.java
@@ -44,6 +44,9 @@ public class StreamSourceServiceTest extends ServiceBaseTest {
@Autowired
private InlongStreamServiceTest streamServiceTest;
+ /**
+ * Save source info.
+ */
public Integer saveSource() {
streamServiceTest.saveInlongStream(globalGroupId, globalStreamId, globalOperator);
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSortListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSortListener.java
index 936c8b8fe..7a56c7796 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSortListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSortListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.SortOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen delete sort event.
+ */
public class MockDeleteSortListener implements SortOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSourceListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSourceListener.java
index 5ee75b75e..e92705ba2 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSourceListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockDeleteSourceListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.DataSourceOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen delete source event.
+ */
public class MockDeleteSourceListener implements DataSourceOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockPlugin.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockPlugin.java
index d879ff305..a3531dcd7 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockPlugin.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockPlugin.java
@@ -29,6 +29,9 @@ import org.apache.inlong.manager.workflow.plugin.ProcessPlugin;
import java.util.HashMap;
import java.util.Map;
+/**
+ * Test class for process plugin.
+ */
public class MockPlugin implements ProcessPlugin {
public EventSelector stopProcessSelector = new EventSelector() {
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSortListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSortListener.java
index f023c77a7..6c0042dde 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSortListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSortListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.SortOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen restart sort event.
+ */
public class MockRestartSortListener implements SortOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSourceListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSourceListener.java
index 5bfb209e5..94da16417 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSourceListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockRestartSourceListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.DataSourceOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen restart source event.
+ */
public class MockRestartSourceListener implements DataSourceOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSortListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSortListener.java
index cebb11249..a82449358 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSortListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSortListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.SortOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen stop sort event.
+ */
public class MockStopSortListener implements SortOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSourceListener.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSourceListener.java
index 97ca6d6f1..5ea4a5ab5 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSourceListener.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mocks/MockStopSourceListener.java
@@ -22,6 +22,9 @@ import org.apache.inlong.manager.workflow.event.ListenerResult;
import org.apache.inlong.manager.workflow.event.task.DataSourceOperateListener;
import org.apache.inlong.manager.workflow.event.task.TaskEvent;
+/**
+ * Test class for listen stop source event.
+ */
public class MockStopSourceListener implements DataSourceOperateListener {
@Override
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mq/util/PulsarUtilsTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mq/util/PulsarUtilsTest.java
index 7c0470692..af7359806 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mq/util/PulsarUtilsTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/mq/util/PulsarUtilsTest.java
@@ -32,6 +32,9 @@ import org.springframework.util.ReflectionUtils;
import java.lang.reflect.Field;
import java.util.ArrayList;
+/**
+ * Test class for pulsar utils.
+ */
public class PulsarUtilsTest {
// There will be concurrency problems in the overall operation,This method temporarily fails the test
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/sort/DisableZkForSortTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/sort/DisableZkForSortTest.java
index 45193b04f..750c74236 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/sort/DisableZkForSortTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/sort/DisableZkForSortTest.java
@@ -51,6 +51,9 @@ import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Collectors;
+/**
+ * Test class for listen delete sort event.
+ */
public class DisableZkForSortTest extends WorkflowServiceImplTest {
@@ -68,6 +71,9 @@ public class DisableZkForSortTest extends WorkflowServiceImplTest {
subType = "DisableZkFor";
}
+ /**
+ * Creat hvie sink by inlong stream info.
+ */
public HiveSinkRequest createHiveSink(InlongStreamInfo streamInfo) {
HiveSinkRequest hiveSinkRequest = new HiveSinkRequest();
hiveSinkRequest.setInlongGroupId(streamInfo.getInlongGroupId());
@@ -100,6 +106,9 @@ public class DisableZkForSortTest extends WorkflowServiceImplTest {
return hiveSinkRequest;
}
+ /**
+ * Creat kafka source info by inlong stream info.
+ */
public KafkaSourceRequest createKafkaSource(InlongStreamInfo streamInfo) {
KafkaSourceRequest kafkaSourceRequest = new KafkaSourceRequest();
kafkaSourceRequest.setInlongGroupId(streamInfo.getInlongGroupId());
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/source/listener/DataSourceListenerTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/source/listener/DataSourceListenerTest.java
index 4db4d2e6d..8a6daeaea 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/source/listener/DataSourceListenerTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/source/listener/DataSourceListenerTest.java
@@ -41,6 +41,9 @@ import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
+/**
+ * Test class for operate binlog source, such as frozen or restart.
+ */
public class DataSourceListenerTest extends WorkflowServiceImplTest {
public UpdateGroupProcessForm form;
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/transform/StreamTransformServiceTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/transform/StreamTransformServiceTest.java
index a03fbf0e6..bc7f45c9f 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/transform/StreamTransformServiceTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/transform/StreamTransformServiceTest.java
@@ -35,6 +35,9 @@ import springfox.boot.starter.autoconfigure.OpenApiAutoConfiguration;
import java.util.Date;
import java.util.List;
+/**
+ * Test class for save stream transform.
+ */
@RunWith(SpringJUnit4ClassRunner.class)
@EnableAutoConfiguration(exclude = OpenApiAutoConfiguration.class)
public class StreamTransformServiceTest extends ServiceBaseTest {
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactoryTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactoryTest.java
index 2339d7c30..4239f67f1 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactoryTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/ServiceTaskListenerFactoryTest.java
@@ -34,6 +34,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import java.util.List;
+/**
+ * Test class for get queue operate listener.
+ */
public class ServiceTaskListenerFactoryTest extends ServiceBaseTest {
@Autowired
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowServiceImplTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowServiceImplTest.java
index 81e392c63..8c027b086 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowServiceImplTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowServiceImplTest.java
@@ -76,6 +76,9 @@ import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+/**
+ * Test class for workflow service.
+ */
@RunWith(SpringJUnit4ClassRunner.class)
@EnableAutoConfiguration(exclude = OpenApiAutoConfiguration.class)
public class WorkflowServiceImplTest extends ServiceBaseTest {
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/group/CreateGroupWorkflowDefinitionTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/group/CreateGroupWorkflowDefinitionTest.java
index 41c27394b..d5f7a41a9 100644
--- a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/group/CreateGroupWorkflowDefinitionTest.java
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/group/CreateGroupWorkflowDefinitionTest.java
@@ -23,6 +23,9 @@ import org.junit.Assert;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
+/**
+ * Test class for ldefine process.
+ */
public class CreateGroupWorkflowDefinitionTest extends ServiceBaseTest {
@Autowired
diff --git a/inlong-manager/manager-test/src/main/java/org/apache/inlong/manager/test/BaseTest.java b/inlong-manager/manager-test/src/main/java/org/apache/inlong/manager/test/BaseTest.java
index a9b9f3a54..7a9d74361 100644
--- a/inlong-manager/manager-test/src/main/java/org/apache/inlong/manager/test/BaseTest.java
+++ b/inlong-manager/manager-test/src/main/java/org/apache/inlong/manager/test/BaseTest.java
@@ -28,6 +28,9 @@ import javax.annotation.PostConstruct;
import javax.sql.DataSource;
import org.springframework.test.context.junit4.SpringRunner;
+/**
+ * Class of base test.
+ */
@ActiveProfiles(value = {"test"})
@EnableConfigurationProperties
@ComponentScan(basePackages = "org.apache.inlong.manager")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/AuthenticationFilter.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/AuthenticationFilter.java
index 2931e8b1a..4eb751aed 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/AuthenticationFilter.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/AuthenticationFilter.java
@@ -36,6 +36,9 @@ import org.apache.shiro.subject.Subject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Filter of authentication.
+ */
@Slf4j
public class AuthenticationFilter implements Filter {
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/ShiroConfig.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/ShiroConfig.java
index 165efff4c..5c327e362 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/ShiroConfig.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/ShiroConfig.java
@@ -31,6 +31,9 @@ import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
+/**
+ * Inlong hiro config.
+ */
@Configuration
public class ShiroConfig {
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/WebAuthorizingRealm.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/WebAuthorizingRealm.java
index d71c3f958..174ad36c1 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/WebAuthorizingRealm.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/WebAuthorizingRealm.java
@@ -35,6 +35,9 @@ import org.apache.shiro.subject.PrincipalCollection;
import java.util.Date;
+/**
+ * Web user authorization.
+ */
public class WebAuthorizingRealm extends AuthorizingRealm {
private final UserService userService;
@@ -45,10 +48,6 @@ public class WebAuthorizingRealm extends AuthorizingRealm {
/**
* Login authentication
- *
- * @param authenticationToken
- * @return
- * @throws AuthenticationException
*/
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken)
@@ -67,9 +66,6 @@ public class WebAuthorizingRealm extends AuthorizingRealm {
/**
* URI access control
- *
- * @param principalCollection
- * @return
*/
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/impl/InlongShiroImpl.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/impl/InlongShiroImpl.java
index 44c938af2..a10953149 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/impl/InlongShiroImpl.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/auth/impl/InlongShiroImpl.java
@@ -38,6 +38,9 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.stereotype.Component;
+/**
+ * Inlong shiro service layer implementation.
+ */
@ConditionalOnProperty(name = "type", prefix = "inlong.auth", havingValue = "default")
@Component
public class InlongShiroImpl implements InlongShiro {
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/config/ControllerExceptionHandler.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/config/ControllerExceptionHandler.java
index 457c1063b..2276b4246 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/config/ControllerExceptionHandler.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/config/ControllerExceptionHandler.java
@@ -38,6 +38,9 @@ import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.Set;
+/**
+ * Hander of controller exception.
+ */
@Slf4j
@ControllerAdvice
public class ControllerExceptionHandler {
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AnnoController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AnnoController.java
index 126866833..b3b7480b6 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AnnoController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AnnoController.java
@@ -35,6 +35,9 @@ import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Anno controller.
+ */
@Slf4j
@RestController
@RequestMapping("/anno")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AuditController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AuditController.java
index e8f47919b..a1a232423 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AuditController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/AuditController.java
@@ -31,6 +31,9 @@ import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Audit controller.
+ */
@RestController
@RequestMapping("/audit")
@Api(tags = "Audit")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonDBServerController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonDBServerController.java
index 55f60ab0f..b465f2167 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonDBServerController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonDBServerController.java
@@ -63,6 +63,9 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
+/**
+ * Common database server controller.
+ */
@RestController
@RequestMapping("commonserver/db")
@Api(tags = "Common Server - DB")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonFileServerController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonFileServerController.java
index d1164b1d4..16934e7cc 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonFileServerController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/CommonFileServerController.java
@@ -64,6 +64,9 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
+/**
+ * Common file server controller.
+ */
@RestController
@RequestMapping("commonserver/file")
@Api(tags = "Common Server - File")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/HeartbeatController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/HeartbeatController.java
index 080f0a80f..9eba55282 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/HeartbeatController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/HeartbeatController.java
@@ -33,6 +33,9 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Heartbeat controller.
+ */
@RestController
@RequestMapping("/heartbeat")
@Api(tags = "Heartbeat-API")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/StreamConfigLogWebController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/StreamConfigLogWebController.java
index 45a11ed34..9757e454d 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/StreamConfigLogWebController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/StreamConfigLogWebController.java
@@ -29,6 +29,9 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Stream config log controller.
+ */
@RestController
@RequestMapping("/stream/config/log")
@Api(tags = "Stream Config log")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/AgentController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/AgentController.java
index e75b52eb5..f1a7fd494 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/AgentController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/AgentController.java
@@ -33,6 +33,9 @@ import org.springframework.web.bind.annotation.RestController;
import java.util.List;
+/**
+ * Agent controller.
+ */
@RestController
@RequestMapping("/openapi/agent")
@Api(tags = "Agent Config")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DBCollectorController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DBCollectorController.java
index 0053a5036..679b33ca9 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DBCollectorController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DBCollectorController.java
@@ -30,6 +30,9 @@ import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Database collector controller.
+ */
@RestController
@RequestMapping("/openapi/dbCollector")
@Api(tags = "DBCollector Config")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DataProxyController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DataProxyController.java
index d8a724d84..5ee5986ff 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DataProxyController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/DataProxyController.java
@@ -33,6 +33,9 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
+/**
+ * Data proxy controller.
+ */
@RestController
@RequestMapping("/openapi/dataproxy")
@Api(tags = "DataProxy-Config")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenHeartbeatController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenHeartbeatController.java
index 5dbf44a34..9f32fe498 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenHeartbeatController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/OpenHeartbeatController.java
@@ -28,6 +28,9 @@ import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Open heartbeat controller.
+ */
@RestController
@RequestMapping("/openapi/heartbeat")
@Api(tags = "Open-Heartbeat-API")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/SortController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/SortController.java
index 8797b49e2..4a7d0020b 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/SortController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/SortController.java
@@ -28,6 +28,9 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Sort controller.
+ */
@RestController
@RequestMapping("/openapi/sort")
@Api(tags = "Sort Config")
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/StreamConfigLogController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/StreamConfigLogController.java
index 4fe03f150..9ba03c6cc 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/StreamConfigLogController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/openapi/StreamConfigLogController.java
@@ -29,6 +29,9 @@ import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
+/**
+ * Inlong stream config controller.
+ */
@RestController
@RequestMapping("/openapi/stream")
@Api(tags = "Stream Config")
diff --git a/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/config/RestTemplateConfigTest.java b/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/config/RestTemplateConfigTest.java
index 4f3ce50c3..869e3b080 100644
--- a/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/config/RestTemplateConfigTest.java
+++ b/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/config/RestTemplateConfigTest.java
@@ -22,6 +22,9 @@ import org.junit.Assert;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
+/**
+ * Test class for rest template config.
+ */
public class RestTemplateConfigTest extends WebBaseTest {
private final int maxTotal = 5000;
diff --git a/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/controller/openapi/SortControllerTest.java b/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/controller/openapi/SortControllerTest.java
index a05e1a7a3..86f922920 100644
--- a/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/controller/openapi/SortControllerTest.java
+++ b/inlong-manager/manager-web/src/test/java/org/apache/inlong/manager/web/controller/openapi/SortControllerTest.java
@@ -37,6 +37,9 @@ import static org.springframework.test.web.servlet.request.MockMvcRequestBuilder
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+/**
+ * Test class for sort controller.
+ */
public class SortControllerTest extends WebBaseTest {
private static final Logger logger = LoggerFactory.getLogger(SortControllerTest.class);
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowProcess.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowProcess.java
index f1d2b6aac..e342f4346 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowProcess.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowProcess.java
@@ -69,6 +69,9 @@ public class WorkflowProcess extends Element {
private int version;
+ /**
+ * Add listener to workflow process.
+ */
public WorkflowProcess addListener(ProcessEventListener listener) {
if (nameToListenerMap.containsKey(listener.name())) {
throw new WorkflowListenerException("duplicate listener:" + listener.name());
@@ -82,18 +85,33 @@ public class WorkflowProcess extends Element {
return this;
}
+ /**
+ * Get async process event listener list.
+ */
public List<ProcessEventListener> asyncListeners(ProcessEvent processEvent) {
return this.asyncListeners.getOrDefault(processEvent, ProcessEventListener.EMPTY_LIST);
}
+ /**
+ * Get sync process event listener list.
+ */
public List<ProcessEventListener> syncListeners(ProcessEvent processEvent) {
return this.syncListeners.getOrDefault(processEvent, ProcessEventListener.EMPTY_LIST);
}
+ /**
+ * Get process event listener by listener name.
+ *
+ * @param listenerName listener name.
+ * @return process event listener.
+ */
public ProcessEventListener listener(String listenerName) {
return this.nameToListenerMap.get(listenerName);
}
+ /**
+ * Add workflow task.
+ */
public WorkflowProcess addTask(WorkflowTask task) {
if (this.nameToTaskMap.containsKey(task.getName())) {
throw new WorkflowException("task name cannot duplicate " + task.getName());
@@ -102,6 +120,12 @@ public class WorkflowProcess extends Element {
return this;
}
+ /**
+ * Get workflow task by task name.
+ *
+ * @param name workflow task name.
+ * @return workflow task info.
+ */
public WorkflowTask getTaskByName(String name) {
if (!this.nameToTaskMap.containsKey(name)) {
throw new WorkflowException("cannot find task with the name " + name);
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowTask.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowTask.java
index 28eeb9846..0e5ab03c4 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowTask.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/definition/WorkflowTask.java
@@ -45,6 +45,9 @@ public abstract class WorkflowTask extends NextableElement implements SkippableE
private Map<TaskEvent, List<TaskEventListener>> asyncListeners = Maps.newHashMap();
private Map<String, TaskEventListener> nameToListenerMap = Maps.newHashMap();
+ /**
+ * Add listener for workflow task.
+ */
public WorkflowTask addListener(TaskEventListener listener) {
if (nameToListenerMap.containsKey(listener.name())) {
throw new WorkflowListenerException(
@@ -60,14 +63,26 @@ public abstract class WorkflowTask extends NextableElement implements SkippableE
return this;
}
+ /**
+ * Get async task event listener list.
+ */
public List<TaskEventListener> asyncListeners(TaskEvent taskEvent) {
return this.asyncListeners.getOrDefault(taskEvent, TaskEventListener.EMPTY_LIST);
}
+ /**
+ * Get sync task event listener list.
+ */
public List<TaskEventListener> syncListeners(TaskEvent taskEvent) {
return this.syncListeners.getOrDefault(taskEvent, TaskEventListener.EMPTY_LIST);
}
+ /**
+ * Get task event listener by listener name.
+ *
+ * @param listenerName listener name.
+ * @return task event listener info.
+ */
public TaskEventListener listener(String listenerName) {
return this.nameToListenerMap.get(listenerName);
}
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/EventListenerManagerFactory.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/EventListenerManagerFactory.java
index 3f5725e4c..84b69d402 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/EventListenerManagerFactory.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/EventListenerManagerFactory.java
@@ -37,14 +37,23 @@ public class EventListenerManagerFactory {
this.taskListenerManager = new TaskEventListenerManager(eventLogMapper);
}
+ /**
+ * Get process event listener manager.
+ */
public ProcessEventListenerManager getProcessListenerManager() {
return processListenerManager;
}
+ /**
+ * Get task event listener manager.
+ */
public TaskEventListenerManager getTaskListenerManager() {
return taskListenerManager;
}
+ /**
+ * Get workflow event listener manager.
+ */
public WorkflowEventLogEntityMapper getEventLogMapper() {
return eventLogMapper;
}
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/ListenerResult.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/ListenerResult.java
index 08fca2e77..3283bbad1 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/ListenerResult.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/ListenerResult.java
@@ -48,26 +48,57 @@ public class ListenerResult {
*/
private Exception exception;
+ /**
+ * Listener execute success.
+ */
public static ListenerResult success() {
return ListenerResult.builder().success(true).build();
}
+ /**
+ * Listener execute success
+ *
+ * @param remark remarks on execution results.
+ * @return listener execute success info.
+ */
public static ListenerResult success(String remark) {
return ListenerResult.builder().success(true).remark(remark).build();
}
+ /**
+ * Listener execute fail.
+ */
public static ListenerResult fail() {
return ListenerResult.builder().success(false).build();
}
+ /**
+ * Listener execute fail.
+ *
+ * @param remark remarks on execution results.
+ * @return listener execute fail info.
+ */
public static ListenerResult fail(String remark) {
return ListenerResult.builder().success(false).remark(remark).build();
}
+ /**
+ * Listener execute fail.
+ *
+ * @param exception exception on execution results.
+ * @return listener execute fail info.
+ */
public static ListenerResult fail(Exception exception) {
return ListenerResult.builder().success(false).exception(exception).build();
}
+ /**
+ * Listener execute fail.
+ *
+ * @param exception exception on execution results.
+ * @param remark remarks on execution results.
+ * @return listener execute fail info.
+ */
public static ListenerResult fail(Exception exception, String remark) {
return ListenerResult.builder().success(false).exception(exception).remark(remark).build();
}
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/LogableEventListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/LogableEventListener.java
index 06921415a..cf42e04f4 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/LogableEventListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/LogableEventListener.java
@@ -104,6 +104,9 @@ public abstract class LogableEventListener<EventType extends WorkflowEvent> impl
return eventListener.async();
}
+ /**
+ * Build event log.
+ */
protected WorkflowEventLogEntity buildEventLog(WorkflowContext context) {
WorkflowProcessEntity workflowProcessEntity = context.getProcessEntity();
Element currentElement = context.getCurrentElement();
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/DataSourceOperateListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/DataSourceOperateListener.java
index a83b91bb1..61a2f0924 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/DataSourceOperateListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/DataSourceOperateListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.workflow.event.task;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.ListenerResult;
+/**
+ * Listener of operate data source.
+ */
public interface DataSourceOperateListener extends TaskEventListener {
DataSourceOperateListener DEFAULT_SOURCE_OPERATE_LISTENER = new DataSourceOperateListener() {
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/LogableTaskEventListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/LogableTaskEventListener.java
index 318c60cc9..b57e48a1a 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/LogableTaskEventListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/LogableTaskEventListener.java
@@ -24,7 +24,7 @@ import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.LogableEventListener;
/**
- * Listener of logable task event
+ * Listener of build even log event.
*/
public class LogableTaskEventListener extends LogableEventListener<TaskEvent> implements TaskEventListener {
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/QueueOperateListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/QueueOperateListener.java
index 7a23d6d21..b74769dc3 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/QueueOperateListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/QueueOperateListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.workflow.event.task;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.ListenerResult;
+/**
+ * Listener of operate queue.
+ */
public interface QueueOperateListener extends TaskEventListener {
QueueOperateListener DEFAULT_QUEUE_OPERATE_LISTENER = new QueueOperateListener() {
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SinkOperateListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SinkOperateListener.java
index b69ced739..f1ba5ccf5 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SinkOperateListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SinkOperateListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.workflow.event.task;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.ListenerResult;
+/**
+ * Listener of operate sink.
+ */
public interface SinkOperateListener extends TaskEventListener {
SinkOperateListener DEFAULT_SINK_OPERATE_LISTENER = new SinkOperateListener() {
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SortOperateListener.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SortOperateListener.java
index 56ec33d25..3fe601eab 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SortOperateListener.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/event/task/SortOperateListener.java
@@ -20,6 +20,9 @@ package org.apache.inlong.manager.workflow.event.task;
import org.apache.inlong.manager.workflow.WorkflowContext;
import org.apache.inlong.manager.workflow.event.ListenerResult;
+/**
+ * Listener of operate sort.
+ */
public interface SortOperateListener extends TaskEventListener {
SortOperateListener DEFAULT_SORT_OPERATE_LISTENER = new SortOperateListener() {
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/Plugin.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/Plugin.java
index dfc410d40..27f200673 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/Plugin.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/Plugin.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.workflow.plugin;
+/**
+ * Interface of plugin.
+ */
public interface Plugin {
}
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/PluginBinder.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/PluginBinder.java
index 270652d68..d90327e13 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/PluginBinder.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/PluginBinder.java
@@ -17,6 +17,9 @@
package org.apache.inlong.manager.workflow.plugin;
+/**
+ * Interface of plugin binder.
+ */
public interface PluginBinder {
void acceptPlugin(Plugin plugin);
diff --git a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/ProcessPlugin.java b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/ProcessPlugin.java
index 9515a496c..91606db4e 100644
--- a/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/ProcessPlugin.java
+++ b/inlong-manager/manager-workflow/src/main/java/org/apache/inlong/manager/workflow/plugin/ProcessPlugin.java
@@ -25,6 +25,9 @@ import org.apache.inlong.manager.workflow.event.task.SinkOperateListener;
import java.util.Map;
+/**
+ * Interface of process plugin.
+ */
public interface ProcessPlugin extends Plugin {
default Map<DataSourceOperateListener, EventSelector> createSourceOperateListeners() {