/
ContextualExecutors.java
378 lines (355 loc) · 15.6 KB
/
ContextualExecutors.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
/*
* JBoss, Home of Professional Open Source.
*
* Copyright 2021 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.jboss.resteasy.concurrent;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import org.jboss.resteasy.resteasy_jaxrs.i18n.LogMessages;
import org.jboss.resteasy.spi.ResteasyProviderFactory;
import org.jboss.resteasy.spi.concurrent.ThreadContext;
import org.jboss.resteasy.spi.concurrent.ThreadContexts;
/**
* A utility to create and/or wrap {@linkplain ExecutorService executors} in a contextual executor.
*
* @author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>
* @see ContextualExecutorService
* @see ContextualScheduledExecutorService
* @see Executor
* @since 5.0.0
*/
public class ContextualExecutors {
private static final String EXECUTOR_SERVICE_JNDI = "java:comp/DefaultManagedExecutorService";
private static final String SCHEDULED_EXECUTOR_SERVICE_JNDI = "java:comp/DefaultManagedScheduledExecutorService";
private static final Map<String, Boolean> JNDI_LOOKUPS = new ConcurrentHashMap<>();
/**
* An executor which executes tasks in the current thread
*
* @return a new contextual executor
*/
public static Executor executor() {
final Map<ThreadContext<Object>, Object> contexts = getContexts();
return (task) -> runnable(contexts, task).run();
}
/**
* Creates a new {@link ContextualExecutorService} or wraps the default {@code ManagedExecutorService} in a
* Jakarta EE environment.
* <p>
* If executed in a Jakarta EE container which includes a default {@code ManagedExecutorService}, that executor
* is wrapped an said to be managed. If the default executor service cannot be found or if not being executed in a
* Jakarta EE container a new {@linkplain Executors#newCachedThreadPool() cached thread pool} will be wrapped.
* </p>
* <p>
* In a Jakarta EE container the JNDI lookup name can be overridden with the {@code resteasy.async.executor.service.jndi}
* configuration property. By default the JNDI lookup name is {@code java:comp/DefaultManagedExecutorService}.
* </p>
*
* @return a new contextual executor
*/
public static ContextualExecutorService threadPool() {
ExecutorService delegate = lookup(EXECUTOR_SERVICE_JNDI);
if (delegate == null) {
delegate = GlobalContextualExecutorService.INSTANCE;
}
return wrap(delegate, true);
}
/**
* Creates a new {@link ContextualScheduledExecutorService} or wraps the default {@code ManagedScheduledExecutorService}
* in a Jakarta EE environment.
* <p>
* If executed in a Jakarta EE container which includes a default {@code ManagedScheduledExecutorService}, that executor
* is wrapped an said to be managed. If the default executor service cannot be found or if not being executed in a
* Jakarta EE container a new {@linkplain Executors#newScheduledThreadPool(int) scheduled thread pool} will be
* wrapped. The size of the thread pool is retrieved via the {@code resteasy.async.timeout.scheduler.min.pool.size}
* context parameter. If not found {@code 1} is the default. The thread pool size is ignored in Jakarta EE
* environments.
* </p>
* <p>
* In a Jakarta EE container the JNDI lookup name can be overridden with the
* {@code resteasy.async.scheduled.executor.service.jndi} configuration property. By default the JNDI lookup name is
* {@code java:comp/DefaultManagedScheduledExecutorService}.
* </p>
*
* @return a new contextual executor
*/
public static ContextualScheduledExecutorService scheduledThreadPool() {
ScheduledExecutorService delegate = lookup(SCHEDULED_EXECUTOR_SERVICE_JNDI);
if (delegate == null) {
delegate = GlobalContextualScheduledExecutorService.INSTANCE;
}
return wrap(delegate, true);
}
/**
* Creates a new {@link ContextualScheduledExecutorService} or wraps the default {@code ManagedScheduledExecutorService}
* in a Jakarta EE environment.
* <p>
* If executed in a Jakarta EE container which includes a default {@code ManagedScheduledExecutorService}, that executor
* is wrapped an said to be managed. If the default executor service cannot be found or if not being executed in a
* Jakarta EE container a new {@linkplain Executors#newScheduledThreadPool(int) scheduled thread pool} will be
* wrapped.
* </p>
* <p>
* In a Jakarta EE container the JNDI lookup name can be overridden with the
* {@code resteasy.async.scheduled.executor.service.jndi} configuration property. By default the JNDI lookup name is
* {@code java:comp/DefaultManagedScheduledExecutorService}.
* </p>
*
* @param poolSize the size of the pool to create, ignored in a Jakarta EE container
* @param threadFactory the thread factory to use if a new executor is created, ignored in a Jakarta EE container
*
* @return a new contextual executor
*/
public static ContextualScheduledExecutorService scheduledThreadPool(final int poolSize,
final ThreadFactory threadFactory) {
ScheduledExecutorService delegate = lookup(SCHEDULED_EXECUTOR_SERVICE_JNDI);
boolean managed = true;
if (delegate == null) {
delegate = Executors.newScheduledThreadPool(poolSize, threadFactory);
managed = false;
}
return wrap(delegate, managed);
}
/**
* Wraps the executor service in contextual executor and is said to be managed. You are responsible for the
* lifecycle of the delegate.
* <p>
* The context is copied in before each invocation of the delegate, then reset after the thread is done executing.
* </p>
*
* @param delegate the executor to wrap
*
* @return a new contextual executor
*/
public static ContextualExecutorService wrap(final ExecutorService delegate) {
return wrap(delegate, true);
}
/**
* Wraps the executor service in contextual executor and is said to be managed. You are responsible for the
* lifecycle of the delegate.
* <p>
* The context is copied in before each invocation of the delegate, then reset after the thread is done executing.
* </p>
*
* @param delegate the executor to wrap
* @param managed {@code true} if the lifecycle is managed by another process
*
* @return a new contextual executor
*/
public static ContextualExecutorService wrap(final ExecutorService delegate, final boolean managed) {
if (delegate == null) {
return null;
}
if (delegate instanceof ScheduledExecutorService) {
return wrap(((ScheduledExecutorService) delegate), managed);
}
if (delegate instanceof ContextualExecutorService && managed == ((ContextualExecutorService) delegate).isManaged()) {
if (managed == ((ContextualExecutorService) delegate).isManaged()) {
return (ContextualExecutorService) delegate;
}
return new ContextualExecutorService(((ContextualExecutorService) delegate).getDelegate(), managed);
}
return new ContextualExecutorService(delegate, managed);
}
/**
* Wraps the executor service in contextual executor and is said to be managed. You are responsible for the
* lifecycle of the delegate.
* <p>
* The context is copied in before each invocation of the delegate, then reset after the thread is done executing.
* </p>
*
* @param delegate the executor to wrap
*
* @return a new contextual executor
*/
public static ContextualScheduledExecutorService wrap(final ScheduledExecutorService delegate) {
return wrap(delegate, true);
}
/**
* Wraps the executor service in contextual executor and is said to be managed. You are responsible for the
* lifecycle of the delegate.
* <p>
* The context is copied in before each invocation of the delegate, then reset after the thread is done executing.
* </p>
*
* @param delegate the executor to wrap
* @param managed {@code true} if the lifecycle is managed by another process
*
* @return a new contextual executor
*/
public static ContextualScheduledExecutorService wrap(final ScheduledExecutorService delegate,
final boolean managed) {
if (delegate == null) {
return null;
}
if (delegate instanceof ContextualScheduledExecutorService
&& managed == ((ContextualScheduledExecutorService) delegate).isManaged()) {
if (managed == ((ContextualScheduledExecutorService) delegate).isManaged()) {
return (ContextualScheduledExecutorService) delegate;
}
return new ContextualScheduledExecutorService(((ContextualScheduledExecutorService) delegate).getDelegate(),
managed);
}
return new ContextualScheduledExecutorService(delegate, managed);
}
/**
* If the delegate is not {@code null}, it is wrapped. If the delegate is {@code null} and this is a Jakarta EE
* environment an attempt will be made to look up the default {@code ManagedScheduledExecutorService}. If found the
* default {@code ManagedScheduledExecutorService} will be wrapped. Otherwise, {@code null} will be returned.
*
* @param delegate the delegate to wrap, which may be {@code null}
*
* @return a wrapped contextual executor or {@code null} if no executor was provided or could be found
*
* @see #wrap(ScheduledExecutorService)
*/
public static ContextualScheduledExecutorService wrapOrLookup(final ScheduledExecutorService delegate) {
if (delegate != null) {
return wrap(delegate, true);
}
ScheduledExecutorService found = lookup(SCHEDULED_EXECUTOR_SERVICE_JNDI);
return found == null ? null : wrap(found, true);
}
/**
* Creates a new {@linkplain Runnable runnable} which sets up the current context before the runnable is executed.
* Finally, resetting the context.
*
* @param task the runnable to wrap
*
* @return a new contextual runnable
*/
public static Runnable runnable(final Runnable task) {
return runnable(getContexts(), task);
}
/**
* Creates a new {@linkplain Callable callable} which sets up the current context before the callable is executed.
* Finally, resetting the context.
*
* @param task the callable to wrap
* @param <V> the return type
*
* @return a new contextual callable
*/
public static <V> Callable<V> callable(final Callable<V> task) {
final Map<ThreadContext<Object>, Object> contexts = getContexts();
return () -> {
try {
for (Map.Entry<ThreadContext<Object>, Object> entry : contexts.entrySet()) {
entry.getKey().push(entry.getValue());
}
return task.call();
} finally {
reset(contexts);
}
};
}
/**
* Creates a new collection of {@linkplain Callable callables} which sets up the current context before each
* callable is executed. Finally, resetting the context.
*
* @param tasks the callables to wrap
* @param <T> the return type of the callable
*
* @return a collection of new contextual callables
*
* @see #callable(Callable)
*/
public static <T> Collection<? extends Callable<T>> callable(final Collection<? extends Callable<T>> tasks) {
return tasks.stream()
.map((Function<Callable<T>, Callable<T>>) ContextualExecutors::callable)
.collect(Collectors.toList());
}
private static Runnable runnable(final Map<ThreadContext<Object>, Object> contexts, final Runnable task) {
return () -> {
try {
for (Map.Entry<ThreadContext<Object>, Object> entry : contexts.entrySet()) {
entry.getKey().push(entry.getValue());
}
task.run();
} finally {
reset(contexts);
}
};
}
private static Map<ThreadContext<Object>, Object> getContexts() {
final Map<ThreadContext<Object>, Object> contexts = new LinkedHashMap<>();
// Load any registered providers
ThreadContexts threadContexts = ResteasyProviderFactory.getInstance()
.getContextData(ThreadContexts.class);
// Create a new ThreadContexts which will load at least the ones from services
if (threadContexts == null) {
threadContexts = new ThreadContexts();
}
for (ThreadContext<Object> context : threadContexts.getThreadContexts()) {
contexts.put(context, context.capture());
}
return contexts;
}
private static void reset(final Map<ThreadContext<Object>, Object> contexts) {
Throwable error = null;
for (Map.Entry<ThreadContext<Object>, Object> context : contexts.entrySet()) {
try {
context.getKey().reset(context.getValue());
} catch (Throwable t) {
if (error == null) {
error = t;
} else {
error.addSuppressed(t);
}
}
}
if (error != null) {
LogMessages.LOGGER.unableToResetThreadContext(error, Thread.currentThread().getName());
}
}
private static <T extends ExecutorService> T lookup(final String jndiName) {
final Boolean performLookup = JNDI_LOOKUPS.get(jndiName);
if (performLookup != null && performLookup) {
try {
// This could have some performance impact. However, we can't assume the context we're in, so we need
// to look it up each time.
return InitialContext.doLookup(jndiName);
} catch (NamingException ignore) {
} catch (Exception e) {
LogMessages.LOGGER.failedToLookupManagedExecutorService(e, jndiName);
}
} else if (performLookup == null) {
// Do one lookup and if not found assume it won't be in the future
try {
final T service = InitialContext.doLookup(jndiName);
JNDI_LOOKUPS.put(jndiName, Boolean.TRUE);
return service;
} catch (NamingException ignore) {
} catch (Exception e) {
LogMessages.LOGGER.failedToLookupManagedExecutorService(e, jndiName);
}
JNDI_LOOKUPS.put(jndiName, Boolean.FALSE);
}
return null;
}
}