[Improve] update english doc (apache#3028)

Co-authored-by: tomsun28 <[email protected]>

Author: zhangshenghang

hertzbeat-common/src/main/java/org/apache/hertzbeat/common/constants/AiTypeEnum.java

@@ -25,13 +25,12 @@
 public enum AiTypeEnum {
 
     /**
-     * 智普
+     * ZhiPu
      */
     zhiPu,
 
     /**
      * sparkDesk
-     * 科大讯飞
      */
     sparkDesk,
 

hertzbeat-common/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/RocketmqProtocol.java

@@ -52,7 +52,7 @@ public class RocketmqProtocol implements CommonRequestProtocol, Protocol {
     private String secretKey;
 
     /**
-     * jsonpath解析脚本
+     * jsonpath parsing script
      */
     private String parseScript;
 

hertzbeat-manager/src/main/java/org/apache/hertzbeat/manager/scheduler/AssignJobs.java

@@ -17,11 +17,12 @@
 
 package org.apache.hertzbeat.manager.scheduler;
 
-import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
 /**
  * List of assigned collection tasks
  */
@@ -33,17 +34,17 @@ public class AssignJobs {
      * current assign jobIds
      */
     private Set<Long> jobs;
-    
+
     /**
      * jobs to be adding
      */
     private Set<Long> addingJobs;
-    
+
     /**
      * jobs to be removed
      */
     private Set<Long> removingJobs;
-    
+
     /**
      * jobs has pinned in this collector
      */
@@ -59,15 +60,15 @@ public AssignJobs() {
     public void addAssignJob(Long jobId) {
         jobs.add(jobId);
     }
-    
+
     public void addAddingJob(Long jobId) {
         addingJobs.add(jobId);
     }
-    
+
     public void addRemovingJob(Long jobId) {
         removingJobs.add(jobId);
     }
-    
+
     public void addPinnedJob(Long jobId) {
         pinnedJobs.add(jobId);
     }
@@ -77,19 +78,19 @@ public void addAssignJobs(Set<Long> jobSet) {
             jobs.addAll(jobSet);
         }
     }
-    
+
     public void addAddingJobs(Set<Long> jobSet) {
         if (jobSet != null && !jobSet.isEmpty()) {
             addingJobs.addAll(jobSet);
         }
     }
-    
+
     public void addRemovingJobs(Set<Long> jobSet) {
         if (jobSet != null && !jobSet.isEmpty()) {
             removingJobs.addAll(jobSet);
         }
     }
-    
+
     public void addPinnedJobs(Set<Long> jobSet) {
         if (jobSet != null && !jobSet.isEmpty()) {
             pinnedJobs.addAll(jobSet);
@@ -102,14 +103,14 @@ public void removeAssignJobs(Set<Long> jobIds) {
         }
         jobs.removeAll(jobIds);
     }
-    
+
     public void removeAddingJobs(Set<Long> jobIds) {
         if (addingJobs == null || jobIds == null || jobIds.isEmpty()) {
             return;
         }
         addingJobs.removeAll(jobIds);
     }
-    
+
     public void clearRemovingJobs() {
         if (removingJobs == null) {
             return;
@@ -118,31 +119,32 @@ public void clearRemovingJobs() {
     }
 
     /**
-     * 判断是否存在对应的jobId
+     * Check if the corresponding jobId exists
+     *
      * @param jobId jobId
-     * @return 若存在返回true,并把jobId从assignJobs remove掉
+     * @return true if exists and removes the jobId from assignJobs
      */
     public boolean containAndRemoveJob(Long jobId) {
         if (jobs.isEmpty()) {
             return false;
         }
         return jobs.remove(jobId);
     }
-    
+
     public void removeAddingJob(Long jobId) {
         if (addingJobs == null || jobId == null) {
             return;
         }
         addingJobs.remove(jobId);
     }
-    
+
     public void removeRemovingJob(Long jobId) {
         if (removingJobs == null || jobId == null) {
             return;
         }
         removingJobs.remove(jobId);
     }
-    
+
     public void removePinnedJob(Long jobId) {
         if (pinnedJobs == null || jobId == null) {
             return;
@@ -151,7 +153,7 @@ public void removePinnedJob(Long jobId) {
     }
 
     /**
-     * 清理数据
+     * Clean data
      */
     public void clear() {
         if (!jobs.isEmpty()) {

template-marketplace/hertzbeat-template-hub/src/main/java/org/apache/hertzbeat/templatehub/controller/AccountController.java

@@ -115,7 +115,7 @@ public ResponseEntity<Message<Map<String,String>>> issueCustomToken(@RequestBody
     @PostMapping("/register")
     @Transactional
     public ResponseEntity<Message<String>> accountRegister(@RequestBody @Validated SignUpDto account) {
-        //此处先让前端传递明文密码，后续改为加密密码
+        // TODO Let the front-end pass the plaintext password here first, and then change it to an encrypted password later
 
         if (accountService.registerAccount(account)) {
             Long authUser = roleService.getRoleIdByCode("role_user");

template-marketplace/hertzbeat-template-hub/src/main/java/org/apache/hertzbeat/templatehub/sureness/SurenessFilterExample.java

@@ -70,38 +70,38 @@ public void doFilter(ServletRequest servletRequest, ServletResponse servletRespo
             response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, Authorization, authorization,x-requested-with, *");
 
             try {
-                //获取过滤器链中的filters属性
+                // Retrieve the filters attribute from the filter chain
                 Field filtersField = filterChain.getClass().getDeclaredField("filters");
-                //反射设置属性可达
+                // Reflection setting attribute reachable
                 filtersField.setAccessible(true);
-                //获取filters属性值
+                // Get the value of the filters attribute
                 FilterConfig[] filters = (FilterConfig[]) filtersField.get(filterChain);
-                //跳过过滤器个数记录
+                // Skip the record of the number of filters
                 int k = 0;
-                //遍历所有过滤器
+                // Traverse all filters
                 for (int i = 0; i < filters.length; i++) {
                     if (filters[i] != null) {
-                        //获取过滤器filterDef属性
+                        // Get the filterDef attribute of the filter
                         Field filterDefField = filters[i].getClass().getDeclaredField("filterDef");
                         filterDefField.setAccessible(true);
-                        //获取filter的class
+                        // Get the class of the filter
                         Field filterClassField = filterDefField.get(filters[i]).getClass().getDeclaredField("filterClass");
                         filterClassField.setAccessible(true);
                         String filterClass = (String) filterClassField.get(filterDefField.get(filters[i]));
                         String FILTER_REFERENCE1 = "com.usthe.sureness.configuration.SurenessJakartaServletFilter";
                         String FILTER_REFERENCE2 = "org.apache.tomcat.websocket.server.WsFilter";
-                        //跳过指定过滤器处理
+                        // Skip specified filter processing
                         if (FILTER_REFERENCE1.equals(filterClass)||FILTER_REFERENCE2.equals(filterClass)) {
                             filters[i] = null;
                             k++;
                             break;
                         }
-                        //属性可达关闭
+                        // Attribute can be disabled
                         filterClassField.setAccessible(false);
                         filterDefField.setAccessible(false);
                     }
                 }
-                //过滤器数组重新赋值，调整移除指定过滤器后过滤器数组
+                // Re assign the filter array and adjust it after removing the specified filter
                 int index = 0;
                 for (int i = 0; i < filters.length; i++) {
                     if (index == 0 && filters[i] == null) {
@@ -113,7 +113,7 @@ public void doFilter(ServletRequest servletRequest, ServletResponse servletRespo
                         index = 0;
                     }
                 }
-                //n值重新赋值
+                // Reassignment of n value
                 filtersField.setAccessible(false);
                 Field n = filterChain.getClass().getDeclaredField("n");
                 n.setAccessible(true);

template-marketplace/hertzbeat-template-hub/src/main/java/org/apache/hertzbeat/templatehub/sureness/provider/DatabasePathTreeProvider.java

@@ -39,15 +39,15 @@ public class DatabasePathTreeProvider implements PathTreeProvider {
 
     @Override
     public Set<String> providePathData() {
-        // 从数据库中读取出path信息，取出所有状态为1，即正常的path信息
+        // Read path information from the database and retrieve all path information with a status of 1, which is normal
         Set<String> pathSet = SurenessCommonUtil.attachContextPath(getContextPath(), resourceService.getAllEnableResourcePath());
         return pathSet;
 
     }
 
     @Override
     public Set<String> provideExcludedResource() {
-        // 从数据库中读取出path信息，取出所有状态为9，即禁用的path信息
+        // Read path information from the database and retrieve all path information with a status of 9, which is disabled
         Set<String> exlResourceSet = SurenessCommonUtil.attachContextPath(getContextPath(), resourceService.getAllDisableResourcePath());
         return exlResourceSet;
     }