[ISSUE-3070][Improve] Improve streampark-console module base on [3.7 Code Comments Rule] (#3509)
* [Improve] improve base module code comments
[Improve] improve base.domain module code comments
[Improve] improve base.exception module code comments
[Improve] improve base.handler module code comments
[Improve] improve base.interceptor module code comments
[Improve] improve base.utils module code comments
* [Improve] improve core module code comments
* [Improve] improve system module code comments
* [Improve] improve AlertConfigService.java
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AlertRestTemplateConfig.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AlertRestTemplateConfig.java
index 3ef1ee2..90ab5e6 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AlertRestTemplateConfig.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AlertRestTemplateConfig.java
@@ -21,6 +21,7 @@
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
+/** Alarm module configuration */
@Configuration
public class AlertRestTemplateConfig {
/**
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AsyncExecutorPoolConfig.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AsyncExecutorPoolConfig.java
index 5222c0c..85d5559 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AsyncExecutorPoolConfig.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/AsyncExecutorPoolConfig.java
@@ -30,8 +30,15 @@
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
+/** Create asynchronous thread pools for different services */
@Configuration
public class AsyncExecutorPoolConfig extends AsyncConfigurerSupport {
+
+ /**
+ * Create a standard asynchronous task performer.
+ *
+ * @return Executor
+ */
@Bean
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -46,6 +53,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolTaskExecutor for SavePointService.
+ *
+ * @return Executor
+ */
@Bean("triggerSavepointExecutor")
public Executor savepointExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -59,6 +71,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolTaskExecutor for FlinkAppHttpWatcher.
+ *
+ * @return Executor
+ */
@Bean("flinkRestAPIWatchingExecutor")
public Executor restAPIWatchingExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -71,6 +88,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolTaskExecutor for FlinkClusterWatcher.
+ *
+ * @return Executor
+ */
@Bean("flinkClusterWatchingExecutor")
public Executor clusterWatchingExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -83,6 +105,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolExecutor for AppBuildPipeService.
+ *
+ * @return ExecutorService
+ */
@Bean("streamparkBuildPipelineExecutor")
public ExecutorService pipelineExecutor() {
return new ThreadPoolExecutor(
@@ -95,6 +122,11 @@
new ThreadPoolExecutor.AbortPolicy());
}
+ /**
+ * Create a ThreadPoolExecutor for FlinkClusterService.
+ *
+ * @return ExecutorService
+ */
@Bean("streamparkClusterExecutor")
public ExecutorService clusterExecutor() {
return new ThreadPoolExecutor(
@@ -107,6 +139,11 @@
new ThreadPoolExecutor.AbortPolicy());
}
+ /**
+ * Create a ThreadPoolTaskExecutor for FlinkK8sChangeEventListener.
+ *
+ * @return Executor
+ */
@Bean("streamparkNotifyExecutor")
public Executor notifyExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -120,6 +157,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolTaskExecutor for ApplicationActionService.
+ *
+ * @return Executor
+ */
@Bean("streamparkDeployExecutor")
public Executor deployExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
@@ -133,6 +175,11 @@
return executor;
}
+ /**
+ * Create a ThreadPoolTaskExecutor for ProjectService.
+ *
+ * @return Executor
+ */
@Bean("streamparkBuildExecutor")
public Executor buildExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/OpenapiConfig.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/OpenapiConfig.java
index cc65030..445495e 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/OpenapiConfig.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/OpenapiConfig.java
@@ -35,6 +35,7 @@
import java.util.Collections;
+/** Provide interface documentation externally */
@EnableKnife4j
@Configuration
@ConditionalOnWebApplication
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/P6spySqlFormatConfig.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/P6spySqlFormatConfig.java
index a3b9b07..137bd37 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/P6spySqlFormatConfig.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/P6spySqlFormatConfig.java
@@ -25,6 +25,7 @@
import java.time.LocalDateTime;
+/** Specifies the log output format of SQL statements in the console */
public class P6spySqlFormatConfig implements MessageFormattingStrategy {
@Override
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/WebMvcConfig.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/WebMvcConfig.java
index 92c66c3..bd96c78 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/WebMvcConfig.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/config/WebMvcConfig.java
@@ -37,6 +37,7 @@
import java.util.List;
+/** Customize the SpringMVC configuration */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@@ -58,6 +59,11 @@
converters.add(new AllEncompassingFormHttpMessageConverter());
}
+ /**
+ * Used to solve cross-domain problems
+ *
+ * @param registry
+ */
@Override
public void addCorsMappings(CorsRegistry registry) {
registry
@@ -77,6 +83,11 @@
return module;
}
+ /**
+ * Add an interceptor.
+ *
+ * @param registry
+ */
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/ApiDocConstant.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/ApiDocConstant.java
index 31220f8..e3b9ab7 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/ApiDocConstant.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/ApiDocConstant.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.base.domain;
+/** Interface document constants */
public class ApiDocConstant {
public static final String FLINK_APP_OP_TAG = "FLINK_APPLICATION_OPERATION_TAG";
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/Constant.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/Constant.java
index f1d7f6b..190c30f 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/Constant.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/domain/Constant.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.base.domain;
+/** System constants */
public class Constant {
// order rules: descend
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/ApplicationException.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/ApplicationException.java
index cb59f55..a365508 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/ApplicationException.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/ApplicationException.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.base.exception;
+/** Applies to all application exceptions */
public class ApplicationException extends ApiAlertException {
public ApplicationException(String message) {
super(message);
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/IllegalFileTypeException.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/IllegalFileTypeException.java
index 531d3f1..b31be21 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/IllegalFileTypeException.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/exception/IllegalFileTypeException.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.base.exception;
+/** This exception is thrown when there is an error in the file type */
public class IllegalFileTypeException extends ApiAlertException {
public IllegalFileTypeException(String message) {
super(message);
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/handler/GlobalExceptionHandler.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/handler/GlobalExceptionHandler.java
index c759750..6ff362f 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/handler/GlobalExceptionHandler.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/handler/GlobalExceptionHandler.java
@@ -43,6 +43,7 @@
import java.util.List;
import java.util.Set;
+/** A global exception handler that takes over all exceptions */
@Slf4j
@RestControllerAdvice
@Order(value = Ordered.HIGHEST_PRECEDENCE)
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/interceptor/UploadFileTypeInterceptor.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/interceptor/UploadFileTypeInterceptor.java
index e575c78..cec0554 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/interceptor/UploadFileTypeInterceptor.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/interceptor/UploadFileTypeInterceptor.java
@@ -42,6 +42,7 @@
import java.io.InputStream;
import java.util.Map;
+/** An interceptor used to handle file uploads */
@Component
public class UploadFileTypeInterceptor implements HandlerInterceptor {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/GitUtils.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/GitUtils.java
index 109fe60..4fa5548 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/GitUtils.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/GitUtils.java
@@ -45,7 +45,7 @@
import java.util.Collections;
import java.util.List;
-/** */
+/** used to build project and project build task */
public class GitUtils {
private GitUtils() {}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/JacksonUtils.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/JacksonUtils.java
index 8fe5627..77a4e91 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/JacksonUtils.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/base/util/JacksonUtils.java
@@ -28,6 +28,7 @@
import java.text.SimpleDateFormat;
+/** Serialization utils */
public final class JacksonUtils {
private JacksonUtils() {}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/annotation/PermissionAction.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/annotation/PermissionAction.java
index 5c6a4ad..cca19d8 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/annotation/PermissionAction.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/annotation/PermissionAction.java
@@ -24,6 +24,10 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * In the controller({@link org.apache.streampark.console.core.controller}), If the method contains
+ * this annotation, it means that this method requires certain permissions to be called.
+ */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PermissionAction {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AccessTokenStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AccessTokenStateEnum.java
index 8236844..321dcab 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AccessTokenStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AccessTokenStateEnum.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.core.enums;
+/** Used to authenticate access rights */
public enum AccessTokenStateEnum {
/** not added token */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AppExistsStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AppExistsStateEnum.java
index cc6f570..0042c02 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AppExistsStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/AppExistsStateEnum.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.core.enums;
+/** Application status, whether it exists, and where it exists */
public enum AppExistsStateEnum {
/** no exists */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/BuildStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/BuildStateEnum.java
index f1de52a..ab66091 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/BuildStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/BuildStateEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Describe the construction status of Project */
public enum BuildStateEnum {
/** has changed, need rebuild */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointStatusEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointStatusEnum.java
index fd11e9d..6cdc60b 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointStatusEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointStatusEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Describe the status of Check Point */
public enum CheckPointStatusEnum {
/** IN_PROGRESS */
IN_PROGRESS(1),
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointTypeEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointTypeEnum.java
index 15e3448..947dfe9 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointTypeEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/CheckPointTypeEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Describe the type of Check Point */
public enum CheckPointTypeEnum {
/** CHECKPOINT */
CHECKPOINT(1),
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FailoverStrategyEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FailoverStrategyEnum.java
index a1f2be1..294bc4b 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FailoverStrategyEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FailoverStrategyEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Provides how to deal with problems when encountering them */
public enum FailoverStrategyEnum {
/** send alert */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FlinkAppStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FlinkAppStateEnum.java
index 151484f..bdb0262 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FlinkAppStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/FlinkAppStateEnum.java
@@ -23,6 +23,7 @@
import scala.Enumeration;
+/** Describe the status of Flink Application */
@Getter
public enum FlinkAppStateEnum {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GatewayTypeEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GatewayTypeEnum.java
index 60bdf81..6a1458c 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GatewayTypeEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GatewayTypeEnum.java
@@ -22,6 +22,7 @@
import java.util.Arrays;
+/** Flink GateWay Type */
@Getter
public enum GatewayTypeEnum {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitAuthorizedErrorEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitAuthorizedErrorEnum.java
index 9ae2ddc..6f8ea7f 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitAuthorizedErrorEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitAuthorizedErrorEnum.java
@@ -17,6 +17,7 @@
package org.apache.streampark.console.core.enums;
+/** Git authentication results */
public enum GitAuthorizedErrorEnum {
/** Success. */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitCredentialEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitCredentialEnum.java
index 07e8920..1da4210 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitCredentialEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/GitCredentialEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Git connection method */
public enum GitCredentialEnum {
HTTPS(1),
SSH(2);
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/NoticeTypeEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/NoticeTypeEnum.java
index 5d6b228..da414f7 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/NoticeTypeEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/NoticeTypeEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** notification type */
public enum NoticeTypeEnum {
/** exception */
EXCEPTION(1),
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OperationEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OperationEnum.java
index fa559eb..685732a 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OperationEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OperationEnum.java
@@ -21,6 +21,7 @@
import java.util.Arrays;
+/** Operation type */
@Getter
public enum OperationEnum {
RELEASE(0),
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OptionStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OptionStateEnum.java
index 9a6b8ca..7315c0e 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OptionStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/OptionStateEnum.java
@@ -21,6 +21,7 @@
import java.util.Arrays;
+/** Option status */
@Getter
public enum OptionStateEnum {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/ReleaseStateEnum.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/ReleaseStateEnum.java
index db09215..aac50ea 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/ReleaseStateEnum.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/enums/ReleaseStateEnum.java
@@ -19,6 +19,7 @@
import java.util.Arrays;
+/** Release Status */
public enum ReleaseStateEnum {
/** release failed */
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/AppBuildPipeService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/AppBuildPipeService.java
index f6fa3fd..0f35f34 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/AppBuildPipeService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/AppBuildPipeService.java
@@ -29,6 +29,7 @@
import java.util.Map;
import java.util.Optional;
+/** Applications can be built asynchronously, can manage pipeline and get info */
public interface AppBuildPipeService extends IService<AppBuildPipeline> {
/**
@@ -48,17 +49,32 @@
*/
Optional<AppBuildPipeline> getCurrentBuildPipeline(@Nonnull Long appId);
- /** Get Docker resolved snapshot of specified application. */
+ /**
+ * Get Docker resolved snapshot of specified application.
+ *
+ * @param appId application id
+ * @return DockerResolvedSnapshot instance
+ */
DockerResolvedSnapshot getDockerProgressDetailSnapshot(@Nonnull Long appId);
- /** Whether the application can currently start a new building progress */
+ /**
+ * Whether the application can currently start a new building progress
+ *
+ * @param appId application id
+ * @return Whether construction can be started at this time
+ */
boolean allowToBuildNow(@Nonnull Long appId);
- /** list pipeline status on application id list */
+ /**
+ * List pipeline status on application id list
+ *
+ * @param appIds list of application ids
+ * @return Map structure, key is application id, value is for the pipeline state
+ */
Map<Long, PipelineStatusEnum> listAppIdPipelineStatusMap(List<Long> appIds);
/**
- * delete appBuildPipeline By application
+ * Delete appBuildPipeline By application id
*
* @param appId
*/
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ApplicationLogService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ApplicationLogService.java
index b39d16c..3daaab9 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ApplicationLogService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ApplicationLogService.java
@@ -23,9 +23,22 @@
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
+/** This interface is used to record application operation logs */
public interface ApplicationLogService extends IService<ApplicationLog> {
+ /**
+ * Retrieves a page of {@link ApplicationLog} objects based on the provided parameters.
+ *
+ * @param applicationLog The {@link ApplicationLog} object containing the search criteria.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link ApplicationLog} objects.
+ */
IPage<ApplicationLog> getPage(ApplicationLog applicationLog, RestRequest request);
+ /**
+ * remove application log by application id
+ *
+ * @param appId The id of the application to be removed
+ */
void removeByAppId(Long appId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/CommonService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/CommonService.java
index 2a821f2..6b0852c 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/CommonService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/CommonService.java
@@ -20,11 +20,28 @@
import org.apache.streampark.console.core.entity.FlinkEnv;
import org.apache.streampark.console.system.entity.User;
+/** Base Service */
public interface CommonService {
+ /**
+ * Get the information of the currently login user
+ *
+ * @return Current user information
+ */
User getCurrentUser();
+ /**
+ * Get the user id of the currently login user
+ *
+ * @return Current user id
+ */
Long getUserId();
+ /**
+ * Get SQL client Jar by flink environment
+ *
+ * @param flinkEnv The FlinkEnv Contains relevant information
+ * @return Jar
+ */
String getSqlClientJar(FlinkEnv flinkEnv);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ExternalLinkService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ExternalLinkService.java
index d33e932..2ec5db5 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ExternalLinkService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ExternalLinkService.java
@@ -23,13 +23,38 @@
import java.util.List;
+/**
+ * External Linked Service,External service integrations such as code repositories, metrics
+ * monitoring pages, real-time logging
+ */
public interface ExternalLinkService extends IService<ExternalLink> {
+ /**
+ * Create a ExternalLink
+ *
+ * @param externalLink The ExternalLink to be create.
+ */
void create(ExternalLink externalLink);
+ /**
+ * remove ExternalLink by link id
+ *
+ * @param linkId The ID of the object to delete.
+ */
void removeById(Long linkId);
+ /**
+ * update ExternalLink information
+ *
+ * @param externalLink The ExternalLink to be update
+ */
void update(ExternalLink externalLink);
+ /**
+ * Displays the display that is relevant to the query criteriaExternalLink
+ *
+ * @param appId The ID of the object to render.
+ * @return list of ExternalLink
+ */
List<ExternalLink> render(Long appId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkClusterService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkClusterService.java
index cdf3b2a..30f0ea8 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkClusterService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkClusterService.java
@@ -27,31 +27,107 @@
import java.util.Collection;
import java.util.List;
+/** Flink Cluster Service, Provides control over the cluster */
public interface FlinkClusterService extends IService<FlinkCluster> {
+ /**
+ * List all currently available clusters
+ *
+ * @return List of flink cluster
+ */
List<FlinkCluster> listAvailableCluster();
+ /**
+ * Check the flink cluster status
+ *
+ * @param flinkCluster FlinkCluster To be check
+ * @return The response value
+ */
ResponseResult check(FlinkCluster flinkCluster);
+ /**
+ * Create flink cluster
+ *
+ * @param flinkCluster FlinkCluster to be create
+ * @return Whether the creation is successful
+ */
Boolean create(FlinkCluster flinkCluster);
+ /**
+ * Remove flink cluster
+ *
+ * @param id FlinkCluster id whitch to be removed
+ */
void remove(Long id);
+ /**
+ * Update flink cluster
+ *
+ * @param flinkCluster FlinkCluster to be update
+ */
void update(FlinkCluster flinkCluster);
+ /**
+ * Start flink cluster
+ *
+ * @param flinkCluster FlinkCluster to be start
+ */
void start(FlinkCluster flinkCluster);
+ /**
+ * Shutdown flink cluster
+ *
+ * @param flinkCluster to be shutdown
+ */
void shutdown(FlinkCluster flinkCluster);
+ /**
+ * Allow to shut down flink cluster
+ *
+ * @param flinkCluster FlinkCluster can be shutdown now
+ * @return Whether the operation was successful
+ */
Boolean allowShutdownCluster(FlinkCluster flinkCluster);
+ /**
+ * Query whether the Flink cluster with the specified cluster id exists
+ *
+ * @param clusterId target cluster id
+ * @param id Current flink cluster id
+ * @return Whether the cluster exists
+ */
Boolean existsByClusterId(String clusterId, Long id);
+ /**
+ * Query whether the Flink cluster with the specified cluster id exists
+ *
+ * @param clusterName target cluster name
+ * @param id Current flink cluster id
+ * @return Whether the cluster exists
+ */
Boolean existsByClusterName(String clusterName, Long id);
+ /**
+ * Query whether the Flink cluster with the specified FlinkEnv id exists
+ *
+ * @param id FlinkEnv id
+ * @return Whether the cluster exists
+ */
Boolean existsByFlinkEnvId(Long id);
+ /**
+ * Lists the corresponding flink clusters based on ExecutionMode
+ *
+ * @param executionModeEnums Collection of FlinkExecutionMode
+ * @return List of flink cluster
+ */
List<FlinkCluster> listByExecutionModes(Collection<FlinkExecutionMode> executionModeEnums);
+ /**
+ * update flink cluster state
+ *
+ * @param id flink cluster id
+ * @param state flink cluster state
+ */
void updateClusterState(Long id, ClusterState state);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkGateWayService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkGateWayService.java
index 20289e5..6cba13a 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkGateWayService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkGateWayService.java
@@ -23,12 +23,37 @@
import com.baomidou.mybatisplus.extension.service.IService;
import com.fasterxml.jackson.core.JsonProcessingException;
+/** Connecting to Flink Gateway service */
public interface FlinkGateWayService extends IService<FlinkGateWay> {
+
+ /**
+ * Create flink gateway
+ *
+ * @param flinkGateWay FlinkGateWay
+ */
void create(FlinkGateWay flinkGateWay);
+ /**
+ * Update flink gateway
+ *
+ * @param flinkGateWay FlinkGateWay
+ */
void update(FlinkGateWay flinkGateWay);
+ /**
+ * Check gateway exists by gateway name
+ *
+ * @param name gateway name
+ * @return Whether it exists
+ */
boolean existsByGatewayName(String name);
+ /**
+ * Get gateway version
+ *
+ * @param address
+ * @return gateway type
+ * @throws JsonProcessingException
+ */
GatewayTypeEnum getGatewayVersion(String address) throws JsonProcessingException;
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkSqlService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkSqlService.java
index 39659da..b90c64b 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkSqlService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/FlinkSqlService.java
@@ -28,31 +28,108 @@
import java.util.List;
+/** This service is used to handle SQL submission tasks */
public interface FlinkSqlService extends IService<FlinkSql> {
+ /**
+ * Create FLinkSQL
+ *
+ * @param flinkSql FlinkSql will create
+ */
void create(FlinkSql flinkSql);
+ /**
+ * Set Candidate about application and SQL.
+ *
+ * @param candidateTypeEnum CandidateTypeEnum
+ * @param appId application id
+ * @param sqlId FlinkSQL id
+ */
void setCandidate(CandidateTypeEnum candidateTypeEnum, Long appId, Long sqlId);
+ /**
+ * @param appId Application id
+ * @param decode Whether to choose decode
+ * @return FlinkSql
+ */
FlinkSql getEffective(Long appId, boolean decode);
+ /**
+ * get latest one FLinkSQL by application id
+ *
+ * @param appId Application id
+ * @param decode Whether to choose decode
+ * @return FlinkSql of the latest
+ */
FlinkSql getLatestFlinkSql(Long appId, boolean decode);
+ /**
+ * Get all historical SQL through Application
+ *
+ * @param appId Application id
+ * @return list of History FLinkSQL
+ */
List<FlinkSql> listFlinkSqlHistory(Long appId);
+ /**
+ * Get FlinkSQL by Application id and Candidate Type
+ *
+ * @param appId Application id
+ * @param type CandidateTypeEnum
+ * @return FlinkSQL
+ */
FlinkSql getCandidate(Long appId, CandidateTypeEnum type);
+ /**
+ * @param appId Application id
+ * @param sqlId FLinkSQL id
+ */
void toEffective(Long appId, Long sqlId);
+ /**
+ * clean all candidate
+ *
+ * @param id FlinkSQL id
+ */
void cleanCandidate(Long id);
+ /**
+ * Remove FLinkSQL by Application id
+ *
+ * @param appId Application id
+ */
void removeByAppId(Long appId);
+ /**
+ * FlinkSQL rollback
+ *
+ * @param application Application
+ */
void rollback(Application application);
+ /**
+ * Verify whether the entered SQL is correct
+ *
+ * @param sql SQL
+ * @param versionId FlinkENV version id
+ * @return FlinkSqlValidationResult Check the correctness of SQL
+ */
FlinkSqlValidationResult verifySql(String sql, Long versionId);
+ /**
+ * List all FlinkSQL by each FLinkSQL team id
+ *
+ * @param teamId FlinkSQL team id
+ * @return list of FlinkSQL
+ */
List<FlinkSql> listByTeamId(Long teamId);
+ /**
+ * Retrieves a page of {@link FlinkSql} objects based on the provided parameters.
+ *
+ * @param appId Application id
+ * @param request request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link FlinkSql} objects.
+ */
IPage<FlinkSql> getPage(Long appId, RestRequest request);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/MessageService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/MessageService.java
index 569d446..6a1517e 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/MessageService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/MessageService.java
@@ -24,9 +24,23 @@
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
+/** Message push service */
public interface MessageService extends IService<Message> {
+ /**
+ * push message to user
+ *
+ * @param message Message
+ */
void push(Message message);
+ /**
+ * Retrieves a page of {@link Message} objects based on the provided parameters.
+ *
+ * @param noticeTypeEnum request request The {@link NoticeTypeEnum} object used for pagination and
+ * sorting.
+ * @param request request request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link Message} objects.
+ */
IPage<Message> getUnReadPage(NoticeTypeEnum noticeTypeEnum, RestRequest request);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ProjectService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ProjectService.java
index a935570..ec9d096 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ProjectService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/ProjectService.java
@@ -30,31 +30,119 @@
public interface ProjectService extends IService<Project> {
+ /**
+ * Create a new instance.
+ *
+ * @param project Project to be created
+ * @return RestResponse
+ */
RestResponse create(Project project);
+ /**
+ * Update the given Project
+ *
+ * @param projectParam The project to be updated
+ * @return whether the update is successful
+ */
boolean update(Project projectParam);
+ /**
+ * remove the given project by project id
+ *
+ * @param id project id
+ * @return whether the remove is successful
+ */
boolean removeById(Long id);
+ /**
+ * Retrieves a page of {@link Project} objects based on the provided parameters.
+ *
+ * @param project @param applicationLog The {@link Project} object containing the search criteria.
+ * @param restRequest @param request The {@link RestRequest} object used for pagination and
+ * sorting.
+ * @return An {@link IPage} containing the retrieved {@link Project} objects.
+ */
IPage<Project> getPage(Project project, RestRequest restRequest);
+ /**
+ * Check whether the corresponding project exists through team id
+ *
+ * @param teamId Project contains team id
+ * @return whether the corresponding project exists
+ */
Boolean existsByTeamId(Long teamId);
+ /**
+ * List all project by team id
+ *
+ * @param teamId Project contains team id
+ * @return List of project
+ */
List<Project> listByTeamId(Long teamId);
+ /**
+ * Build the project
+ *
+ * @param id Project id
+ * @throws Exception
+ */
void build(Long id) throws Exception;
+ /**
+ * Get the construction log of the specified project
+ *
+ * @param id Project id
+ * @param startOffset startOffset
+ * @return RestResponse
+ */
RestResponse getBuildLog(Long id, Long startOffset);
+ /**
+ * List all modules of the specified project
+ *
+ * @param id Project id
+ * @return List of modules
+ */
List<String> listModules(Long id);
+ /**
+ * List all Jars of the specified project
+ *
+ * @param project Project
+ * @return List of Jars
+ */
List<String> listJars(Project project);
+ /**
+ * List all project configs of the specified project
+ *
+ * @param project Project
+ * @return List of configs
+ */
List<Map<String, Object>> listConf(Project project);
+ /**
+ * Get the configuration path of Application
+ *
+ * @param id Project id
+ * @param module Module
+ * @return Application config path
+ */
String getAppConfPath(Long id, String module);
+ /**
+ * List all Application of the specified project
+ *
+ * @param project Project
+ * @return List of Applications
+ */
List<Application> listApps(Project project);
+ /**
+ * Check whether the corresponding project exists
+ *
+ * @param project Project
+ * @return whether the corresponding project exists
+ */
boolean exists(Project project);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/SettingService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/SettingService.java
index 8dafd32..16a01c6 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/SettingService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/SettingService.java
@@ -26,6 +26,7 @@
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
+/** System setting service */
public interface SettingService extends IService<Setting> {
Map<String, Setting> SETTINGS = new ConcurrentHashMap<>();
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/YarnQueueService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/YarnQueueService.java
index 19898ee..fd02cac 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/YarnQueueService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/YarnQueueService.java
@@ -27,21 +27,75 @@
public interface YarnQueueService extends IService<YarnQueue> {
+ /**
+ * Retrieves a page of {@link YarnQueue} objects based on the provided parameters.
+ *
+ * @param yarnQueue The {@link YarnQueue} object containing the search criteria.
+ * @param restRequest The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link YarnQueue} objects.
+ */
IPage<YarnQueue> getPage(YarnQueue yarnQueue, RestRequest restRequest);
+ /**
+ * Check the correctness of yarnQueue
+ *
+ * @param yarnQueue YarnQueue
+ * @return ResponseResult
+ */
ResponseResult<String> checkYarnQueue(YarnQueue yarnQueue);
+ /**
+ * Create a YarnQueue by entering parameters
+ *
+ * @param yarnQueue YarnQueue
+ * @return
+ */
boolean createYarnQueue(YarnQueue yarnQueue);
+ /**
+ * Update YarnQueue based on input parameters
+ *
+ * @param yarnQueue YarnQueue to be updated
+ */
void updateYarnQueue(YarnQueue yarnQueue);
+ /**
+ * Remove YarnQueue based on input parameters
+ *
+ * @param yarnQueue YarnQueue to be removed
+ */
void remove(YarnQueue yarnQueue);
+ /**
+ * Check queue label by given parameters
+ *
+ * @param executionModeEnum FlinkExecutionMode
+ * @param queueLabel queue Label
+ */
void checkQueueLabel(FlinkExecutionMode executionModeEnum, String queueLabel);
+ /**
+ * Determine whether it is the default queue by the given queue label
+ *
+ * @param queueLabel Queue label
+ * @return Whether the returned result is true
+ */
boolean isDefaultQueue(String queueLabel);
+ /**
+ * Check if queue exists by given queue label
+ *
+ * @param queueLabel queue label
+ * @return Whether the returned result is true
+ */
boolean existByQueueLabel(String queueLabel);
+ /**
+ * Check if queue exists by given queue label and team id
+ *
+ * @param teamId team id
+ * @param queueLabel queue label
+ * @return Whether the returned result is true
+ */
boolean existByTeamIdQueueLabel(Long teamId, String queueLabel);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/alert/AlertConfigService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/alert/AlertConfigService.java
index 7c0dad5..f554888 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/alert/AlertConfigService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/alert/AlertConfigService.java
@@ -25,10 +25,32 @@
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
+/** This interface defines operations related to alarm configuration. */
public interface AlertConfigService extends IService<AlertConfig> {
+
+ /**
+ * Retrieves a page of {@link AlertConfigParams} objects based on the provided parameters.
+ *
+ * @param userId user id.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link AlertConfigParams} objects.
+ */
IPage<AlertConfigParams> page(Long userId, RestRequest request);
+ /**
+ * check whether the relevant alarm configuration exists
+ *
+ * @param alertConfig AlertConfig to be checked
+ * @return Whether exist in database
+ */
boolean exist(AlertConfig alertConfig);
+ /**
+ * Remove based on the id configured in the alert
+ *
+ * @param id AlertConfig id
+ * @return Whether removed is successful
+ * @throws AlertException
+ */
boolean removeById(Long id) throws AlertException;
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/impl/AppBuildPipeServiceImpl.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/impl/AppBuildPipeServiceImpl.java
index 6d11c21..a43e1fe 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/impl/AppBuildPipeServiceImpl.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/service/impl/AppBuildPipeServiceImpl.java
@@ -589,6 +589,12 @@
new LambdaQueryWrapper<AppBuildPipeline>().eq(AppBuildPipeline::getAppId, appId));
}
+ /**
+ * save or update build pipeline
+ *
+ * @param pipe application build pipeline
+ * @return value after the save or update
+ */
public boolean saveEntity(AppBuildPipeline pipe) {
AppBuildPipeline old = getById(pipe.getAppId());
if (old == null) {
@@ -597,6 +603,14 @@
return updateById(pipe);
}
+ /**
+ * Check if the jar exists, and upload a copy if it does not exist
+ *
+ * @param fsOperator
+ * @param localJar
+ * @param targetJar
+ * @param targetDir
+ */
private void checkOrElseUploadJar(
FsOperator fsOperator, File localJar, String targetJar, String targetDir) {
if (!fsOperator.exists(targetJar)) {
@@ -609,6 +623,12 @@
}
}
+ /**
+ * Gets and parses dependencies on the application
+ *
+ * @param application
+ * @return DependencyInfo
+ */
private DependencyInfo getMergedDependencyInfo(Application application) {
DependencyInfo dependencyInfo = application.getDependencyInfo();
if (StringUtils.isBlank(application.getTeamResource())) {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/authentication/JWTUtil.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/authentication/JWTUtil.java
index 9b44eee..073bdee 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/authentication/JWTUtil.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/authentication/JWTUtil.java
@@ -33,6 +33,7 @@
import java.util.Date;
+/** Verification and parsing Token */
@Slf4j
public class JWTUtil {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/controller/RoleController.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/controller/RoleController.java
index 57a14c3..afa84ff 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/controller/RoleController.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/controller/RoleController.java
@@ -21,7 +21,7 @@
import org.apache.streampark.console.base.domain.RestResponse;
import org.apache.streampark.console.system.entity.Role;
import org.apache.streampark.console.system.entity.RoleMenu;
-import org.apache.streampark.console.system.service.RoleMenuServie;
+import org.apache.streampark.console.system.service.RoleMenuService;
import org.apache.streampark.console.system.service.RoleService;
import org.apache.shiro.authz.annotation.RequiresPermissions;
@@ -52,7 +52,7 @@
public class RoleController {
@Autowired private RoleService roleService;
- @Autowired private RoleMenuServie roleMenuServie;
+ @Autowired private RoleMenuService roleMenuService;
@Operation(summary = "List roles")
@PostMapping("list")
@@ -72,7 +72,7 @@
@Operation(summary = "List role menus")
@PostMapping("menu")
public RestResponse getRoleMenus(@NotBlank(message = "{required}") String roleId) {
- List<RoleMenu> roleMenuList = this.roleMenuServie.listByRoleId(roleId);
+ List<RoleMenu> roleMenuList = this.roleMenuService.listByRoleId(roleId);
List<String> menuIdList =
roleMenuList.stream()
.map(roleMenu -> String.valueOf(roleMenu.getMenuId()))
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/AccessTokenService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/AccessTokenService.java
index 27484b6..1030e16 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/AccessTokenService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/AccessTokenService.java
@@ -25,16 +25,52 @@
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
+/** This interface is related to Token information acquisition and operation */
public interface AccessTokenService extends IService<AccessToken> {
+ /**
+ * Generate token based on user ID's expiration time and description
+ *
+ * @param userId User id
+ * @param expireTime expiration
+ * @param description more description
+ * @return RestResponse
+ * @throws InternalException
+ */
RestResponse generateToken(Long userId, String expireTime, String description)
throws InternalException;
+ /**
+ * Retrieves a page of {@link AccessToken} objects based on the provided parameters.
+ *
+ * @param tokenParam The {@link AccessToken} object containing the search criteria.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link AccessToken} objects.
+ */
IPage<AccessToken> getPage(AccessToken tokenParam, RestRequest request);
+ /**
+ * Check whether the incoming token is valid
+ *
+ * @param userId User id
+ * @param token 被Checked token
+ * @return Whether the token is valid
+ */
boolean checkTokenEffective(Long userId, String token);
+ /**
+ * Update information in token
+ *
+ * @param tokenId AccessToken id
+ * @return RestResponse
+ */
RestResponse toggleToken(Long tokenId);
+ /**
+ * Get the corresponding AccessToken based on the user ID
+ *
+ * @param userId User id
+ * @return AccessToken
+ */
AccessToken getByUserId(Long userId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MemberService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MemberService.java
index a9936f2..9e4f18e 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MemberService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MemberService.java
@@ -29,25 +29,87 @@
public interface MemberService extends IService<Member> {
+ /**
+ * Remove Member by role ids
+ *
+ * @param roleIds List of role id
+ */
void removeByRoleIds(String[] roleIds);
+ /**
+ * Remove Member by user id
+ *
+ * @param userId user id
+ */
void removeByUserId(Long userId);
+ /**
+ * Remove Member by team Id
+ *
+ * @param teamId team Id
+ */
void removeByTeamId(Long teamId);
+ /**
+ * Retrieves a page of {@link Member} objects based on the provided parameters.
+ *
+ * @param member The {@link Member} object containing the search criteria.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link Member} objects.
+ */
IPage<Member> getPage(Member member, RestRequest request);
+ /**
+ * List all users who are not in the team with the passed team id
+ *
+ * @param teamId team id
+ * @return List of User
+ */
List<User> listUsersNotInTeam(Long teamId);
+ /**
+ * List all Teams, those containing the passed user id
+ *
+ * @param userId User id
+ * @return List of Team
+ */
List<Team> listTeamsByUserId(Long userId);
+ /**
+ * Get Member by team id and username
+ *
+ * @param teamId team id
+ * @param userName username
+ * @return Member
+ */
Member getByTeamIdUserName(Long teamId, String userName);
+ /**
+ * List all User ids based on Role id as a condition
+ *
+ * @param roleId
+ * @return List of User ids
+ */
List<Long> listUserIdsByRoleId(Long roleId);
+ /**
+ * Create a new Member instance
+ *
+ * @param member Member
+ */
void createMember(Member member);
+ /**
+ * Remove a member
+ *
+ * @param id Member id to be removed
+ */
void remove(Long id);
+ /**
+ * Update Member
+ *
+ * @param member Member which one contains the information to be updated
+ */
void updateMember(Member member);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MenuService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MenuService.java
index 3bb5319..90f0ec3 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MenuService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/MenuService.java
@@ -25,6 +25,7 @@
import java.util.List;
import java.util.Map;
+/** This interface is used to control the menu of the page */
public interface MenuService extends IService<Menu> {
/**
@@ -36,9 +37,29 @@
*/
List<String> listPermissions(Long userId, Long teamId);
+ /**
+ * * List menus based on user id and team id
+ *
+ * @param userId user id
+ * @param teamId team id
+ * @return List of Menu
+ */
List<Menu> listMenus(Long userId, Long teamId);
+ /**
+ * List menus map based on menu
+ *
+ * @param menu Menu
+ * @return Menus Map
+ */
Map<String, Object> listMenuMap(Menu menu);
+ /**
+ * List Menu Routers based on user id and team id
+ *
+ * @param userId user id
+ * @param teamId team id
+ * @return List of Menu VueRouter
+ */
List<VueRouter<Menu>> listRouters(Long userId, Long teamId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuServie.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuService.java
similarity index 71%
rename from streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuServie.java
rename to streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuService.java
index 6926fae..4f236fb 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuServie.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleMenuService.java
@@ -23,11 +23,28 @@
import java.util.List;
-public interface RoleMenuServie extends IService<RoleMenu> {
+/** This interface is used to handle the relationship between permissions and menus */
+public interface RoleMenuService extends IService<RoleMenu> {
+ /**
+ * Remove the association of RoleMenu by role id
+ *
+ * @param roleId role id
+ */
void removeByRoleId(Long roleId);
+ /**
+ * Remove the association of RoleMenu by menu Ids
+ *
+ * @param menuIds list of menu id
+ */
void removeByMenuIds(String[] menuIds);
+ /**
+ * List the association of RoleMenu by role id
+ *
+ * @param roleId role id
+ * @return
+ */
List<RoleMenu> listByRoleId(String roleId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleService.java
index 6082515..d2500f4 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/RoleService.java
@@ -25,13 +25,41 @@
public interface RoleService extends IService<Role> {
+ /**
+ * Retrieves a page of {@link Role} objects based on the provided parameters.
+ *
+ * @param role The {@link Role} object containing the search criteria.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link Role} objects.
+ */
IPage<Role> getPage(Role role, RestRequest request);
+ /**
+ * Get the Role by role name
+ *
+ * @param roleName role name
+ * @return Role
+ */
Role getByName(String roleName);
+ /**
+ * Create role instance
+ *
+ * @param role Role
+ */
void createRole(Role role);
+ /**
+ * Remove Role by role id
+ *
+ * @param roleId role id
+ */
void removeById(Long roleId);
+ /**
+ * Update Role with incoming information
+ *
+ * @param role Role
+ */
void updateRole(Role role);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/TeamService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/TeamService.java
index ee494e6..8949230 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/TeamService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/TeamService.java
@@ -27,15 +27,49 @@
public interface TeamService extends IService<Team> {
+ /**
+ * Retrieves a page of {@link Team} objects based on the provided parameters.
+ *
+ * @param team The {@link Team} object containing the search criteria.
+ * @param request The {@link RestRequest} object used for pagination and sorting.
+ * @return An {@link IPage} containing the retrieved {@link Team} objects.
+ */
IPage<Team> getPage(Team team, RestRequest request);
+ /**
+ * Get the Team by team name
+ *
+ * @param teamName team name
+ * @return Team
+ */
Team getByName(String teamName);
+ /**
+ * Create a Team instance
+ *
+ * @param team Team
+ */
void createTeam(Team team);
+ /**
+ * Remove the Team by team id
+ *
+ * @param teamId team id
+ */
void removeById(Long teamId);
+ /**
+ * Update Team information carried by the incoming Team
+ *
+ * @param team Team
+ */
void updateTeam(Team team);
+ /**
+ * List All team by user id
+ *
+ * @param userId user id
+ * @return List of Team
+ */
List<Team> listByUserId(Long userId);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/UserService.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/UserService.java
index 713d65c..745393f 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/UserService.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/UserService.java
@@ -96,21 +96,74 @@
*/
Set<String> listPermissions(Long userId, @Nullable Long teamId);
+ /**
+ * List all users without tokens
+ *
+ * @return List of User
+ */
List<User> listNoTokenUser();
+ /**
+ * Populate the LastTeam field in User
+ *
+ * @param teamId team id
+ * @param userId user id
+ */
void setLastTeam(Long teamId, Long userId);
+ /**
+ * Clean the LastTeam field in User
+ *
+ * @param userId user id
+ * @param teamId team id
+ */
void clearLastTeam(Long userId, Long teamId);
+ /**
+ * Clean the LastTeam field in User
+ *
+ * @param teamId team id
+ */
void clearLastTeam(Long teamId);
+ /**
+ * Populate team information for users
+ *
+ * @param user User
+ */
void fillInTeam(User user);
+ /**
+ * List all Users by team id
+ *
+ * @param teamId team id
+ * @return List of user
+ */
List<User> listByTeamId(Long teamId);
+ /**
+ * Generate user information for the front end
+ *
+ * @param user User
+ * @param teamId team id
+ * @param token JWTToken
+ * @return
+ */
Map<String, Object> generateFrontendUserInfo(User user, Long teamId, JWTToken token);
+ /**
+ * transfer user resources to specified users
+ *
+ * @param userId The user ID sending the resource
+ * @param targetUserId The user ID receiving the resource
+ */
void transferResource(Long userId, Long targetUserId);
+ /**
+ * Get login user information
+ *
+ * @param user User
+ * @return RestResponse
+ */
RestResponse getLoginUserInfo(User user);
}
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/MenuServiceImpl.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/MenuServiceImpl.java
index 0e1f711..56d20b8 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/MenuServiceImpl.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/MenuServiceImpl.java
@@ -26,7 +26,7 @@
import org.apache.streampark.console.system.entity.User;
import org.apache.streampark.console.system.mapper.MenuMapper;
import org.apache.streampark.console.system.service.MenuService;
-import org.apache.streampark.console.system.service.RoleMenuServie;
+import org.apache.streampark.console.system.service.RoleMenuService;
import org.apache.streampark.console.system.service.UserService;
import org.apache.commons.lang3.StringUtils;
@@ -57,7 +57,7 @@
@Autowired private UserService userService;
- @Autowired private RoleMenuServie roleMenuServie;
+ @Autowired private RoleMenuService roleMenuService;
@Override
public List<String> listPermissions(Long userId, Long teamId) {
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleMenuServiceImpl.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleMenuServiceImpl.java
index 90f128d..f111ada 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleMenuServiceImpl.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleMenuServiceImpl.java
@@ -19,7 +19,7 @@
import org.apache.streampark.console.system.entity.RoleMenu;
import org.apache.streampark.console.system.mapper.RoleMenuMapper;
-import org.apache.streampark.console.system.service.RoleMenuServie;
+import org.apache.streampark.console.system.service.RoleMenuService;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
@@ -33,7 +33,7 @@
@Service
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true, rollbackFor = Exception.class)
public class RoleMenuServiceImpl extends ServiceImpl<RoleMenuMapper, RoleMenu>
- implements RoleMenuServie {
+ implements RoleMenuService {
@Override
@Transactional
diff --git a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleServiceImpl.java b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleServiceImpl.java
index 943b234..66c1001 100644
--- a/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleServiceImpl.java
+++ b/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/system/service/impl/RoleServiceImpl.java
@@ -26,7 +26,7 @@
import org.apache.streampark.console.system.mapper.RoleMapper;
import org.apache.streampark.console.system.mapper.RoleMenuMapper;
import org.apache.streampark.console.system.service.MemberService;
-import org.apache.streampark.console.system.service.RoleMenuServie;
+import org.apache.streampark.console.system.service.RoleMenuService;
import org.apache.streampark.console.system.service.RoleService;
import org.apache.commons.collections.CollectionUtils;
@@ -57,7 +57,7 @@
@Autowired private MemberService memberService;
- @Autowired private RoleMenuServie roleMenuService;
+ @Autowired private RoleMenuService roleMenuService;
@Override
public IPage<Role> getPage(Role role, RestRequest request) {
