blob: 3ad999f2728f9a713761f40af920ede96e3f6daa (
plain)
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
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.openecomp.sdc.logging.api.context;
import org.openecomp.sdc.logging.api.BaseFactory;
/**
* <p>Should be used to propagate a diagnostic context (for instance
* <a href="http://www.slf4j.org/manual.html#mdc">MDC</a>) to other threads.</p>
*
* <p>Applicable when creating a child thread directly, or submitting tasks for potentially postponed execution via
* an <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html">Executor</a> (including
* any of the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html">executor
* services</a> and
* <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ForkJoinPool.html">ForkJoinPool</a>).</p>
*
* <p>The service used by this factory must implement {@link ContextPropagationService}.</p>
*
* @author evitaliy
* @since 12/09/2016.
*
* @see ContextPropagationService
*/
@SuppressWarnings("ThrowableInstanceNeverThrown")
public class TaskFactory extends BaseFactory {
private static final ContextPropagationService SERVICE;
private static final RuntimeException ERROR;
static {
ContextPropagationService service = null;
RuntimeException error = null;
try {
service = locateService(ContextPropagationService.class);
} catch (Throwable e) {
error = new RuntimeException("Failed to instantiate task factory", e);
}
SERVICE = service;
ERROR = error;
}
/**
* Modify a task so that a diagnostic context is propagated to the thread when the task runs. Done in a
* logging-framework specific way.
*
* @param task any Runnable that will run in a thread
* @return modified (wrapped) original task that runs the same business logic, but also takes care of copying the
* diagnostic context for logging
*/
public static Runnable create(Runnable task) {
if (SERVICE == null) {
throw ERROR;
}
return SERVICE.create(task);
}
}
|
