Skip to content

Commit 341481f

Browse files
committed
Support building and using ElasticJob with JDK23
1 parent b03ad56 commit 341481f

File tree

6 files changed

+67
-64
lines changed

6 files changed

+67
-64
lines changed

.github/workflows/maven.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
if: github.repository == 'apache/shardingsphere-elasticjob'
3030
strategy:
3131
matrix:
32-
java: [ 8, 17, 21, 22 ]
32+
java: [ 8, 17, 21, 23 ]
3333
os: [ 'windows-latest', 'macos-latest', 'ubuntu-latest' ]
3434
runs-on: ${{ matrix.os }}
3535
steps:

docs/content/user-manual/usage/operation-api/_index.cn.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
2222

2323
### 获取作业配置
2424

25-
方法签名:YamlJobConfiguration getJobConfiguration(String jobName)
25+
方法签名:`JobConfigurationPOJO getJobConfiguration(String jobName)`
2626

2727
* **Parameters:**
2828
* jobName — 作业名称
@@ -31,14 +31,14 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
3131

3232
### 更新作业配置
3333

34-
方法签名:void updateJobConfiguration(YamlJobConfiguration yamlJobConfiguration)
34+
方法签名:`void updateJobConfiguration(JobConfigurationPOJO jobConfig)`
3535

3636
* **Parameters:**
37-
* jobConfiguration — 作业配置对象
37+
* jobConfig — 作业配置对象
3838

3939
### 删除作业设置
4040

41-
方法签名:void removeJobConfiguration(String jobName)
41+
方法签名:`void removeJobConfiguration(String jobName)`
4242

4343
* **Parameters:**
4444
* jobName — 作业名称
@@ -51,7 +51,7 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
5151

5252
作业在不与当前运行中作业冲突的情况下才会触发执行,并在启动后自动清理此标记。
5353

54-
方法签名:void trigger(Optional<String> jobName)
54+
方法签名:`void trigger(String jobName)`
5555

5656
* **Parameters:**
5757
* jobName — 作业名称
@@ -60,39 +60,39 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
6060

6161
禁用作业将会导致分布式的其他作业触发重新分片。
6262

63-
方法签名:void disable(Optional<String> jobName, Optional<String> serverIp)
63+
方法签名:`void disable(String jobName, String serverIp)`
6464

6565
* **Parameters:**
6666
* jobName — 作业名称
6767
* serverIp — 作业服务器 IP 地址
6868

6969
### 启用作业
7070

71-
方法签名:void enable(Optional<String> jobName, Optional<String> serverIp)
71+
方法签名:`void enable(String jobName, String serverIp)`
7272

7373
* **Parameters:**
7474
* jobName — 作业名称
7575
* serverIp — 作业服务器 IP 地址
7676

7777
### 停止调度作业
7878

79-
方法签名:void shutdown(Optional<String> jobName, Optional<String> serverIp)
79+
方法签名:`void shutdown(String jobName, String serverIp)`
8080

8181
* **Parameters:**
8282
* jobName — 作业名称
8383
* serverIp — 作业服务器IP地址
8484

8585
### 删除作业
8686

87-
方法签名:void remove(Optional<String> jobName, Optional<String> serverIp)
87+
方法签名:`void remove(String jobName, String serverIp)`
8888

8989
* **Parameters:**
9090
* jobName — 作业名称
9191
* serverIp — 作业服务器IP地址
9292

9393
### Dump 作业
9494

95-
方法签名:String dump(String jobName, String instanceIp, int dumpPort)
95+
方法签名:`String dump(String jobName, String instanceIp, int dumpPort) throws IOException`
9696

9797
* **Parameters:**
9898
* jobName — 作业名称
@@ -105,15 +105,15 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
105105

106106
### 禁用作业分片
107107

108-
方法签名:void disable(String jobName, String item)
108+
方法签名:`void disable(String jobName, String item)`
109109

110110
* **Parameters:**
111111
* jobName — 作业名称
112112
* item — 作业分片项
113113

114114
### 启用作业分片
115115

116-
方法签名:void enable(String jobName, String item)
116+
方法签名:`void enable(String jobName, String item)`
117117

118118
* **Parameters:**
119119
* jobName — 作业名称
@@ -125,13 +125,13 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
125125

126126
### 获取作业总数
127127

128-
方法签名:int getJobsTotalCount()
128+
方法签名:`int getJobsTotalCount()`
129129

130130
* **Returns:** 作业总数
131131

132132
### 获取作业简明信息
133133

134-
方法签名:JobBriefInfo getJobBriefInfo(String jobName)
134+
方法签名:`JobBriefInfo getJobBriefInfo(String jobName)`
135135

