Replace Chinese comments with English - scheduler module (#24) (#31)
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/GsonJsonProvider.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/GsonJsonProvider.java
index f9cc311..28b9c48 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/GsonJsonProvider.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/GsonJsonProvider.java
@@ -36,9 +36,7 @@
import java.lang.reflect.Type;
/**
- * 基于GSON解析JSON的解析器.
- *
- * @author zhangliang
+ * Gson provider.
*/
@Provider
@Produces(MediaType.APPLICATION_JSON)
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulException.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulException.java
index c72d3b8..6a543dc 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulException.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.restful;
/**
- * REST API异常.
- *
- * @author zhangliang
+ * Restful api exception.
*/
public final class RestfulException extends RuntimeException {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulExceptionMapper.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulExceptionMapper.java
index 76b7973..47a7d04 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulExceptionMapper.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulExceptionMapper.java
@@ -25,9 +25,7 @@
import javax.ws.rs.ext.Provider;
/**
- * RESTFul API的异常处理器.
- *
- * @author zhangliang
+ * Restful api exception mapper.
*/
@Provider
public final class RestfulExceptionMapper implements ExceptionMapper<Throwable> {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulServer.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulServer.java
index 9e117e9..b9208b8 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulServer.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/restful/RestfulServer.java
@@ -34,10 +34,7 @@
import java.util.EnumSet;
/**
- * REST API的内嵌服务器.
- *
- * @author zhangliang
- * @author caohao
+ * Rest api embed server.
*/
@Slf4j
public final class RestfulServer {
@@ -52,23 +49,23 @@
}
/**
- * 启动内嵌的RESTful服务器.
+ * Start server.
*
- * @param packages RESTful实现类所在包
- * @param resourcePath 资源路径
- * @throws Exception 启动服务器异常
+ * @param packages restful implementation class package
+ * @param resourcePath resource path
+ * @throws Exception exception when startup
*/
public void start(final String packages, final Optional<String> resourcePath) throws Exception {
start(packages, resourcePath, Optional.of("/api"));
}
/**
- * 启动内嵌的RESTful服务器.
+ * Start server.
*
- * @param packages RESTful实现类所在包
- * @param resourcePath 资源路径
- * @param servletPath servlet路径
- * @throws Exception 启动服务器异常
+ * @param packages restful implementation class package
+ * @param resourcePath resource path
+ * @param servletPath servlet path
+ * @throws Exception exception when startup
*/
public void start(final String packages, final Optional<String> resourcePath, final Optional<String> servletPath) throws Exception {
log.info("Elastic Job: Start RESTful server");
@@ -85,11 +82,11 @@
}
/**
- * 添加Filter.
+ * Add filter.
*
- * @param filterClass filter实现类
- * @param urlPattern 过滤的路径
- * @return RESTful服务器
+ * @param filterClass filter implementation class
+ * @param urlPattern url pattern to filter
+ * @return restful server
*/
public RestfulServer addFilter(final Class<? extends Filter> filterClass, final String urlPattern) {
servletContextHandler.addFilter(filterClass, urlPattern, EnumSet.of(DispatcherType.REQUEST));
@@ -113,7 +110,7 @@
}
/**
- * 安静停止内嵌的RESTful服务器.
+ * Stop the embed server gracefully.
*
*/
public void stop() {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/Bootstrap.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/Bootstrap.java
index ea1c34f..3e5ff58 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/Bootstrap.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/Bootstrap.java
@@ -31,19 +31,17 @@
import java.util.concurrent.CountDownLatch;
/**
- * Mesos框架启动器.
- *
- * @author caohao
+ * Mesos bootstrap.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
@Slf4j
public final class Bootstrap {
/**
- * 启动入口.
+ * Startup server.
*
- * @param args 命令行参数无需传入
- * @throws InterruptedException 线程中断异常
+ * @param args arguments
+ * @throws InterruptedException thread interrupted exception
*/
// CHECKSTYLE:OFF
public static void main(final String[] args) throws InterruptedException {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfiguration.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfiguration.java
index 97889df..1a2c927 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfiguration.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfiguration.java
@@ -23,9 +23,7 @@
import lombok.ToString;
/**
- * 云作业App配置对象.
- *
- * @author caohao
+ * Cloud app configuration.
*/
@AllArgsConstructor
@RequiredArgsConstructor
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationGsonFactory.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationGsonFactory.java
index caefc1d..a25d9a5 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationGsonFactory.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationGsonFactory.java
@@ -28,9 +28,7 @@
import java.io.IOException;
/**
- * 云作业App配置的Gson工厂.
- *
- * @author caohao
+ * Cloud app configuration gson factory.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class CloudAppConfigurationGsonFactory {
@@ -40,29 +38,27 @@
}
/**
- * 将云作业App配置转换为JSON字符串.
+ * Convert cloud app configuration to json string.
*
- * @param cloudAppConfig 云作业App配置对象
- * @return 作业配置JSON字符串
+ * @param cloudAppConfig cloud app config
+ * @return json string
*/
public static String toJson(final CloudAppConfiguration cloudAppConfig) {
return GsonFactory.getGson().toJson(cloudAppConfig);
}
/**
- * 将JSON字符串转换为云作业App配置.
+ * Convert json string to cloud app configuration.
*
- * @param cloudAppConfigJson 云作业App配置JSON字符串
- * @return 作业配置对象
+ * @param cloudAppConfigJson json string of the cloud app configuration
+ * @return cloud app configuration
*/
public static CloudAppConfiguration fromJson(final String cloudAppConfigJson) {
return GsonFactory.getGson().fromJson(cloudAppConfigJson, CloudAppConfiguration.class);
}
/**
- * 云作业App配置的Json转换适配器.
- *
- * @author caohao
+ * Json adapter of the cloud app configuration.
*/
public static final class CloudAppConfigurationGsonTypeAdapter extends TypeAdapter<CloudAppConfiguration> {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationNode.java
index 1e72708..292795d 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationNode.java
@@ -21,9 +21,7 @@
import lombok.NoArgsConstructor;
/**
- * 云作业App配置节点路径.
- *
- * @author caohao
+ * Cloud app configuration node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class CloudAppConfigurationNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationService.java
index f47cf66..bc77622 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/app/CloudAppConfigurationService.java
@@ -27,9 +27,7 @@
import java.util.List;
/**
- * 云作业App配置服务.
- *
- * @author caohao
+ * Cloud app configuration service.
*/
@RequiredArgsConstructor
public final class CloudAppConfigurationService {
@@ -37,37 +35,37 @@
private final CoordinatorRegistryCenter regCenter;
/**
- * 添加云作业APP配置.
+ * Add cloud app configuration.
*
- * @param appConfig 云作业App配置对象
+ * @param appConfig cloud app configuration
*/
public void add(final CloudAppConfiguration appConfig) {
regCenter.persist(CloudAppConfigurationNode.getRootNodePath(appConfig.getAppName()), CloudAppConfigurationGsonFactory.toJson(appConfig));
}
/**
- * 修改云作业APP配置.
+ * Update cloud app configuration.
*
- * @param appConfig 云作业App配置对象
+ * @param appConfig cloud app configuration
*/
public void update(final CloudAppConfiguration appConfig) {
regCenter.update(CloudAppConfigurationNode.getRootNodePath(appConfig.getAppName()), CloudAppConfigurationGsonFactory.toJson(appConfig));
}
/**
- * 根据云作业App名称获取App配置.
+ * Load app configuration by app name.
*
- * @param appName 云作业App名称
- * @return 云作业App配置
+ * @param appName application name
+ * @return cloud app configuration
*/
public Optional<CloudAppConfiguration> load(final String appName) {
return Optional.fromNullable(CloudAppConfigurationGsonFactory.fromJson(regCenter.get(CloudAppConfigurationNode.getRootNodePath(appName))));
}
/**
- * 获取所有注册的云作业App配置.
+ * Load all registered cloud app configurations.
*
- * @return 注册的云作业App配置
+ * @return collection of the registered cloud app configuration
*/
public Collection<CloudAppConfiguration> loadAll() {
if (!regCenter.isExisted(CloudAppConfigurationNode.ROOT)) {
@@ -85,9 +83,9 @@
}
/**
- * 删除云作业App配置.
+ * Remove cloud app configuration by app name.
*
- * @param appName 云作业App名称
+ * @param appName to be removed application name
*/
public void remove(final String appName) {
regCenter.remove(CloudAppConfigurationNode.getRootNodePath(appName));
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/constants/CloudConfigurationConstants.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/constants/CloudConfigurationConstants.java
index 98c35e2..f4340be 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/constants/CloudConfigurationConstants.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/constants/CloudConfigurationConstants.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.scheduler.config.constants;
/**
- * Cloud配置的常量.
- *
- * @author caohao
+ * Cloud configuration constants.
*/
public final class CloudConfigurationConstants {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfiguration.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfiguration.java
index 93637eb..91ab5f8 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfiguration.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfiguration.java
@@ -24,9 +24,7 @@
import lombok.RequiredArgsConstructor;
/**
- * 云作业配置对象.
- *
- * @author zhangliang
+ * Cloud job configuration.
*/
@RequiredArgsConstructor
@AllArgsConstructor
@@ -48,9 +46,9 @@
private String applicationContext;
/**
- * 获取作业名称.
+ * Get job name.
*
- * @return 作业名称
+ * @return job name
*/
public String getJobName() {
return typeConfig.getCoreConfig().getJobName();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationGsonFactory.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationGsonFactory.java
index a37bc35..ba8df54 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationGsonFactory.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationGsonFactory.java
@@ -31,10 +31,7 @@
import java.util.Map;
/**
- * Cloud作业配置的Gson工厂.
- *
- * @author zhangliang
- * @author caohao
+ * Cloud job configuration gson factory.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class CloudJobConfigurationGsonFactory {
@@ -44,29 +41,27 @@
}
/**
- * 将作业配置转换为JSON字符串.
+ * Convert cloud job configuration to json string.
*
- * @param cloudJobConfig 作业配置对象
- * @return 作业配置JSON字符串
+ * @param cloudJobConfig cloud job configuration
+ * @return the json string of the cloud job configuration
*/
public static String toJson(final CloudJobConfiguration cloudJobConfig) {
return GsonFactory.getGson().toJson(cloudJobConfig);
}
/**
- * 将JSON字符串转换为作业配置.
+ * Convert json string to cloud job configuration.
*
- * @param cloudJobConfigJson 作业配置JSON字符串
- * @return 作业配置对象
+ * @param cloudJobConfigJson json string of the cloud job configuration
+ * @return cloud job configuration
*/
public static CloudJobConfiguration fromJson(final String cloudJobConfigJson) {
return GsonFactory.getGson().fromJson(cloudJobConfigJson, CloudJobConfiguration.class);
}
-
+
/**
- * Cloud作业配置的Json转换适配器.
- *
- * @author zhangliang
+ * Json adapter of the cloud job configuration.
*/
public static final class CloudJobConfigurationGsonTypeAdapter extends AbstractJobConfigurationGsonTypeAdapter<CloudJobConfiguration> {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationListener.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationListener.java
index 5c0110d..592ff68 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationListener.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationListener.java
@@ -31,10 +31,7 @@
import java.util.concurrent.Executors;
/**
- * 云作业配置变更监听.
- *
- * @author zhangliang
- * @author caohao
+ * Cloud job configuration change listener.
*/
@Slf4j
public final class CloudJobConfigurationListener implements TreeCacheListener {
@@ -93,14 +90,14 @@
}
/**
- * 启动云作业配置变更监听服务.
+ * Start the listener service of the cloud job service.
*/
public void start() {
getCache().getListenable().addListener(this, Executors.newSingleThreadExecutor());
}
/**
- * 停止云作业配置变更监听服务.
+ * Stop the listener service of the cloud job service.
*/
public void stop() {
getCache().getListenable().removeListener(this);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationNode.java
index 9d1cdfb..59f991d 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationNode.java
@@ -21,9 +21,7 @@
import lombok.NoArgsConstructor;
/**
- * 作业配置节点路径.
- *
- * @author zhangliang
+ * Cloud job configuration node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class CloudJobConfigurationNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationService.java
index bba6240..abd6b73 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobConfigurationService.java
@@ -27,9 +27,7 @@
import java.util.List;
/**
- * 作业配置服务.
- *
- * @author zhangliang
+ * Cloud job configuration service.
*/
@RequiredArgsConstructor
public final class CloudJobConfigurationService {
@@ -37,27 +35,27 @@
private final CoordinatorRegistryCenter regCenter;
/**
- * 添加云作业配置.
+ * Add cloud job configuration.
*
- * @param jobConfig 云作业配置对象
+ * @param jobConfig cloud job configuration
*/
public void add(final CloudJobConfiguration jobConfig) {
regCenter.persist(CloudJobConfigurationNode.getRootNodePath(jobConfig.getJobName()), CloudJobConfigurationGsonFactory.toJson(jobConfig));
}
/**
- * 修改云作业配置.
+ * Update cloud job configuration.
*
- * @param jobConfig 云作业配置对象
+ * @param jobConfig cloud job configuration
*/
public void update(final CloudJobConfiguration jobConfig) {
regCenter.update(CloudJobConfigurationNode.getRootNodePath(jobConfig.getJobName()), CloudJobConfigurationGsonFactory.toJson(jobConfig));
}
/**
- * 获取所有注册的云作业配置.
- *
- * @return 注册的云作业配置
+ * Load all registered cloud job configurations.
+ *
+ * @return collection of the registered cloud job configuration
*/
public Collection<CloudJobConfiguration> loadAll() {
if (!regCenter.isExisted(CloudJobConfigurationNode.ROOT)) {
@@ -75,19 +73,19 @@
}
/**
- * 根据作业名称获取云作业配置.
- *
- * @param jobName 作业名称
- * @return 云作业配置
+ * Load cloud job configuration by job name.
+ *
+ * @param jobName job name
+ * @return cloud job configuration
*/
public Optional<CloudJobConfiguration> load(final String jobName) {
return Optional.fromNullable(CloudJobConfigurationGsonFactory.fromJson(regCenter.get(CloudJobConfigurationNode.getRootNodePath(jobName))));
}
/**
- * 删除云作业.
+ * Remove cloud job configuration.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void remove(final String jobName) {
regCenter.remove(CloudJobConfigurationNode.getRootNodePath(jobName));
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobExecutionType.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobExecutionType.java
index be1ada7..85531e1 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobExecutionType.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/config/job/CloudJobExecutionType.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.scheduler.config.job;
/**
- * 作业执行类型.
- *
- * @author zhangliang
+ * Cloud job execution type.
*/
public enum CloudJobExecutionType {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/context/JobContext.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/context/JobContext.java
index 4e3ce72..c39c724 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/context/JobContext.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/context/JobContext.java
@@ -26,9 +26,7 @@
import java.util.List;
/**
- * 作业运行上下文.
- *
- * @author zhangliang
+ * Job running context.
*/
@RequiredArgsConstructor
@Getter
@@ -41,11 +39,11 @@
private final ExecutionType type;
/**
- * 通过作业配置创建作业运行上下文.
- *
- * @param jobConfig 作业配置
- * @param type 执行类型
- * @return 作业运行上下文
+ * Create job running context from job configuration and execution type.
+ *
+ * @param jobConfig job configuration
+ * @param type execution type
+ * @return Job running context
*/
public static JobContext from(final CloudJobConfiguration jobConfig, final ExecutionType type) {
int shardingTotalCount = jobConfig.getTypeConfig().getCoreConfig().getShardingTotalCount();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/BootstrapEnvironment.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/BootstrapEnvironment.java
index a129ec6..8555592 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/BootstrapEnvironment.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/BootstrapEnvironment.java
@@ -33,9 +33,7 @@
import java.util.Properties;
/**
- * 启动环境对象.
- *
- * @author zhangliang
+ * Bootstrap env.
*/
@Slf4j
public final class BootstrapEnvironment {
@@ -74,29 +72,29 @@
}
/**
- * 获取Framework的Hostname和Port.
+ * Get the host and port of the framework.
*
- * @return Framework的Hostname和Port
+ * @return host and port of the framework
*/
public String getFrameworkHostPort() {
return String.format("%s:%d", getMesosConfiguration().getHostname(), getRestfulServerConfiguration().getPort());
}
/**
- * 获取Mesos配置对象.
+ * Get mesos config.
*
- * @return Mesos配置对象
+ * @return mesos config
*/
public MesosConfiguration getMesosConfiguration() {
return new MesosConfiguration(getValue(EnvironmentArgument.USER), getValue(EnvironmentArgument.MESOS_URL), getValue(EnvironmentArgument.HOSTNAME));
}
/**
- * 获取Zookeeper配置对象.
+ * Get zookeeper config.
*
- * @return Zookeeper配置对象
+ * @return zookeeper config
*/
- // TODO 其他zkConfig的值可配置
+ // TODO Other zkConfig values are configurable
public ZookeeperConfiguration getZookeeperConfiguration() {
ZookeeperConfiguration result = new ZookeeperConfiguration(getValue(EnvironmentArgument.ZOOKEEPER_SERVERS), getValue(EnvironmentArgument.ZOOKEEPER_NAMESPACE));
String digest = getValue(EnvironmentArgument.ZOOKEEPER_DIGEST);
@@ -107,27 +105,27 @@
}
/**
- * 获取Restful服务器配置对象.
+ * Get restful server config.
*
- * @return Restful服务器配置对象
+ * @return restful server config
*/
public RestfulServerConfiguration getRestfulServerConfiguration() {
return new RestfulServerConfiguration(Integer.parseInt(getValue(EnvironmentArgument.PORT)));
}
/**
- * 获取Mesos框架配置对象.
+ * Get framework config.
*
- * @return Mesos框架配置对象
+ * @return the framework config
*/
public FrameworkConfiguration getFrameworkConfiguration() {
return new FrameworkConfiguration(Integer.parseInt(getValue(EnvironmentArgument.JOB_STATE_QUEUE_SIZE)), Integer.parseInt(getValue(EnvironmentArgument.RECONCILE_INTERVAL_MINUTES)));
}
/**
- * 获取作业数据库事件配置.
+ * Get the job event rdb config.
*
- * @return 作业数据库事件配置
+ * @return job event rdb config
*/
public Optional<JobEventRdbConfiguration> getJobEventRdbConfiguration() {
String driver = getValue(EnvironmentArgument.EVENT_TRACE_RDB_DRIVER);
@@ -146,9 +144,9 @@
}
/**
- * 获取作业数据库事件配置Map.
+ * Get job event rdb config map.
*
- * @return 作业数据库事件配置Map
+ * @return map of the rdb config
*/
// CHECKSTYLE:OFF
public HashMap<String, String> getJobEventRdbConfigurationMap() {
@@ -162,9 +160,9 @@
}
/**
- * 获取该framework的mesos角色.
- *
- * @return 角色的可选值.
+ * Get the role of the mesos.
+ *
+ * @return the role.
*/
public Optional<String> getMesosRole() {
String role = getValue(EnvironmentArgument.MESOS_ROLE);
@@ -183,9 +181,7 @@
}
/**
- * 环境参数.
- *
- * @author zhangliang
+ * Env args.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/FrameworkConfiguration.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/FrameworkConfiguration.java
index 8389d83..635feb3 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/FrameworkConfiguration.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/FrameworkConfiguration.java
@@ -21,9 +21,7 @@
import lombok.RequiredArgsConstructor;
/**
- * Mesos框架配置项.
- *
- * @author zhangliang
+ * Mesos framework config.
*/
@RequiredArgsConstructor
@Getter
@@ -34,9 +32,9 @@
private final int reconcileIntervalMinutes;
/**
- * 是否启用协调服务.
+ * Check whether reconcile service is enabled or not.
*
- * @return true 启用 false 不启用
+ * @return true is enabled, otherwise not
*/
public boolean isEnabledReconcile() {
return reconcileIntervalMinutes > 0;
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/MesosConfiguration.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/MesosConfiguration.java
index 60c012d..1f4831e 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/MesosConfiguration.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/MesosConfiguration.java
@@ -21,21 +21,19 @@
import lombok.RequiredArgsConstructor;
/**
- * Mesos配置项.
- *
- * @author zhangliang
+ * Mesos config.
*/
@RequiredArgsConstructor
@Getter
public final class MesosConfiguration {
/**
- * 框架名称.
+ * Framework name.
*/
public static final String FRAMEWORK_NAME = "Elastic-Job-Cloud";
/**
- * 框架失效转移超时秒数. 默认为1周
+ * Framework failover timeout in seconds. Default is one week.
*/
public static final double FRAMEWORK_FAILOVER_TIMEOUT_SECONDS = 60 * 60 * 24 * 7D;
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/RestfulServerConfiguration.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/RestfulServerConfiguration.java
index a4b3179..2e51f09 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/RestfulServerConfiguration.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/env/RestfulServerConfiguration.java
@@ -21,9 +21,7 @@
import lombok.RequiredArgsConstructor;
/**
- * Restful服务器配置项.
- *
- * @author zhangliang
+ * Restful config.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/FrameworkIDService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/FrameworkIDService.java
index 2e59ffb..fa0e127 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/FrameworkIDService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/FrameworkIDService.java
@@ -23,9 +23,7 @@
import lombok.RequiredArgsConstructor;
/**
- * FrameworkID 的保存器.
- *
- * @author gaohongtao
+ * FrameworkID service.
*/
@RequiredArgsConstructor
public final class FrameworkIDService {
@@ -33,9 +31,9 @@
private final CoordinatorRegistryCenter regCenter;
/**
- * 获取FrameworkID,返回值是一个可选的结果.
+ * Fetch FrameworkID.
*
- * @return 获取FrameworkID的可选结果
+ * @return the optional value of FrameworkID
*/
public Optional<String> fetch() {
String frameworkId = regCenter.getDirectly(HANode.FRAMEWORK_ID_NODE);
@@ -43,9 +41,9 @@
}
/**
- * 保存FrameworkID.
+ * Save FrameworkID.
*
- * @param id Framework的ID
+ * @param id framework id
*/
public void save(final String id) {
if (!regCenter.isExisted(HANode.FRAMEWORK_ID_NODE)) {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/HANode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/HANode.java
index ebc8821..789b15b 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/HANode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/HANode.java
@@ -18,24 +18,22 @@
package org.apache.shardingsphere.elasticjob.cloud.scheduler.ha;
/**
- * 保存HA相关数据节点.
- *
- * @author gaohongtao
+ * HA node.
*/
public final class HANode {
/**
- * HA根节点.
+ * HA node.
*/
public static final String ROOT = "/ha";
/**
- * FrameworkID保存的节点.
+ * FrameworkID node.
*/
public static final String FRAMEWORK_ID_NODE = ROOT + "/framework_id";
/**
- * 选举节点.
+ * Election node.
*/
public static final String ELECTION_NODE = ROOT + "/election";
}
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/SchedulerElectionCandidate.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/SchedulerElectionCandidate.java
index 19c3a1e..ab2f3d1 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/SchedulerElectionCandidate.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/ha/SchedulerElectionCandidate.java
@@ -23,9 +23,7 @@
import org.apache.shardingsphere.elasticjob.cloud.reg.base.CoordinatorRegistryCenter;
/**
- * 调度器选举候选人.
- *
- * @author caohao
+ * Scheduler election candidate.
*/
public final class SchedulerElectionCandidate implements ElectionCandidate {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/AppConstraintEvaluator.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/AppConstraintEvaluator.java
index a803060..027e07b 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/AppConstraintEvaluator.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/AppConstraintEvaluator.java
@@ -40,13 +40,7 @@
import java.util.Set;
/**
- * App目标slave适配度限制器.
- *
- * <p>
- * 选择slave时需要考虑其上是否运行有App的executor,如果没有运行executor需要将其资源消耗考虑进适配计算算法中.
- * </p>
- *
- * @author gaohongtao
+ * App constrain evaluator.
*/
@Slf4j
@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@@ -59,9 +53,9 @@
private final FacadeService facadeService;
/**
- * 初始化.
+ * Init.
*
- * @param facadeService 为Mesos提供的门面服务
+ * @param facadeService Mesos facade service
*/
public static void init(final FacadeService facadeService) {
instance = new AppConstraintEvaluator(facadeService);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/FacadeService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/FacadeService.java
index ee62bf3..2858da3 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/FacadeService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/FacadeService.java
@@ -46,10 +46,7 @@
import java.util.Set;
/**
- * 为Mesos提供的门面服务.
- *
- * @author zhangliang
- * @author caohao
+ * Mesos facade service.
*/
@Slf4j
public final class FacadeService {
@@ -82,7 +79,7 @@
}
/**
- * 启动门面服务.
+ * Start facade service.
*/
public void start() {
log.info("Elastic Job: Start facade service");
@@ -90,9 +87,9 @@
}
/**
- * 获取有资格运行的作业.
+ * Get eligible job.
*
- * @return 作业上下文集合
+ * @return collection of eligible job context
*/
public Collection<JobContext> getEligibleJobContext() {
Collection<JobContext> failoverJobContexts = failoverService.getAllEligibleJobContexts();
@@ -104,9 +101,9 @@
}
/**
- * 从队列中删除已运行的作业.
+ * Remove launched task from queue.
*
- * @param taskContexts 任务上下文集合
+ * @param taskContexts task running contexts
*/
public void removeLaunchTasksFromQueue(final List<TaskContext> taskContexts) {
List<TaskContext> failoverTaskContexts = new ArrayList<>(taskContexts.size());
@@ -134,37 +131,37 @@
}
/**
- * 将任务运行时上下文放入运行时队列.
+ * Add task to running queue.
*
- * @param taskContext 任务运行时上下文
+ * @param taskContext task running context
*/
public void addRunning(final TaskContext taskContext) {
runningService.add(taskContext);
}
/**
- * 更新常驻作业运行状态.
+ * Update daemon task status.
*
- * @param taskContext 任务运行时上下文
- * @param isIdle 是否空闲
+ * @param taskContext task running context
+ * @param isIdle set to idle or not
*/
public void updateDaemonStatus(final TaskContext taskContext, final boolean isIdle) {
runningService.updateIdle(taskContext, isIdle);
}
/**
- * 将任务从运行时队列删除.
+ * Remove task from running queue.
*
- * @param taskContext 任务运行时上下文
+ * @param taskContext task running context
*/
public void removeRunning(final TaskContext taskContext) {
runningService.remove(taskContext);
}
/**
- * 记录失效转移队列.
+ * Record task to failover queue.
*
- * @param taskContext 任务上下文
+ * @param taskContext task running context
*/
public void recordFailoverTask(final TaskContext taskContext) {
Optional<CloudJobConfiguration> jobConfigOptional = jobConfigService.load(taskContext.getMetaInfo().getJobName());
@@ -185,48 +182,48 @@
}
/**
- * 将瞬时作业放入待执行队列.
+ * Add transient job to ready queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void addTransient(final String jobName) {
readyService.addTransient(jobName);
}
/**
- * 根据作业名称获取云作业配置.
+ * Load cloud job config.
*
- * @param jobName 作业名称
- * @return 云作业配置
+ * @param jobName job name
+ * @return cloud job config
*/
public Optional<CloudJobConfiguration> load(final String jobName) {
return jobConfigService.load(jobName);
}
/**
- * 根据作业应用名称获取云作业应用配置.
+ * Load app config by app name.
*
- * @param appName 作业应用名称
- * @return 云作业应用配置
+ * @param appName app name
+ * @return cloud app config
*/
public Optional<CloudAppConfiguration> loadAppConfig(final String appName) {
return appConfigService.load(appName);
}
/**
- * 根据作业元信息获取失效转移作业Id.
+ * Get failover task id by task meta info.
*
- * @param metaInfo 作业元信息
- * @return 失效转移作业Id
+ * @param metaInfo task meta info
+ * @return failover task id
*/
public Optional<String> getFailoverTaskId(final TaskContext.MetaInfo metaInfo) {
return failoverService.getTaskId(metaInfo);
}
/**
- * 将常驻作业放入待执行队列.
+ * Add daemon job to ready queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void addDaemonJobToReadyQueue(final String jobName) {
Optional<CloudJobConfiguration> jobConfigOptional = jobConfigService.load(jobName);
@@ -240,12 +237,10 @@
}
/**
- * 根据作业执行类型判断作业是否在运行.
+ * Determine whether the task is running or not.
*
- * <p>READY类型的作业为整体, 任意一片运行都视为作业运行. FAILOVER则仅以当前分片运行为运行依据.</p>
- *
- * @param taskContext 任务运行时上下文
- * @return 作业是否在运行
+ * @param taskContext task running context
+ * @return true is running, otherwise not
*/
public boolean isRunning(final TaskContext taskContext) {
return ExecutionType.FAILOVER != taskContext.getType() && !runningService.getRunningTasks(taskContext.getMetaInfo().getJobName()).isEmpty()
@@ -253,57 +248,57 @@
}
/**
- * 添加任务主键和主机名称的映射.
+ * Add mapping of the task primary key and host name.
*
- * @param taskId 任务主键
- * @param hostname 主机名称
+ * @param taskId task primary key
+ * @param hostname host name
*/
public void addMapping(final String taskId, final String hostname) {
runningService.addMapping(taskId, hostname);
}
/**
- * 根据任务主键获取主机名称并清除该任务.
+ * Retrieve hostname and then remove task.
*
- * @param taskId 任务主键
- * @return 删除任务的主机名称
+ * @param taskId task primary key
+ * @return hostname of the removed task
*/
public String popMapping(final String taskId) {
return runningService.popMapping(taskId);
}
/**
- * 获取待运行的全部任务.
+ * Get all ready tasks.
*
- * @return 待运行的全部任务
+ * @return ready tasks
*/
public Map<String, Integer> getAllReadyTasks() {
return readyService.getAllReadyTasks();
}
/**
- * 获取所有运行中的任务.
+ * Get all running tasks.
*
- * @return 运行中任务集合
+ * @return running tasks
*/
public Map<String, Set<TaskContext>> getAllRunningTasks() {
return runningService.getAllRunningTasks();
}
/**
- * 获取待失效转移的全部任务.
+ * Get all failover tasks.
*
- * @return 待失效转移的全部任务
+ * @return failover tasks
*/
public Map<String, Collection<FailoverTaskInfo>> getAllFailoverTasks() {
return failoverService.getAllFailoverTasks();
}
/**
- * 判断作业是否被禁用.
+ * Determine whether the job is disable or not.
*
- * @param jobName 作业名称
- * @return 作业是否被禁用
+ * @param jobName job name
+ * @return true is disabled, otherwise not
*/
public boolean isJobDisabled(final String jobName) {
Optional<CloudJobConfiguration> jobConfiguration = jobConfigService.load(jobName);
@@ -311,27 +306,27 @@
}
/**
- * 将作业移出禁用队列.
+ * Enable job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void enableJob(final String jobName) {
disableJobService.remove(jobName);
}
/**
- * 将作业放入禁用队列.
+ * Disable job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void disableJob(final String jobName) {
disableJobService.add(jobName);
}
/**
- * 获取所有正在运行的Executor的信息.
+ * Get all running executor info.
*
- * @return Executor信息集合
+ * @return collection of executor info
* @throws JSONException json exception
*/
public Collection<MesosStateService.ExecutorStateInfo> loadExecutorInfo() throws JSONException {
@@ -339,11 +334,11 @@
}
/**
- * 停止门面服务.
+ * Stop facade service.
*/
public void stop() {
log.info("Elastic Job: Stop facade service");
- // TODO 停止作业调度
+ // TODO stop scheduler
runningService.clear();
}
}
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/JobTaskRequest.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/JobTaskRequest.java
index 584185a..b933d9c 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/JobTaskRequest.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/JobTaskRequest.java
@@ -29,9 +29,7 @@
import java.util.Map;
/**
- * 作业任务请求对象.
- *
- * @author zhangliang
+ * Job task request.
*/
@RequiredArgsConstructor
public final class JobTaskRequest implements TaskRequest {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LaunchingTasks.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LaunchingTasks.java
index 80abea3..cff6f08 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LaunchingTasks.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LaunchingTasks.java
@@ -34,9 +34,7 @@
import java.util.Map;
/**
- * 分配任务行为包.
- *
- * @author zhangliang
+ * Launching tasks.
*/
@Slf4j
public final class LaunchingTasks {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LeasesQueue.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LeasesQueue.java
index eb2656a..3f0e63a 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LeasesQueue.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/LeasesQueue.java
@@ -29,9 +29,7 @@
import java.util.concurrent.LinkedBlockingQueue;
/**
- * 资源预占队列.
- *
- * @author zhangliang
+ * Lease queue.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class LeasesQueue {
@@ -41,27 +39,27 @@
private final BlockingQueue<VirtualMachineLease> queue = new LinkedBlockingQueue<>();
/**
- * 获取实例.
+ * Get instance.
*
- * @return 单例对象
+ * @return singleton instance
*/
public static LeasesQueue getInstance() {
return INSTANCE;
}
/**
- * 添加资源至队列预占.
+ * Offer resource to lease queue.
*
- * @param offer 资源
+ * @param offer resource
*/
public void offer(final Protos.Offer offer) {
queue.offer(new VMLeaseObject(offer));
}
/**
- * 出栈队列资源.
+ * Dump all the resources from lease queue.
*
- * @return 队列资源集合
+ * @return collection of resources
*/
public List<VirtualMachineLease> drainTo() {
List<VirtualMachineLease> result = new ArrayList<>(queue.size());
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/MesosStateService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/MesosStateService.java
index 0313658..ce7e1f2 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/MesosStateService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/MesosStateService.java
@@ -39,9 +39,7 @@
import java.util.List;
/**
- * Mesos状态服务.
- *
- * @author gaohongtao
+ * Mesos state service.
*/
@Slf4j
public class MesosStateService {
@@ -55,28 +53,28 @@
}
/**
- * 注册Mesos的Master信息.
+ * Register master info of Mesos.
*
- * @param hostName Master的主机名
- * @param port Master端口
+ * @param hostName hostname of master
+ * @param port port of master
*/
public static synchronized void register(final String hostName, final int port) {
stateUrl = String.format("http://%s:%d/state", hostName, port);
}
/**
- * 注销Mesos的Master信息.
+ * Deregister master info of Mesos.
*/
public static synchronized void deregister() {
stateUrl = null;
}
/**
- * 获取沙箱信息.
+ * Get sandbox info.
*
- * @param appName 作业云配置App的名字
- * @return 沙箱信息
- * @throws JSONException 解析JSON格式异常
+ * @param appName app name
+ * @return sandbox info in json format
+ * @throws JSONException parse json exception
*/
public JsonArray sandbox(final String appName) throws JSONException {
JSONObject state = fetch(stateUrl);
@@ -105,11 +103,11 @@
}
/**
- * 查找执行器信息.
+ * Get executor by app name.
*
- * @param appName 作业云配置App的名字
- * @return 执行器信息
- * @throws JSONException 解析JSON格式异常
+ * @param appName app name
+ * @return executor state info
+ * @throws JSONException parse json exception
*/
public Collection<ExecutorStateInfo> executors(final String appName) throws JSONException {
return Collections2.transform(findExecutors(fetch(stateUrl).getJSONArray("frameworks"), appName), new Function<JSONObject, ExecutorStateInfo>() {
@@ -125,10 +123,10 @@
}
/**
- * 获取所有执行器.
+ * Get all executors.
*
- * @return 执行器信息
- * @throws JSONException 解析JSON格式异常
+ * @return collection of executor state info
+ * @throws JSONException parse json exception
*/
public Collection<ExecutorStateInfo> executors() throws JSONException {
return executors(null);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/ReconcileService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/ReconcileService.java
index d668a48..cd8aa4c 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/ReconcileService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/ReconcileService.java
@@ -35,9 +35,7 @@
import java.util.concurrent.locks.ReentrantLock;
/**
- * 协调Mesos与调度器之间的作业状态.
- *
- * @author gaohongtao
+ * Reconcile service.
*/
@RequiredArgsConstructor
@Slf4j
@@ -61,7 +59,7 @@
}
/**
- * 全量的显示协调.
+ * Explicit reconcile service.
*/
public void explicitReconcile() {
lock.lock();
@@ -89,7 +87,7 @@
}
/**
- * 隐式协调.
+ * Implicit reconcile service.
*/
public void implicitReconcile() {
lock.lock();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerEngine.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerEngine.java
index d13f5dd..1767c1f 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerEngine.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerEngine.java
@@ -32,9 +32,7 @@
import java.util.List;
/**
- * 作业云引擎.
- *
- * @author zhangliang
+ * Scheduler engine.
*/
@RequiredArgsConstructor
@Slf4j
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerService.java
index 2058e51..cf94e26 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SchedulerService.java
@@ -39,10 +39,7 @@
import org.apache.mesos.SchedulerDriver;
/**
- * 调度服务.
- *
- * @author zhangliang
- * @author caohao
+ * Scheduler service.
*/
@Slf4j
@AllArgsConstructor
@@ -124,7 +121,7 @@
}
/**
- * 以守护进程方式启动.
+ * Start as a daemon.
*/
public void start() {
facadeService.start();
@@ -140,7 +137,7 @@
}
/**
- * 停止运行.
+ * Stop.
*/
public void stop() {
restfulService.stop();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SupportedExtractionType.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SupportedExtractionType.java
index 614372e..edbca33 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SupportedExtractionType.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/SupportedExtractionType.java
@@ -23,9 +23,7 @@
import java.util.Set;
/**
- * Mesos所支持的压缩类型.
- *
- * @author zhangliang
+ * Extraction type.
*/
@NoArgsConstructor
public final class SupportedExtractionType {
@@ -45,9 +43,10 @@
}
/**
- * 判断URL的文件是否为压缩格式.
- * @param appURL 应用URL地址
- * @return URL的文件是否为压缩格式
+ * Check whether the url is supported to extract or not.
+ *
+ * @param appURL app url
+ * @return true is the url supported, otherwise not
*/
public static boolean isExtraction(final String appURL) {
for (String each : EXTRACTION_TYPES) {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskInfoData.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskInfoData.java
index 43ec440..bd4fe28 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskInfoData.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskInfoData.java
@@ -30,9 +30,7 @@
import java.util.Map;
/**
- * 随任务传递的数据.
- *
- * @author zhangliang
+ * Task info data.
*/
@RequiredArgsConstructor
public final class TaskInfoData {
@@ -42,9 +40,9 @@
private final CloudJobConfiguration jobConfig;
/**
- * 序列化.
+ * Serialize.
*
- * @return 序列化后的字节数组
+ * @return byte array
*/
public byte[] serialize() {
Map<String, Object> result = new LinkedHashMap<>(2, 1);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskLaunchScheduledService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskLaunchScheduledService.java
index 075588d..69c31f8 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskLaunchScheduledService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/mesos/TaskLaunchScheduledService.java
@@ -60,10 +60,7 @@
import java.util.concurrent.TimeUnit;
/**
- * 任务提交调度服务.
- *
- * @author zhangliang
- * @author gaohongtao
+ * Task launch schedule service.
*/
@RequiredArgsConstructor
@Slf4j
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/ProducerManager.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/ProducerManager.java
index 9acdb63..4fe441a 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/ProducerManager.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/ProducerManager.java
@@ -39,10 +39,7 @@
import org.apache.mesos.SchedulerDriver;
/**
- * 发布任务作业调度管理器.
- *
- * @author caohao
- * @author zhangliang
+ * Producer manager.
*/
@Slf4j
public final class ProducerManager {
@@ -75,7 +72,7 @@
}
/**
- * 启动作业调度器.
+ * Start the producer manager.
*/
public void startup() {
log.info("Start producer manager");
@@ -86,9 +83,9 @@
}
/**
- * 注册作业.
+ * Register the job.
*
- * @param jobConfig 作业配置
+ * @param jobConfig cloud job config
*/
public void register(final CloudJobConfiguration jobConfig) {
if (disableJobService.isDisabled(jobConfig.getJobName())) {
@@ -107,9 +104,9 @@
}
/**
- * 更新作业配置.
+ * Update the job.
*
- * @param jobConfig 作业配置
+ * @param jobConfig cloud job config
*/
public void update(final CloudJobConfiguration jobConfig) {
Optional<CloudJobConfiguration> jobConfigFromZk = configService.load(jobConfig.getJobName());
@@ -121,9 +118,9 @@
}
/**
- * 注销作业.
+ * Deregister the job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void deregister(final String jobName) {
Optional<CloudJobConfiguration> jobConfig = configService.load(jobName);
@@ -135,9 +132,9 @@
}
/**
- * 调度作业.
- *
- * @param jobConfig 作业配置
+ * Schedule the job.
+ *
+ * @param jobConfig cloud job config
*/
public void schedule(final CloudJobConfiguration jobConfig) {
if (disableAppService.isDisabled(jobConfig.getAppName()) || disableJobService.isDisabled(jobConfig.getJobName())) {
@@ -151,9 +148,9 @@
}
/**
- * 停止调度作业.
+ * Stop to schedule the job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void unschedule(final String jobName) {
for (TaskContext each : runningService.getRunningTasks(jobName)) {
@@ -168,9 +165,9 @@
}
/**
- * 重新调度作业.
+ * Re-schedule the job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void reschedule(final String jobName) {
unschedule(jobName);
@@ -181,18 +178,18 @@
}
/**
- * 向Executor发送消息.
+ * Send message to executor.
*
- * @param executorId 接受消息的executorId
- * @param slaveId 运行executor的slaveId
- * @param data 消息内容
+ * @param executorId the executor of which to receive message
+ * @param slaveId the slave id of the executor
+ * @param data message content
*/
public void sendFrameworkMessage(final ExecutorID executorId, final SlaveID slaveId, final byte[] data) {
schedulerDriver.sendFrameworkMessage(executorId, slaveId, data);
}
/**
- * 关闭作业调度器.
+ * Shutdown the producer manager.
*/
public void shutdown() {
log.info("Stop producer manager");
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerRepository.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerRepository.java
index 842433d..9380d5a 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerRepository.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerRepository.java
@@ -26,10 +26,7 @@
import java.util.concurrent.CopyOnWriteArrayList;
/**
- * 瞬时作业生成器数据访问对象.
- *
- * @author caohao
- * @author zhangliang
+ * Transient producer repository.
*/
final class TransientProducerRepository {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerScheduler.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerScheduler.java
index ba01603..2cfabe7 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerScheduler.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/producer/TransientProducerScheduler.java
@@ -41,9 +41,7 @@
import java.util.Properties;
/**
- * 发布瞬时作业任务的调度器.
- *
- * @author caohao
+ * Transient producer scheduler.
*/
final class TransientProducerScheduler {
@@ -87,7 +85,7 @@
return result;
}
- // TODO 并发优化
+ // TODO Concurrency optimization
synchronized void register(final CloudJobConfiguration jobConfig) {
String cron = jobConfig.getTypeConfig().getCoreConfig().getCron();
JobKey jobKey = buildJobKey(cron);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudAppRestfulApi.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudAppRestfulApi.java
index b14d65f..ea9a83d 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudAppRestfulApi.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudAppRestfulApi.java
@@ -47,9 +47,7 @@
import java.util.Collection;
/**
- * 云作业应用的REST API.
- *
- * @author caohao
+ * Cloud app restful api.
*/
@Path("/app")
public final class CloudAppRestfulApi {
@@ -74,10 +72,10 @@
}
/**
- * 初始化.
+ * Init.
*
- * @param producerManager 生产管理器
- * @param regCenter 注册中心
+ * @param producerManager producer manager
+ * @param regCenter registry center
*/
public static void init(final CoordinatorRegistryCenter regCenter, final ProducerManager producerManager) {
CloudAppRestfulApi.regCenter = regCenter;
@@ -86,9 +84,9 @@
}
/**
- * 注册应用配置.
+ * Register app config.
*
- * @param appConfig 应用配置
+ * @param appConfig cloud app config
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
@@ -101,9 +99,9 @@
}
/**
- * 更新应用配置.
+ * Update app config.
*
- * @param appConfig 应用配置
+ * @param appConfig cloud app config
*/
@PUT
@Consumes(MediaType.APPLICATION_JSON)
@@ -112,10 +110,10 @@
}
/**
- * 查询应用配置.
+ * Query app config.
*
- * @param appName 应用配置名称
- * @return 应用配置
+ * @param appName app name
+ * @return cloud app config
*/
@GET
@Path("/{appName}")
@@ -129,9 +127,9 @@
}
/**
- * 查询全部应用配置.
+ * Find all registered app configs.
*
- * @return 全部应用配置
+ * @return collection of registered app configs
*/
@GET
@Path("/list")
@@ -141,11 +139,11 @@
}
/**
- * 查询应用是否被禁用.
+ * Query the app is disabled or not.
*
- * @param appName 应用名称
- * @return 应用是否被禁用
- * @throws JSONException JSON解析异常
+ * @param appName app name
+ * @return true is disabled, otherwise not
+ * @throws JSONException parse json exception
*/
@GET
@Path("/{appName}/disable")
@@ -155,9 +153,9 @@
}
/**
- * 禁用应用.
+ * Disable app config.
*
- * @param appName 应用名称
+ * @param appName app name
*/
@POST
@Path("/{appName}/disable")
@@ -173,10 +171,10 @@
}
/**
- * 启用应用.
+ * Enable app.
*
- * @param appName 应用名称
- * @throws JSONException JSON解析异常
+ * @param appName app name
+ * @throws JSONException parse json exception
*/
@DELETE
@Path("/{appName}/disable")
@@ -192,9 +190,9 @@
}
/**
- * 注销应用.
+ * Deregister app.
*
- * @param appName 应用名称
+ * @param appName app name
*/
@DELETE
@Path("/{appName}")
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudJobRestfulApi.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudJobRestfulApi.java
index b03cace..42cac9c 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudJobRestfulApi.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudJobRestfulApi.java
@@ -74,10 +74,7 @@
import java.util.Set;
/**
- * 作业云Job的REST API.
- *
- * @author zhangliang
- * @author liguangyun
+ * Cloud job restful api.
*/
@Path("/job")
@Slf4j
@@ -104,10 +101,10 @@
}
/**
- * 初始化.
+ * Init.
*
- * @param regCenter 注册中心
- * @param producerManager 生产管理器
+ * @param regCenter registry center
+ * @param producerManager producer manager
*/
public static void init(final CoordinatorRegistryCenter regCenter, final ProducerManager producerManager) {
CloudJobRestfulApi.regCenter = regCenter;
@@ -122,9 +119,9 @@
}
/**
- * 注册作业.
+ * Register cloud job.
*
- * @param jobConfig 作业配置
+ * @param jobConfig cloud job configuration
*/
@POST
@Path("/register")
@@ -134,9 +131,9 @@
}
/**
- * 更新作业配置.
+ * Update cloud job.
*
- * @param jobConfig 作业配置
+ * @param jobConfig cloud job configuration
*/
@PUT
@Path("/update")
@@ -146,9 +143,9 @@
}
/**
- * 注销作业.
+ * Deregister cloud job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
@DELETE
@Path("/deregister")
@@ -158,11 +155,11 @@
}
/**
- * 查询作业是否被禁用.
+ * Check whether the cloud job is disabled or not.
*
- * @param jobName 作业名称
- * @return 作业是否被禁用
- * @throws JSONException JSON解析异常
+ * @param jobName job name
+ * @return true is disabled, otherwise not
+ * @throws JSONException parse json exception
*/
@GET
@Path("/{jobName}/disable")
@@ -172,10 +169,10 @@
}
/**
- * 启用作业.
+ * Enable cloud job.
*
- * @param jobName 作业名称
- * @throws JSONException JSON解析异常
+ * @param jobName job name
+ * @throws JSONException parse json exception
*/
@DELETE
@Path("/{jobName}/disable")
@@ -188,9 +185,9 @@
}
/**
- * 禁用作业.
+ * Disable cloud job.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
@POST
@Path("/{jobName}/disable")
@@ -202,9 +199,9 @@
}
/**
- * 触发一次作业.
+ * Trigger job once.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
@POST
@Path("/trigger")
@@ -218,10 +215,10 @@
}
/**
- * 查询作业详情.
+ * Query job detail.
*
- * @param jobName 作业名称
- * @return 作业配置对象
+ * @param jobName job name
+ * @return the job detail
*/
@GET
@Path("/jobs/{jobName}")
@@ -235,9 +232,9 @@
}
/**
- * 查找全部作业.
+ * Find all jobs.
*
- * @return 全部作业
+ * @return all jobs
*/
@GET
@Path("/jobs")
@@ -247,9 +244,9 @@
}
/**
- * 查找运行中的全部任务.
+ * Find all running tasks.
*
- * @return 运行中的全部任务
+ * @return all running tasks
*/
@GET
@Path("tasks/running")
@@ -263,9 +260,9 @@
}
/**
- * 查找待运行的全部任务.
+ * Find all ready tasks.
*
- * @return 待运行的全部任务
+ * @return collection of all ready tasks
*/
@GET
@Path("tasks/ready")
@@ -283,9 +280,9 @@
}
/**
- * 查找待失效转移的全部任务.
+ * Find all failover tasks.
*
- * @return 失效转移的全部任务
+ * @return collection of all the failover tasks
*/
@GET
@Path("tasks/failover")
@@ -299,11 +296,11 @@
}
/**
- * 检索作业运行轨迹.
+ * Find job execution events.
*
- * @param info URL信息
- * @return 作业运行轨迹结果
- * @throws ParseException 解析异常
+ * @param info uri info
+ * @return job execution event
+ * @throws ParseException parse exception
*/
@GET
@Path("events/executions")
@@ -316,11 +313,11 @@
}
/**
- * 检索作业运行状态轨迹.
+ * Find job status trace events.
*
- * @param info URL信息
- * @return 作业运行轨迹结果
- * @throws ParseException 转换异常
+ * @param info uri info
+ * @return job status trace event
+ * @throws ParseException parse exception
*/
@GET
@Path("events/statusTraces")
@@ -371,10 +368,10 @@
}
/**
- * 获取任务运行结果统计数据.
+ * Find task result statistics.
*
- * @param since 时间跨度
- * @return 任务运行结果统计数据
+ * @param since time span
+ * @return task result statistics
*/
@GET
@Path("/statistics/tasks/results")
@@ -388,10 +385,10 @@
}
/**
- * 获取任务运行结果统计数据.
+ * Get task result statistics.
*
- * @param period 时间跨度
- * @return 任务运行结果统计数据
+ * @param period time period
+ * @return task result statistics
*/
@GET
@Path("/statistics/tasks/results/{period}")
@@ -411,10 +408,10 @@
}
/**
- * 获取任务运行统计数据集合.
+ * Find task running statistics.
*
- * @param since 时间跨度
- * @return 任务运行统计数据集合
+ * @param since time span
+ * @return task result statistics
*/
@GET
@Path("/statistics/tasks/running")
@@ -428,9 +425,9 @@
}
/**
- * 获取作业类型统计数据.
+ * Get job type statistics.
*
- * @return 作业类型统计数据
+ * @return job type statistics
*/
@GET
@Path("/statistics/jobs/type")
@@ -440,9 +437,9 @@
}
/**
- * 获取作业执行类型统计数据.
+ * Get job execution type statistics.
*
- * @return 作业执行类型统计数据
+ * @return job execution statistics
*/
@GET
@Path("/statistics/jobs/executionType")
@@ -452,10 +449,9 @@
}
/**
- * 获取一周以来作业运行统计数据集合.
- *
- * @param since 时间跨度
- * @return 一周以来任务运行统计数据集合
+ * Find job running statistics in the recent week.
+ * @param since time span
+ * @return collection of job running statistics in the recent week
*/
@GET
@Path("/statistics/jobs/running")
@@ -469,9 +465,9 @@
}
/**
- * 获取自上线以来作业注册统计数据集合.
+ * Find job register statistics.
*
- * @return 自上线以来作业注册统计数据集合
+ * @return collection of job register statistics since online
*/
@GET
@Path("/statistics/jobs/register")
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudOperationRestfulApi.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudOperationRestfulApi.java
index 00b5fc5..433d8ab 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudOperationRestfulApi.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/CloudOperationRestfulApi.java
@@ -32,9 +32,7 @@
import javax.ws.rs.QueryParam;
/**
- * 作业云维护服务.
- *
- * @author gaohongtao.
+ * Cloud operation restful api.
*/
@Path("/operate")
@Slf4j
@@ -49,10 +47,10 @@
private static long lastReconcileTime;
/**
- * 初始化.
+ * Init.
*
- * @param regCenter 注册中心
- * @param reconcileService 协调服务
+ * @param regCenter registry center
+ * @param reconcileService reconcile service
*/
public static void init(final CoordinatorRegistryCenter regCenter, final ReconcileService reconcileService) {
CloudOperationRestfulApi.reconcileService = reconcileService;
@@ -60,8 +58,7 @@
}
/**
- * 显示协调服务.
- *
+ * Explicit reconcile service.
*/
@POST
@Path("/reconcile/explicit")
@@ -71,7 +68,7 @@
}
/**
- * 隐式协调服务.
+ * Implicit reconcile service.
*/
@POST
@Path("/reconcile/implicit")
@@ -88,11 +85,11 @@
}
/**
- * 获取作业云App的沙箱信息.
+ * Get sandbox of the cloud job by app name.
*
- * @param appName 云作业App配置名称
- * @return 沙箱信息
- * @throws JSONException JSON解析异常
+ * @param appName application name
+ * @return sandbox info
+ * @throws JSONException parse json exception
*/
@GET
@Path("/sandbox")
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/RestfulService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/RestfulService.java
index 1cd1d96..5b60531 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/RestfulService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/restful/RestfulService.java
@@ -26,9 +26,7 @@
import com.google.common.base.Optional;
/**
- * 云作业Restful服务.
- *
- * @author caohao
+ * Restful server.
*/
public final class RestfulService {
@@ -44,7 +42,7 @@
}
/**
- * 启动Restful服务.
+ * Start restful server.
*/
public void start() {
try {
@@ -59,7 +57,7 @@
}
/**
- * 停止Restful服务.
+ * Stop restful server.
*/
public void stop() {
restfulServer.stop();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/StateNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/StateNode.java
index faa177f..00f4d9f 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/StateNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/StateNode.java
@@ -21,15 +21,13 @@
import lombok.NoArgsConstructor;
/**
- * 状态根节点路径.
- *
- * @author zhangliang
+ * State node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class StateNode {
/**
- * 状态根节点.
+ * Root state node.
*/
public static final String ROOT = "/state";
}
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppNode.java
index fa4cd65..0011f10 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppNode.java
@@ -22,9 +22,7 @@
import lombok.NoArgsConstructor;
/**
- * 禁用应用队列节点路径.
- *
- * @author caohao
+ * Disable app node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
final class DisableAppNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppService.java
index 53181da..8fe4519 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/app/DisableAppService.java
@@ -22,9 +22,7 @@
import lombok.extern.slf4j.Slf4j;
/**
- * 禁用应用队列服务.
- *
- * @author caohao
+ * Disable app service.
*/
@Slf4j
public class DisableAppService {
@@ -38,9 +36,9 @@
}
/**
- * 将应用放入禁用队列.
+ * Add application name to disable queue.
*
- * @param appName 应用名称
+ * @param appName application name
*/
public void add(final String appName) {
if (regCenter.getNumChildren(DisableAppNode.ROOT) > env.getFrameworkConfiguration().getJobStateQueueSize()) {
@@ -54,19 +52,19 @@
}
/**
- * 从禁用应用队列中删除应用.
+ * Remove application name from disable queue.
*
- * @param appName 待删除的应用名称
+ * @param appName application name
*/
public void remove(final String appName) {
regCenter.remove(DisableAppNode.getDisableAppNodePath(appName));
}
/**
- * 判断应用是否在禁用应用队列中.
+ * Check whether the application name is disabled or not.
*
- * @param appName 应用名称
- * @return 应用是否被禁用
+ * @param appName application name
+ * @return true is in the disable queue, otherwise not
*/
public boolean isDisabled(final String appName) {
return regCenter.isExisted(DisableAppNode.getDisableAppNodePath(appName));
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobNode.java
index a982f03..48f4be2 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobNode.java
@@ -22,9 +22,7 @@
import lombok.NoArgsConstructor;
/**
- * 禁用作业队列节点路径.
- *
- * @author caohao
+ * Disable job node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
final class DisableJobNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobService.java
index 4267460..3a55d74 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/disable/job/DisableJobService.java
@@ -22,9 +22,7 @@
import lombok.extern.slf4j.Slf4j;
/**
- * 禁用作业队列服务.
- *
- * @author caohao
+ * Disable job service.
*/
@Slf4j
public class DisableJobService {
@@ -38,9 +36,9 @@
}
/**
- * 将作业放入禁用队列.
+ * Add job to the disable queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void add(final String jobName) {
if (regCenter.getNumChildren(DisableJobNode.ROOT) > env.getFrameworkConfiguration().getJobStateQueueSize()) {
@@ -54,19 +52,19 @@
}
/**
- * 从作业禁用队列中删除作业.
+ * Remove the job from the disable queue.
*
- * @param jobName 待删除的作业名称
+ * @param jobName job name
*/
public void remove(final String jobName) {
regCenter.remove(DisableJobNode.getDisableJobNodePath(jobName));
}
/**
- * 判断作业是否在作业禁用队列中.
+ * Determine whether the job is in the disable queue or not.
*
- * @param jobName 作业名称
- * @return 作业是否被禁用
+ * @param jobName job name
+ * @return true is in the disable queue, otherwise not
*/
public boolean isDisabled(final String jobName) {
return regCenter.isExisted(DisableJobNode.getDisableJobNodePath(jobName));
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverNode.java
index 5d87e67..12fa961 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverNode.java
@@ -23,9 +23,7 @@
import lombok.NoArgsConstructor;
/**
- * 待失效转移任务队列节点路径.
- *
- * @author zhangliang
+ * Failover node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
final class FailoverNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverService.java
index 8ff667c..d7658f3 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverService.java
@@ -42,9 +42,7 @@
import java.util.Set;
/**
- * 失效转移队列服务.
- *
- * @author zhangliang
+ * Failover service.
*/
@Slf4j
public final class FailoverService {
@@ -64,9 +62,9 @@
}
/**
- * 将任务放入失效转移队列.
+ * Add task to failover queue.
*
- * @param taskContext 任务运行时上下文
+ * @param taskContext task running context
*/
public void add(final TaskContext taskContext) {
if (regCenter.getNumChildren(FailoverNode.ROOT) > env.getFrameworkConfiguration().getJobStateQueueSize()) {
@@ -75,15 +73,15 @@
}
String failoverTaskNodePath = FailoverNode.getFailoverTaskNodePath(taskContext.getMetaInfo().toString());
if (!regCenter.isExisted(failoverTaskNodePath) && !runningService.isTaskRunning(taskContext.getMetaInfo())) {
- // TODO Daemon类型作业增加存储是否立即失效转移
+ // TODO Whether Daemon-type jobs increase storage and fail immediately?
regCenter.persist(failoverTaskNodePath, taskContext.getId());
}
}
/**
- * 从失效转移队列中获取所有有资格执行的作业上下文.
+ * Get all eligible job contexts from failover queue.
*
- * @return 有资格执行的作业上下文集合
+ * @return collection of the eligible job contexts
*/
public Collection<JobContext> getAllEligibleJobContexts() {
if (!regCenter.isExisted(FailoverNode.ROOT)) {
@@ -123,9 +121,9 @@
}
/**
- * 从失效转移队列中删除相关任务.
+ * Remove task from the failover queue.
*
- * @param metaInfoList 待删除的任务元信息集合
+ * @param metaInfoList collection of task meta infos to be removed
*/
public void remove(final Collection<TaskContext.MetaInfo> metaInfoList) {
for (TaskContext.MetaInfo each : metaInfoList) {
@@ -134,10 +132,10 @@
}
/**
- * 从失效转移队列中查找任务.
+ * Get task id from failover queue.
*
- * @param metaInfo 任务元信息
- * @return 失效转移任务Id
+ * @param metaInfo task meta info
+ * @return failover task id
*/
public Optional<String> getTaskId(final TaskContext.MetaInfo metaInfo) {
String failoverTaskNodePath = FailoverNode.getFailoverTaskNodePath(metaInfo.toString());
@@ -149,9 +147,9 @@
}
/**
- * 获取待失效转移的全部任务.
+ * Get all failover tasks.
*
- * @return 待失效转移的全部任务
+ * @return all failover tasks
*/
public Map<String, Collection<FailoverTaskInfo>> getAllFailoverTasks() {
if (!regCenter.isExisted(FailoverNode.ROOT)) {
@@ -169,10 +167,10 @@
}
/**
- * 获取待失效转移的任务集合.
+ * Get failover tasks.
*
- * @param jobName 作业名称
- * @return 待失效转移的任务集合
+ * @param jobName job name
+ * @return collection of failover tasks
*/
private Collection<FailoverTaskInfo> getFailoverTasks(final String jobName) {
List<String> failOverTasks = regCenter.getChildrenKeys(FailoverNode.getFailoverJobNodePath(jobName));
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverTaskInfo.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverTaskInfo.java
index 2f4f0b0..c5d0794 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverTaskInfo.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/failover/FailoverTaskInfo.java
@@ -22,9 +22,7 @@
import lombok.RequiredArgsConstructor;
/**
- * 待失效转移任务节点信息.
- *
- * @author liguangyun
+ * Failover task info.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyNode.java
index d6c6221..24a67f5 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyNode.java
@@ -22,9 +22,7 @@
import lombok.NoArgsConstructor;
/**
- * 待运行作业队列节点路径.
- *
- * @author zhangliang
+ * Ready node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
final class ReadyNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyService.java
index ba10f7d..89e1409 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/ready/ReadyService.java
@@ -39,10 +39,7 @@
import java.util.Map;
/**
- * 待运行作业队列服务.
- *
- * @author zhangliang
- * @author liguangyun
+ * Ready service.
*/
@Slf4j
public final class ReadyService {
@@ -62,9 +59,9 @@
}
/**
- * 将瞬时作业放入待执行队列.
+ * Add transient job to ready queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void addTransient(final String jobName) {
if (regCenter.getNumChildren(ReadyNode.ROOT) > env.getFrameworkConfiguration().getJobStateQueueSize()) {
@@ -85,9 +82,9 @@
}
/**
- * 将常驻作业放入待执行队列.
+ * Add daemon job to ready queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void addDaemon(final String jobName) {
if (regCenter.getNumChildren(ReadyNode.ROOT) > env.getFrameworkConfiguration().getJobStateQueueSize()) {
@@ -102,9 +99,9 @@
}
/**
- * 设置禁用错过重执行.
+ * Set misfire disabled.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void setMisfireDisabled(final String jobName) {
Optional<CloudJobConfiguration> cloudJobConfig = configService.load(jobName);
@@ -114,10 +111,10 @@
}
/**
- * 从待执行队列中获取所有有资格执行的作业上下文.
+ * Get all the eligible job contexts from ready queue.
*
- * @param ineligibleJobContexts 无资格执行的作业上下文
- * @return 有资格执行的作业上下文集合
+ * @param ineligibleJobContexts ineligible job contexts
+ * @return collection of eligible contexts
*/
public Collection<JobContext> getAllEligibleJobContexts(final Collection<JobContext> ineligibleJobContexts) {
if (!regCenter.isExisted(ReadyNode.ROOT)) {
@@ -149,9 +146,9 @@
}
/**
- * 从待执行队列中删除相关作业.
+ * Remove jobs from ready queue.
*
- * @param jobNames 待删除的作业名集合
+ * @param jobNames collection of jobs to be removed
*/
public void remove(final Collection<String> jobNames) {
for (String each : jobNames) {
@@ -167,9 +164,9 @@
}
/**
- * 获取待运行的全部任务.
+ * Get all ready tasks.
*
- * @return 待运行的全部任务
+ * @return all ready tasks
*/
public Map<String, Integer> getAllReadyTasks() {
if (!regCenter.isExisted(ReadyNode.ROOT)) {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningNode.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningNode.java
index 7f85aa7..2ad6350 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningNode.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningNode.java
@@ -23,9 +23,7 @@
import lombok.NoArgsConstructor;
/**
- * 运行中任务节点路径.
- *
- * @author zhangliang
+ * Running node.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
final class RunningNode {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningService.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningService.java
index 01b9515..5de4b6a 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningService.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/state/running/RunningService.java
@@ -40,16 +40,14 @@
import java.util.concurrent.CopyOnWriteArraySet;
/**
- * 任务运行时服务.
- *
- * @author zhangliang
+ * Running service.
*/
@RequiredArgsConstructor
public final class RunningService {
private static final int TASK_INITIAL_SIZE = 1024;
- // TODO 使用JMX导出
+ // TODO Using JMX to export
@Getter
private static final ConcurrentHashMap<String, Set<TaskContext>> RUNNING_TASKS = new ConcurrentHashMap<>(TASK_INITIAL_SIZE);
@@ -65,7 +63,7 @@
}
/**
- * 启动任务运行队列.
+ * Start running queue service.
*/
public void start() {
clear();
@@ -86,9 +84,9 @@
}
/**
- * 将任务运行时上下文放入运行时队列.
+ * Add task to running queue.
*
- * @param taskContext 任务运行时上下文
+ * @param taskContext task running context
*/
public void add(final TaskContext taskContext) {
if (!configurationService.load(taskContext.getMetaInfo().getJobName()).isPresent()) {
@@ -110,9 +108,10 @@
}
/**
- * 更新作业闲置状态.
- * @param taskContext 任务运行时上下文
- * @param isIdle 是否闲置
+ * Update task to idle state.
+ *
+ * @param taskContext task running context
+ * @param isIdle is idle
*/
public void updateIdle(final TaskContext taskContext, final boolean isIdle) {
synchronized (RUNNING_TASKS) {
@@ -135,9 +134,9 @@
}
/**
- * 将作业从运行时队列删除.
+ * Remove job from running queue.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public void remove(final String jobName) {
RUNNING_TASKS.remove(jobName);
@@ -148,9 +147,9 @@
}
/**
- * 将任务从运行时队列删除.
- *
- * @param taskContext 任务运行时上下文
+ * Remove task from running queue.
+ *
+ * @param taskContext task running context
*/
public void remove(final TaskContext taskContext) {
getRunningTasks(taskContext.getMetaInfo().getJobName()).remove(taskContext);
@@ -170,20 +169,20 @@
}
/**
- * 判断作业是否运行.
+ * Determine whether the job is running or not.
*
- * @param jobName 作业名称
- * @return 作业是否运行
+ * @param jobName job name
+ * @return true is running, otherwise not
*/
public boolean isJobRunning(final String jobName) {
return !getRunningTasks(jobName).isEmpty();
}
/**
- * 判断任务是否运行.
+ * Determine whether the task is running or not.
*
- * @param metaInfo 任务元信息
- * @return 任务是否运行
+ * @param metaInfo task meta info
+ * @return true is running, otherwise not
*/
public boolean isTaskRunning(final TaskContext.MetaInfo metaInfo) {
for (TaskContext each : getRunningTasks(metaInfo.getJobName())) {
@@ -195,10 +194,10 @@
}
/**
- * 获取运行中的任务集合.
+ * Get running tasks by job name.
*
- * @param jobName 作业名称
- * @return 运行中的任务集合
+ * @param jobName job name
+ * @return collection of the running tasks
*/
public Collection<TaskContext> getRunningTasks(final String jobName) {
Set<TaskContext> taskContexts = new CopyOnWriteArraySet<>();
@@ -207,9 +206,9 @@
}
/**
- * 获取运行中的全部任务.
+ * Get all running tasks.
*
- * @return 运行中的全部任务
+ * @return collection of all the running tasks
*/
public Map<String, Set<TaskContext>> getAllRunningTasks() {
Map<String, Set<TaskContext>> result = new HashMap<>(RUNNING_TASKS.size(), 1);
@@ -218,9 +217,9 @@
}
/**
- * 获取所有的运行中的常驻作业.
- *
- * @return 运行中常驻作业集合
+ * Get all running daemon tasks.
+ *
+ * @return collection of all the running daemon tasks
*/
public Set<TaskContext> getAllRunningDaemonTasks() {
List<String> jobKeys = regCenter.getChildrenKeys(RunningNode.ROOT);
@@ -239,27 +238,27 @@
}
/**
- * 添加任务主键和主机名称的映射.
+ * Add mapping of task primary key and hostname.
*
- * @param taskId 任务主键
- * @param hostname 主机名称
+ * @param taskId task primary key
+ * @param hostname host name
*/
public void addMapping(final String taskId, final String hostname) {
TASK_HOSTNAME_MAPPER.putIfAbsent(taskId, hostname);
}
/**
- * 根据任务主键获取主机名称并清除该任务.
+ * Retrieve the hostname and then remove this task from the mapping.
*
- * @param taskId 任务主键
- * @return 删除任务的主机名称
+ * @param taskId task primary key
+ * @return the host name of the removed task
*/
public String popMapping(final String taskId) {
return TASK_HOSTNAME_MAPPER.remove(taskId);
}
/**
- * 清理所有运行时状态.
+ * Clear the running status.
*/
public void clear() {
RUNNING_TASKS.clear();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticManager.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticManager.java
index 71dac38..5b555af 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticManager.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticManager.java
@@ -50,9 +50,7 @@
import java.util.Map;
/**
- * 统计作业调度管理器.
- *
- * @author liguangyun
+ * Statistic manager.
*/
@Slf4j
@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@@ -82,11 +80,11 @@
}
/**
- * 获取统计作业调度管理器.
+ * Get statistic manager.
*
- * @param regCenter 注册中心
- * @param jobEventRdbConfiguration 作业数据库事件配置
- * @return 调度管理器对象
+ * @param regCenter registry center
+ * @param jobEventRdbConfiguration rdb configuration
+ * @return statistic manager
*/
public static StatisticManager getInstance(final CoordinatorRegistryCenter regCenter, final Optional<JobEventRdbConfiguration> jobEventRdbConfiguration) {
if (null == instance) {
@@ -115,7 +113,7 @@
}
/**
- * 启动统计作业调度.
+ * Startup.
*/
public void startup() {
if (null != rdbRepository) {
@@ -129,14 +127,14 @@
}
/**
- * 停止统计作业调度.
+ * Shutdown.
*/
public void shutdown() {
scheduler.shutdown();
}
/**
- * 任务运行成功.
+ * Run task successfully.
*/
public void taskRunSuccessfully() {
statisticData.get(StatisticInterval.MINUTE).incrementAndGetSuccessCount();
@@ -145,7 +143,7 @@
}
/**
- * 作业运行失败.
+ * Run task failed.
*/
public void taskRunFailed() {
statisticData.get(StatisticInterval.MINUTE).incrementAndGetFailedCount();
@@ -158,9 +156,8 @@
}
/**
- * 获取最近一周的任务运行结果统计数据.
- *
- * @return 任务运行结果统计数据对象
+ * Get statistic of the recent week.
+ * @return task result statistic
*/
public TaskResultStatistics getTaskResultStatisticsWeekly() {
if (!isRdbConfigured()) {
@@ -170,9 +167,9 @@
}
/**
- * 获取自上线以来的任务运行结果统计数据.
+ * Get statistic since online.
*
- * @return 任务运行结果统计数据对象
+ * @return task result statistic
*/
public TaskResultStatistics getTaskResultStatisticsSinceOnline() {
if (!isRdbConfigured()) {
@@ -182,10 +179,9 @@
}
/**
- * 获取最近一个统计周期的任务运行结果统计数据.
- *
- * @param statisticInterval 统计周期
- * @return 任务运行结果统计数据对象
+ * Get the latest statistic of the specified interval.
+ * @param statisticInterval statistic interval
+ * @return task result statistic
*/
public TaskResultStatistics findLatestTaskResultStatistics(final StatisticInterval statisticInterval) {
if (isRdbConfigured()) {
@@ -198,9 +194,9 @@
}
/**
- * 获取最近一天的任务运行结果统计数据集合.
+ * Get statistic of the recent day.
*
- * @return 任务运行结果统计数据对象集合
+ * @return task result statistic
*/
public List<TaskResultStatistics> findTaskResultStatisticsDaily() {
if (!isRdbConfigured()) {
@@ -210,9 +206,9 @@
}
/**
- * 获取作业类型统计数据.
+ * Get job type statistics.
*
- * @return 作业类型统计数据对象
+ * @return job type statistics
*/
public JobTypeStatistics getJobTypeStatistics() {
int scriptJobCnt = 0;
@@ -231,9 +227,9 @@
}
/**
- * 获取作业执行类型统计数据.
+ * Get job execution type statistics.
*
- * @return 作业执行类型统计数据对象
+ * @return Job execution type statistics data object
*/
public JobExecutionTypeStatistics getJobExecutionTypeStatistics() {
int transientJobCnt = 0;
@@ -249,9 +245,9 @@
}
/**
- * 获取最近一周的运行中的任务统计数据集合.
+ * Get the collection of task statistics in the most recent week.
*
- * @return 运行中的任务统计数据对象集合
+ * @return Collection of running task statistics data objects
*/
public List<TaskRunningStatistics> findTaskRunningStatisticsWeekly() {
if (!isRdbConfigured()) {
@@ -261,9 +257,9 @@
}
/**
- * 获取最近一周的运行中的作业统计数据集合.
+ * Get the collection of job statistics in the most recent week.
*
- * @return 运行中的任务统计数据对象集合
+ * @return collection of running task statistics data objects
*/
public List<JobRunningStatistics> findJobRunningStatisticsWeekly() {
if (!isRdbConfigured()) {
@@ -273,9 +269,9 @@
}
/**
- * 获取自上线以来的运行中的任务统计数据集合.
+ * Get running task statistics data collection since online.
*
- * @return 运行中的任务统计数据对象集合
+ * @return collection of running task statistics data objects
*/
public List<JobRegisterStatistics> findJobRegisterStatisticsSinceOnline() {
if (!isRdbConfigured()) {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticsScheduler.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticsScheduler.java
index 0800302..86e685d 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticsScheduler.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/StatisticsScheduler.java
@@ -29,19 +29,14 @@
import java.util.Properties;
/**
- * 统计作业调度器.
- *
- * @author liguangyun
+ * Statistic scheduler.
*/
final class StatisticsScheduler {
private final StdSchedulerFactory factory;
private Scheduler scheduler;
-
- /**
- * 构造函数.
- */
+
StatisticsScheduler() {
factory = new StdSchedulerFactory();
try {
@@ -62,7 +57,7 @@
}
/**
- * 启动调度器.
+ * Start.
*/
void start() {
try {
@@ -74,9 +69,9 @@
}
/**
- * 注册统计作业.
+ * Register statistic job.
*
- * @param statisticJob 统计作业
+ * @param statisticJob statistic job
*/
void register(final StatisticJob statisticJob) {
try {
@@ -89,7 +84,7 @@
}
/**
- * 停止调度.
+ * Shutdown.
*/
void shutdown() {
try {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/TaskResultMetaData.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/TaskResultMetaData.java
index a41a4f4..79c8f57 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/TaskResultMetaData.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/TaskResultMetaData.java
@@ -20,62 +20,57 @@
import java.util.concurrent.atomic.AtomicInteger;
/**
- * 统计元数据.
- *
- * @author liguangyun
+ * Task result meta data.
*/
public final class TaskResultMetaData {
private final AtomicInteger successCount;
private final AtomicInteger failedCount;
-
- /**
- * 构造函数.
- */
+
public TaskResultMetaData() {
successCount = new AtomicInteger(0);
failedCount = new AtomicInteger(0);
}
/**
- * 增加并获取成功数.
+ * Increase and get success count.
*
- * @return 成功数
+ * @return success count
*/
public int incrementAndGetSuccessCount() {
return successCount.incrementAndGet();
}
/**
- * 增加并获取失败数.
+ * Increase and get failed count.
*
- * @return 失败数
+ * @return failed count
*/
public int incrementAndGetFailedCount() {
return failedCount.incrementAndGet();
}
/**
- * 获取成功数.
+ * Get success count.
*
- * @return 成功数
+ * @return success count
*/
public int getSuccessCount() {
return successCount.get();
}
/**
- * 获取失败数.
+ * Get failed count.
*
- * @return 失败数
+ * @return failed count
*/
public int getFailedCount() {
return failedCount.get();
}
/**
- * 重置成功数、失败数.
+ * Reset success and failed count.
*/
public void reset() {
successCount.set(0);
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/AbstractStatisticJob.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/AbstractStatisticJob.java
index d11bb56..6e30d25 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/AbstractStatisticJob.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/AbstractStatisticJob.java
@@ -26,9 +26,7 @@
import org.apache.shardingsphere.elasticjob.cloud.statistics.StatisticInterval;
/**
- * 统计作业抽象类.
- *
- * @author liguangyun
+ * Statistic job.
*/
abstract class AbstractStatisticJob implements StatisticJob {
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/JobRunningStatisticJob.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/JobRunningStatisticJob.java
index e07027c..ad981b9 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/JobRunningStatisticJob.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/JobRunningStatisticJob.java
@@ -44,9 +44,7 @@
import java.util.Set;
/**
- * 运行中的任务统计作业.
- *
- * @author liguangyun
+ * Running job statistic.
*/
@Setter
@NoArgsConstructor
@@ -58,12 +56,7 @@
private RunningService runningService;
private StatisticRdbRepository repository;
-
- /**
- * 构造函数.
- * @param registryCenter 注册中心
- * @param rdbRepository 基于rdb的数据仓库对象
- */
+
public JobRunningStatisticJob(final CoordinatorRegistryCenter registryCenter, final StatisticRdbRepository rdbRepository) {
runningService = new RunningService(registryCenter);
this.repository = rdbRepository;
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/RegisteredJobStatisticJob.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/RegisteredJobStatisticJob.java
index 15748f6..f251257 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/RegisteredJobStatisticJob.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/RegisteredJobStatisticJob.java
@@ -41,9 +41,7 @@
import java.util.Map;
/**
- * 已注册作业统计作业.
- *
- * @author liguangyun
+ * Registered job statistic.
*/
@Setter
@NoArgsConstructor
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/StatisticJob.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/StatisticJob.java
index 624e979..afaa8d5 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/StatisticJob.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/StatisticJob.java
@@ -24,30 +24,28 @@
import org.quartz.Trigger;
/**
- * 统计作业.
- *
- * @author liguangyun
+ * Statistic job.
*/
public interface StatisticJob extends Job {
/**
- * 构建JobDetail.
+ * Build JobDetail.
*
- * @return JobDetail对象
+ * @return JobDetail
*/
JobDetail buildJobDetail();
/**
- * 构建Trigger.
+ * Build Trigger.
*
- * @return Trigger对象
+ * @return Trigger
*/
Trigger buildTrigger();
/**
- * 获取对象属性Map.
+ * Get data map.
*
- * @return 对象属性Map，KEY为属性名称，VALUE为属性实例
+ * @return property map, key is property name, value is property instance
*/
Map<String, Object> getDataMap();
}
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/TaskResultStatisticJob.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/TaskResultStatisticJob.java
index ebe39ba..a3fdac9 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/TaskResultStatisticJob.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/job/TaskResultStatisticJob.java
@@ -41,9 +41,7 @@
import java.util.Map;
/**
- * 任务运行结果统计作业.
- *
- * @author liguangyun
+ * Task result statistic.
*/
@Setter
@NoArgsConstructor
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/util/StatisticTimeUtils.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/util/StatisticTimeUtils.java
index 1b722b9..030eafa 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/util/StatisticTimeUtils.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/scheduler/statistics/util/StatisticTimeUtils.java
@@ -26,30 +26,27 @@
import lombok.NoArgsConstructor;
/**
- * 统计时间工具类.
- *
- * @author liguangyun
+ * Statistic time utility.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class StatisticTimeUtils {
/**
- * 获取以interval为时间间隔单位的统计时间.
- *
- * @param interval 时间间隔
- * @return 时间对象
+ * Get the statistical time with the interval unit.
+ *
+ * @param interval interval
+ * @return Date
*/
public static Date getCurrentStatisticTime(final StatisticInterval interval) {
return getStatisticTime(interval, 0);
}
/**
- * 偏移offset个时间间隔单位，获取以interval为时间间隔单位的统计时间.
- * offset为负数表示时间向过去偏移，正数表示向未来偏移.
- *
- * @param interval 时间间隔
- * @param offset 时间偏移量
- * @return 时间对象
+ * Get the statistical time with the interval unit.
+ *
+ * @param interval interval
+ * @param offset offset
+ * @return Date
*/
public static Date getStatisticTime(final StatisticInterval interval, final int offset) {
Calendar calendar = Calendar.getInstance();
diff --git a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/security/WwwAuthFilter.java b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/security/WwwAuthFilter.java
index 7882052..297e584 100644
--- a/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/security/WwwAuthFilter.java
+++ b/elastic-job-cloud-scheduler/src/main/java/org/apache/shardingsphere/elasticjob/cloud/security/WwwAuthFilter.java
@@ -35,9 +35,7 @@
import java.util.Properties;
/**
- * 认证过滤器.
- *
- * @author zhangliang
+ * WWW auth filter.
*/
@Slf4j
public final class WwwAuthFilter implements Filter {
