blob: 37e212ac544c59bf626f12179f731f278dc38445 (
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
|
/*
* Copyright © 2016-2018 European Support Limited
*
* 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.openecomp.sdc.logging.spi;
import java.util.concurrent.Callable;
import org.openecomp.sdc.logging.api.ContextData;
/**
* Should be used to implement a framework-specific mechanism of managing a per-thread diagnostic context (for instance
* <a href="http://www.slf4j.org/manual.html#mdc">MDC</a>), and propagating it to child threads if needed. Context
* propagation should be used 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>).
*
* @author evitaliy
* @since 07 Jan 2018
*/
public interface LoggingContextService {
/**
* Put logging data on the context.
*/
void put(ContextData contextData);
/**
* Return logging context's data.
*/
ContextData get();
/**
* Clear logging thread context.
*/
void clear();
/**
* Copies logging context of current thread onto a {@link Runnable}, so that the context is available when this
* {@link Runnable} runs in another thread.
*/
Runnable copyToRunnable(Runnable runnable);
/**
* Copies logging context of current thread onto a {@link Callable}, so that the context is available when this
* {@link Callable} runs in another thread
*/
<V> Callable<V> copyToCallable(Callable<V> callable);
}
|