136136
* **Parameters:**
137137
* jobName — 作业名称
@@ -140,13 +140,13 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
140140

141141
### 获取所有作业简明信息
142142

143-
方法签名:Collection<JobBriefInfo> getAllJobsBriefInfo()
143+
方法签名:`Collection<JobBriefInfo> getAllJobsBriefInfo()`
144144

145145
* **Returns:** 作业简明信息集合
146146

147147
### 获取该 IP 下所有作业简明信息
148148

149-
方法签名:Collection<JobBriefInfo> getJobsBriefInfo(String ip)
149+
方法签名:`Collection<JobBriefInfo> getJobsBriefInfo(String ip)`
150150

151151
* **Parameters:**
152152
* ip — 服务器 IP
@@ -159,13 +159,13 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
159159

160160
### 获取作业服务器总数
161161

162-
方法签名:int getServersTotalCount()
162+
方法签名:`int getServersTotalCount()`
163163

164164
* **Returns:** 作业服务器总数
165165

166166
### 获取所有作业服务器简明信息
167167

168-
方法签名:Collection<ServerBriefInfo> getAllServersBriefInfo()
168+
方法签名:`Collection<ServerBriefInfo> getAllServersBriefInfo()`
169169

170170
* **Returns:** 作业服务器简明信息集合
171171

@@ -175,7 +175,7 @@ ElasticJob 提供了 Java API,可以通过直接对注册中心进行操作的
175175

176176
### 获取作业分片信息集合
177177

178-
方法签名:Collection<ShardingInfo> getShardingInfo(String jobName)
178+
方法签名:`Collection<ShardingInfo> getShardingInfo(String jobName)`
179179

180180
* **Parameters:**
181181
* jobName — 作业名称

docs/content/user-manual/usage/operation-api/_index.en.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Class name: `org.apache.shardingsphere.elasticjob.lifecycle.api.JobConfiguration
2222

2323
### Get job configuration
2424

25-
Method signature:YamlJobConfiguration getJobConfiguration(String jobName)
25+
Method signature:`JobConfigurationPOJO getJobConfiguration(String jobName)`
2626

2727
* **Parameters:**
2828
* jobName — Job name
@@ -31,14 +31,14 @@ Method signature:YamlJobConfiguration getJobConfiguration(String jobName)
3131

3232
### Update job configuration
3333

34-
Method signature:void updateJobConfiguration(YamlJobConfiguration yamlJobConfiguration)
34+
Method signature:`void updateJobConfiguration(JobConfigurationPOJO jobConfig)`
3535

3636
* **Parameters:**
37-
* jobConfiguration — Job configuration object
37+
* jobConfig — Job configuration object
3838

3939
### Remove job configuration
4040

41-
Method signature:void removeJobConfiguration(String jobName)
41+
Method signature:`void removeJobConfiguration(String jobName)`
4242

4343
* **Parameters:**
4444
* jobName — Job name
@@ -51,7 +51,7 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.JobOperateAPI`
5151

5252
The job will only trigger execution if it does not conflict with the currently running job, and this flag will be automatically cleared after it is started.
5353

54-
Method signature:void trigger(Optional<String> jobName)
54+
Method signature:`void trigger(String jobName)`
5555

5656
* **Parameters:**
5757
* jobName — Job name
@@ -60,39 +60,39 @@ Method signature:void trigger(Optional<String> jobName)
6060

6161
Disabling a job will cause other distributed jobs to trigger resharding.
6262

63-
Method signature:void disable(Optional<String> jobName, Optional<String> serverIp)
63+
Method signature:`void disable(String jobName, String serverIp)`
6464

6565
* **Parameters:**
6666
* jobName — Job name
6767
* serverIp — job server IP address
6868

6969
### Enable job
7070

71-
Method signature:void enable(Optional<String> jobName, Optional<String> serverIp)
71+
Method signature:`void enable(String jobName, String serverIp)`
7272

7373
* **Parameters:**
7474
* jobName — Job name
7575
* serverIp — job server IP address
7676

7777
### Shutdown scheduling job
7878

79-
Method signature:void shutdown(Optional<String> jobName, Optional<String> serverIp)
79+
Method signature:`void shutdown(String jobName, String serverIp)`
8080

8181
* **Parameters:**
8282
* jobName — Job name
8383
* serverIp — IP address of the job server
8484

8585
### Remove job
8686

87-
Method signature:void remove(Optional<String> jobName, Optional<String> serverIp)
87+
Method signature:`void remove(String jobName, String serverIp)`
8888

8989
* **Parameters:**
9090
* jobName — Job name
9191
* serverIp — IP address of the job server
9292

9393
### Dump job
9494

