/
ExternalTaskClientBuilderImpl.java
394 lines (319 loc) · 12.3 KB
/
ExternalTaskClientBuilderImpl.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
/* 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
*
* http://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.camunda.bpm.client.impl;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;
import java.util.UUID;
import org.camunda.bpm.client.ExternalTaskClient;
import org.camunda.bpm.client.ExternalTaskClientBuilder;
import org.camunda.bpm.client.backoff.BackoffStrategy;
import org.camunda.bpm.client.backoff.ExponentialBackoffStrategy;
import org.camunda.bpm.client.interceptor.ClientRequestInterceptor;
import org.camunda.bpm.client.interceptor.impl.RequestInterceptorHandler;
import org.camunda.bpm.client.spi.DataFormat;
import org.camunda.bpm.client.spi.DataFormatConfigurator;
import org.camunda.bpm.client.spi.DataFormatProvider;
import org.camunda.bpm.client.topic.impl.TopicSubscriptionManager;
import org.camunda.bpm.client.variable.impl.DefaultValueMappers;
import org.camunda.bpm.client.variable.impl.TypedValues;
import org.camunda.bpm.client.variable.impl.ValueMappers;
import org.camunda.bpm.client.variable.impl.mapper.BooleanValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.ByteArrayValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.DateValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.DoubleValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.FileValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.IntegerValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.JsonValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.LongValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.NullValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.ObjectValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.ShortValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.StringValueMapper;
import org.camunda.bpm.client.variable.impl.mapper.XmlValueMapper;
import org.camunda.bpm.engine.variable.Variables;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
/**
* @author Tassilo Weidner
*/
public class ExternalTaskClientBuilderImpl implements ExternalTaskClientBuilder {
protected static final ExternalTaskClientLogger LOG = ExternalTaskClientLogger.CLIENT_LOGGER;
protected String baseUrl;
protected String workerId;
protected int maxTasks;
protected Long asyncResponseTimeout;
protected long lockDuration;
protected String defaultSerializationFormat = Variables.SerializationDataFormats.JSON.getName();
protected String dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
protected ObjectMapper objectMapper;
protected ValueMappers valueMappers;
protected TypedValues typedValues;
protected EngineClient engineClient;
protected TopicSubscriptionManager topicSubscriptionManager;
protected List<ClientRequestInterceptor> interceptors;
protected boolean isAutoFetchingEnabled;
protected BackoffStrategy backoffStrategy;
protected boolean isBackoffStrategyDisabled;
public ExternalTaskClientBuilderImpl() {
// default values
this.maxTasks = 10;
this.asyncResponseTimeout = null;
this.lockDuration = 20_000;
this.interceptors = new ArrayList<>();
this.isAutoFetchingEnabled = true;
this.backoffStrategy = new ExponentialBackoffStrategy();
this.isBackoffStrategyDisabled = false;
}
public ExternalTaskClientBuilder baseUrl(String baseUrl) {
this.baseUrl = baseUrl;
return this;
}
public ExternalTaskClientBuilder workerId(String workerId) {
this.workerId = workerId;
return this;
}
public ExternalTaskClientBuilder addInterceptor(ClientRequestInterceptor interceptor) {
this.interceptors.add(interceptor);
return this;
}
public ExternalTaskClientBuilder maxTasks(int maxTasks) {
this.maxTasks = maxTasks;
return this;
}
public ExternalTaskClientBuilder asyncResponseTimeout(long asyncResponseTimeout) {
this.asyncResponseTimeout = asyncResponseTimeout;
return this;
}
public ExternalTaskClientBuilder lockDuration(long lockDuration) {
this.lockDuration = lockDuration;
return this;
}
public ExternalTaskClientBuilder disableAutoFetching() {
this.isAutoFetchingEnabled = false;
return this;
}
public ExternalTaskClientBuilder backoffStrategy(BackoffStrategy backoffStrategy) {
this.backoffStrategy = backoffStrategy;
return this;
}
public ExternalTaskClientBuilder disableBackoffStrategy() {
this.isBackoffStrategyDisabled = true;
return this;
}
public ExternalTaskClientBuilder defaultSerializationFormat(String defaultSerializationFormat) {
this.defaultSerializationFormat = defaultSerializationFormat;
return this;
}
public ExternalTaskClientBuilder dateFormat(String dateFormat) {
this.dateFormat = dateFormat;
return this;
}
public ExternalTaskClient build() {
if (maxTasks <= 0) {
throw LOG.maxTasksNotGreaterThanZeroException(maxTasks);
}
if (asyncResponseTimeout != null && asyncResponseTimeout <= 0) {
throw LOG.asyncResponseTimeoutNotGreaterThanZeroException(asyncResponseTimeout);
}
if (lockDuration <= 0L) {
throw LOG.lockDurationIsNotGreaterThanZeroException(lockDuration);
}
if (baseUrl == null || baseUrl.isEmpty()) {
throw LOG.baseUrlNullException();
}
checkInterceptors();
initBaseUrl();
initWorkerId();
initObjectMapper();
initEngineClient();
initVariableMappers();
initTopicSubscriptionManager();
return new ExternalTaskClientImpl(topicSubscriptionManager);
}
protected void initBaseUrl() {
baseUrl = sanitizeUrl(baseUrl);
}
protected String sanitizeUrl(String url) {
url = url.trim();
if (url.endsWith("/")) {
url = url.replaceAll("/$", "");
url = sanitizeUrl(url);
}
return url;
}
protected void initWorkerId() {
if (workerId == null) {
String hostname = checkHostname();
this.workerId = hostname + UUID.randomUUID();
}
}
protected void checkInterceptors() {
interceptors.forEach(interceptor -> {
if (interceptor == null) {
throw LOG.interceptorNullException();
}
});
}
protected void initObjectMapper() {
objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNRESOLVED_OBJECT_IDS, false);
objectMapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false);
SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
objectMapper.setDateFormat(sdf);
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
}
@SuppressWarnings({ "rawtypes", "unchecked" })
protected void initVariableMappers() {
valueMappers = new DefaultValueMappers(defaultSerializationFormat);
valueMappers.addMapper(new NullValueMapper());
valueMappers.addMapper(new BooleanValueMapper());
valueMappers.addMapper(new StringValueMapper());
valueMappers.addMapper(new DateValueMapper(dateFormat));
valueMappers.addMapper(new ByteArrayValueMapper());
// number mappers
valueMappers.addMapper(new IntegerValueMapper());
valueMappers.addMapper(new LongValueMapper());
valueMappers.addMapper(new ShortValueMapper());
valueMappers.addMapper(new DoubleValueMapper());
// object
Map<String, DataFormat> dataFormats = lookupDataFormats();
dataFormats.forEach((key, format) -> {
valueMappers.addMapper(new ObjectValueMapper(key, format));
});
// json/xml
valueMappers.addMapper(new JsonValueMapper());
valueMappers.addMapper(new XmlValueMapper());
// file
valueMappers.addMapper(new FileValueMapper(engineClient));
typedValues = new TypedValues(valueMappers);
engineClient.setTypedValues(typedValues);
}
protected void initEngineClient() {
RequestInterceptorHandler requestInterceptorHandler = new RequestInterceptorHandler(interceptors);
RequestExecutor requestExecutor = new RequestExecutor(requestInterceptorHandler, objectMapper);
engineClient = new EngineClient(workerId, maxTasks, asyncResponseTimeout, baseUrl, requestExecutor);
}
protected void initTopicSubscriptionManager() {
topicSubscriptionManager = new TopicSubscriptionManager(engineClient, typedValues, lockDuration);
topicSubscriptionManager.setBackoffStrategy(getBackoffStrategy());
if (isBackoffStrategyDisabled) {
topicSubscriptionManager.disableBackoffStrategy();
}
if (isAutoFetchingEnabled()) {
topicSubscriptionManager.start();
}
}
protected Map<String, DataFormat> lookupDataFormats() {
Map<String, DataFormat> dataFormats = new HashMap<>();
lookupCustomDataFormats(dataFormats);
applyConfigurators(dataFormats);
return dataFormats;
}
protected void lookupCustomDataFormats(Map<String, DataFormat> dataFormats) {
// use java.util.ServiceLoader to load custom DataFormatProvider instances on the classpath
ServiceLoader<DataFormatProvider> providerLoader = ServiceLoader.load(DataFormatProvider.class);
for (DataFormatProvider provider : providerLoader) {
LOG.logDataFormatProvider(provider);
lookupProvider(dataFormats, provider);
}
}
protected void lookupProvider(Map<String, DataFormat> dataFormats, DataFormatProvider provider) {
String dataFormatName = provider.getDataFormatName();
if(!dataFormats.containsKey(dataFormatName)) {
DataFormat dataFormatInstance = provider.createInstance();
dataFormats.put(dataFormatName, dataFormatInstance);
LOG.logDataFormat(dataFormatInstance);
}
else {
throw LOG.multipleProvidersForDataformat(dataFormatName);
}
}
@SuppressWarnings("rawtypes")
protected void applyConfigurators(Map<String, DataFormat> dataFormats) {
ServiceLoader<DataFormatConfigurator> configuratorLoader = ServiceLoader.load(DataFormatConfigurator.class);
for (DataFormatConfigurator configurator : configuratorLoader) {
LOG.logDataFormatConfigurator(configurator);
applyConfigurator(dataFormats, configurator);
}
}
@SuppressWarnings({ "rawtypes", "unchecked" })
protected void applyConfigurator(Map<String, DataFormat> dataFormats, DataFormatConfigurator configurator) {
for (DataFormat dataFormat : dataFormats.values()) {
if (configurator.getDataFormatClass().isAssignableFrom(dataFormat.getClass())) {
configurator.configure(dataFormat);
}
}
}
public String checkHostname() {
String hostname;
try {
hostname = getHostname();
} catch (UnknownHostException e) {
throw LOG.cannotGetHostnameException(e);
}
return hostname;
}
public String getHostname() throws UnknownHostException {
return InetAddress.getLocalHost().getHostName();
}
public String getBaseUrl() {
return baseUrl;
}
protected String getWorkerId() {
return workerId;
}
protected List<ClientRequestInterceptor> getInterceptors() {
return interceptors;
}
protected int getMaxTasks() {
return maxTasks;
}
protected Long getAsyncResponseTimeout() {
return asyncResponseTimeout;
}
protected long getLockDuration() {
return lockDuration;
}
protected boolean isAutoFetchingEnabled() {
return isAutoFetchingEnabled;
}
protected BackoffStrategy getBackoffStrategy() {
return backoffStrategy;
}
public String getDefaultSerializationFormat() {
return defaultSerializationFormat;
}
public String getDateFormat() {
return dateFormat;
}
public ObjectMapper getObjectMapper() {
return objectMapper;
}
public ValueMappers getValueMappers() {
return valueMappers;
}
public TypedValues getTypedValues() {
return typedValues;
}
public EngineClient getEngineClient() {
return engineClient;
}
}