1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.spi;
18
19 import java.util.Map;
20
21 import org.apache.logging.log4j.util.StringMap;
22
23 /**
24 * Extension service provider interface to implement additional custom MDC behavior for
25 * {@link org.apache.logging.log4j.ThreadContext}.
26 *
27 * Consider implementing {@link CleanableThreadContextMap} instead.
28 *
29 * @see ThreadContextMap
30 * @since 2.7
31 */
32 public interface ThreadContextMap2 extends ThreadContextMap {
33
34 /**
35 * Puts all given context map entries into the current thread's
36 * context map.
37 *
38 * <p>If the current thread does not have a context map it is
39 * created as a side effect.</p>
40 * @param map The map.
41 * @since 2.7
42 */
43 void putAll(final Map<String, String> map);
44
45 /**
46 * Returns the context data for reading. Note that regardless of whether the returned context data has been
47 * {@linkplain StringMap#freeze() frozen} (made read-only) or not, callers should not attempt to modify
48 * the returned data structure.
49 *
50 * @return the {@code StringMap}
51 */
52 StringMap getReadOnlyContextData();
53 }