95-
Method signature:String dump(String jobName, String instanceIp, int dumpPort)
95+
Method signature:`String dump(String jobName, String instanceIp, int dumpPort) throws IOException`
9696

9797
* **Parameters:**
9898
* jobName — Job name
@@ -105,15 +105,15 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ShardingOperate
105105

106106
### Disable job sharding
107107

108-
Method signature:void disable(String jobName, String item)
108+
Method signature:`void disable(String jobName, String item)`
109109

110110
* **Parameters:**
111111
* jobName — Job name
112112
* item — Job sharding item
113113

114114
### Enable job sharding
115115

116-
Method signature:void enable(String jobName, String item)
116+
Method signature:`void enable(String jobName, String item)`
117117

118118
* **Parameters:**
119119
* jobName — Job name
@@ -125,13 +125,13 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.JobStatisticsAP
125125

126126
### Get the total count of jobs
127127

128-
Method signature:int getJobsTotalCount()
128+
Method signature:`int getJobsTotalCount()`
129129

130130
* **Returns:** the total count of jobs
131131

132132
### Get brief job information
133133

134-
Method signature:JobBriefInfo getJobBriefInfo(String jobName)
134+
Method signature:`JobBriefInfo getJobBriefInfo(String jobName)`
135135

136136
* **Parameters:**
137137
* jobName — Job name
@@ -140,13 +140,13 @@ Method signature:JobBriefInfo getJobBriefInfo(String jobName)
140140

141141
### Get brief information about all jobs.
142142

143-
Method signature:Collection<JobBriefInfo> getAllJobsBriefInfo()
143+
Method signature:`Collection<JobBriefInfo> getAllJobsBriefInfo()`
144144

145145
* **Returns:** Brief collection of all job information
146146

147147
### Get brief information of all jobs under this IP
148148

149-
Method signature:Collection<JobBriefInfo> getJobsBriefInfo(String ip)
149+
Method signature:`Collection<JobBriefInfo> getJobsBriefInfo(String ip)`
150150

151151
* **Parameters:**
152152
* ip — server IP
@@ -159,13 +159,13 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ServerStatistic
159159

160160
### Total count of job servers
161161

162-
Method signature:int getServersTotalCount()
162+
Method signature:`int getServersTotalCount()`
163163

164164
* **Returns:** Get the total count of job servers
165165

166166
### Get brief information about all job servers
167167

168-
Method signature:Collection<ServerBriefInfo> getAllServersBriefInfo()
168+
Method signature:`Collection<ServerBriefInfo> getAllServersBriefInfo()`
169169

170170
* **Returns:** Brief collection of job information
171171

@@ -175,7 +175,7 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ShardingStatist
175175

176176
### Get job sharding information collection
177177

178-
Method signature:Collection<ShardingInfo> getShardingInfo(String jobName)
178+
Method signature:`Collection<ShardingInfo> getShardingInfo(String jobName)`
179179

180180
* **Parameters:**
181181
* jobName — Job name

examples/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
<hikari-cp.version>4.0.3</hikari-cp.version>
5252

53-
<maven-compiler-plugin.version>3.3</maven-compiler-plugin.version>
53+
<maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
5454
<flatten-maven-plugin.version>1.2.5</flatten-maven-plugin.version>
5555
</properties>
5656

pom.xml

+9-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
<quartz.version>2.3.2</quartz.version>
7070

7171
<zookeeper.version>3.9.2</zookeeper.version>
72-
<curator.version>5.7.0</curator.version>
72+
<curator.version>5.7.1</curator.version>
7373

7474
<mail.version>1.6.0</mail.version>
7575
<commons-codec.version>1.16.0</commons-codec.version>
@@ -97,7 +97,7 @@
9797

9898
<!-- Compile plugin versions -->
9999
<maven-enforcer-plugin.version>3.2.1</maven-enforcer-plugin.version>
100-
<maven-compiler-plugin.version>3.11.0</maven-compiler-plugin.version>
100+
<maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
101101
<maven-resources-plugin.version>3.3.1</maven-resources-plugin.version>
102102
<maven-surefire-plugin.version>3.1.2</maven-surefire-plugin.version>
103103
<maven-jar-plugin.version>3.3.0</maven-jar-plugin.version>
@@ -433,6 +433,13 @@
433433
<target>${java.version}</target>
434434
<testSource>${java.version}</testSource>
435435
<testTarget>${java.version}</testTarget>
436+
<annotationProcessorPaths>
437+
<path>
438+
<groupId>org.projectlombok</groupId>
439+
<artifactId>lombok</artifactId>
440+
<version>${lombok.version}</version>
441+
</path>
442+
</annotationProcessorPaths>
436443
</configuration>
437444
</plugin>
438445
<plugin>

0 commit comments

Comments
 (0)