-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
JobParametersBuilder.java
284 lines (256 loc) · 9.92 KB
/
JobParametersBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/*
* Copyright 2006-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.batch.core;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;
import org.springframework.batch.core.explore.JobExplorer;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Helper class for creating {@link JobParameters}. Useful because all
* {@link JobParameter} objects are immutable, and must be instantiated separately
* to ensure type safety. Once created, it can be used in the
* same was a java.lang.StringBuilder (except, order is irrelevant), by adding
* various parameter types and creating a valid {@link JobParameters} once
* finished.<br>
* <br>
* Using the identifying flag indicates if the parameter will be used
* in the identification of a JobInstance. That flag defaults to true.
*
* @author Lucas Ward
* @author Michael Minella
* @author Glenn Renfro
* @author Mahmoud Ben Hassine
* @since 1.0
* @see JobParameters
* @see JobParameter
*/
public class JobParametersBuilder {
private Map<String, JobParameter> parameterMap;
private JobExplorer jobExplorer;
/**
* Default constructor. Initializes the builder with empty parameters.
*/
public JobParametersBuilder() {
this.parameterMap = new LinkedHashMap<>();
}
/**
* @param jobExplorer {@link JobExplorer} used for looking up previous job parameter information
*/
public JobParametersBuilder(JobExplorer jobExplorer) {
this.jobExplorer = jobExplorer;
this.parameterMap = new LinkedHashMap<>();
}
/**
* Copy constructor. Initializes the builder with the supplied parameters.
* @param jobParameters {@link JobParameters} instance used to initialize the builder.
*/
public JobParametersBuilder(JobParameters jobParameters) {
this(jobParameters, null);
}
/**
* Constructor to add conversion capabilities to support JSR-352. Per the spec, it is expected that all
* keys and values in the provided {@link Properties} instance are Strings
*
* @param properties the job parameters to be used
*/
public JobParametersBuilder(Properties properties) {
this.parameterMap = new LinkedHashMap<>();
if(properties != null) {
for (Map.Entry<Object, Object> curProperty : properties.entrySet()) {
this.parameterMap.put((String) curProperty.getKey(), new JobParameter((String) curProperty.getValue(), false));
}
}
}
/**
* Copy constructor. Initializes the builder with the supplied parameters.
* @param jobParameters {@link JobParameters} instance used to initialize the builder.
* @param jobExplorer {@link JobExplorer} used for looking up previous job parameter information
*/
public JobParametersBuilder(JobParameters jobParameters, JobExplorer jobExplorer) {
this.jobExplorer = jobExplorer;
this.parameterMap = new LinkedHashMap<>(jobParameters.getParameters());
}
/**
* Add a new identifying String parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @return a reference to this object.
*/
public JobParametersBuilder addString(String key, @NonNull String parameter) {
this.parameterMap.put(key, new JobParameter(parameter, true));
return this;
}
/**
* Add a new String parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @param identifying - indicates if the parameter is used as part of identifying a job instance
* @return a reference to this object.
*/
public JobParametersBuilder addString(String key, @NonNull String parameter, boolean identifying) {
this.parameterMap.put(key, new JobParameter(parameter, identifying));
return this;
}
/**
* Add a new identifying {@link Date} parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @return a reference to this object.
*/
public JobParametersBuilder addDate(String key, @NonNull Date parameter) {
this.parameterMap.put(key, new JobParameter(parameter, true));
return this;
}
/**
* Add a new {@link Date} parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @param identifying - indicates if the parameter is used as part of identifying a job instance
* @return a reference to this object.
*/
public JobParametersBuilder addDate(String key, @NonNull Date parameter, boolean identifying) {
this.parameterMap.put(key, new JobParameter(parameter, identifying));
return this;
}
/**
* Add a new identifying Long parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @return a reference to this object.
*/
public JobParametersBuilder addLong(String key, @NonNull Long parameter) {
this.parameterMap.put(key, new JobParameter(parameter, true));
return this;
}
/**
* Add a new Long parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @param identifying - indicates if the parameter is used as part of identifying a job instance
* @return a reference to this object.
*/
public JobParametersBuilder addLong(String key, @NonNull Long parameter, boolean identifying) {
this.parameterMap.put(key, new JobParameter(parameter, identifying));
return this;
}
/**
* Add a new identifying Double parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @return a reference to this object.
*/
public JobParametersBuilder addDouble(String key, @NonNull Double parameter) {
this.parameterMap.put(key, new JobParameter(parameter, true));
return this;
}
/**
* Add a new Double parameter for the given key.
*
* @param key - parameter accessor.
* @param parameter - runtime parameter. Must not be {@code null}.
* @param identifying - indicates if the parameter is used as part of identifying a job instance
* @return a reference to this object.
*/
public JobParametersBuilder addDouble(String key, @NonNull Double parameter, boolean identifying) {
this.parameterMap.put(key, new JobParameter(parameter, identifying));
return this;
}
/**
* Conversion method that takes the current state of this builder and
* returns it as a JobParameters object.
*
* @return a valid {@link JobParameters} object.
*/
public JobParameters toJobParameters() {
return new JobParameters(this.parameterMap);
}
/**
* Add a new {@link JobParameter} for the given key.
*
* @param key - parameter accessor
* @param jobParameter - runtime parameter
* @return a reference to this object.
*/
public JobParametersBuilder addParameter(String key, JobParameter jobParameter) {
Assert.notNull(jobParameter, "JobParameter must not be null");
this.parameterMap.put(key, jobParameter);
return this;
}
/**
* Copy job parameters into the current state.
* @param jobParameters parameters to copy in
* @return a reference to this object.
*/
public JobParametersBuilder addJobParameters(JobParameters jobParameters) {
Assert.notNull(jobParameters, "jobParameters must not be null");
this.parameterMap.putAll(jobParameters.getParameters());
return this;
}
/**
* Initializes the {@link JobParameters} based on the state of the {@link Job}. This
* should be called after all parameters have been entered into the builder.
* All parameters already set on this builder instance will be appended to
* those retrieved from the job incrementer, overriding any with the same key (Same
* behaviour as {@link org.springframework.batch.core.launch.support.CommandLineJobRunner}
* with "-next" option and {@link org.springframework.batch.core.launch.JobOperator#startNextInstance(String)})
*
* @param job the job for which the {@link JobParameters} are being constructed.
* @return a reference to this object.
*
* @since 4.0
*/
public JobParametersBuilder getNextJobParameters(Job job) {
Assert.state(this.jobExplorer != null, "A JobExplorer is required to get next job parameters");
Assert.notNull(job, "Job must not be null");
Assert.notNull(job.getJobParametersIncrementer(), "No job parameters incrementer found for job=" + job.getName());
String name = job.getName();
JobParameters nextParameters;
JobInstance lastInstance = this.jobExplorer.getLastJobInstance(name);
JobParametersIncrementer incrementer = job.getJobParametersIncrementer();
if (lastInstance == null) {
// Start from a completely clean sheet
nextParameters = incrementer.getNext(new JobParameters());
}
else {
JobExecution previousExecution = this.jobExplorer.getLastJobExecution(lastInstance);
if (previousExecution == null) {
// Normally this will not happen - an instance exists with no executions
nextParameters = incrementer.getNext(new JobParameters());
}
else {
nextParameters = incrementer.getNext(previousExecution.getJobParameters());
}
}
// start with parameters from the incrementer
Map<String, JobParameter> nextParametersMap = new HashMap<>(nextParameters.getParameters());
// append new parameters (overriding those with the same key)
nextParametersMap.putAll(this.parameterMap);
this.parameterMap = nextParametersMap;
return this;
}
}