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 /**
20 * Extension service provider interface to implement additional custom MDC behavior for
21 * {@link org.apache.logging.log4j.ThreadContext}.
22 *
23 * @see ThreadContextMap
24 * @since 2.8
25 */
26 public interface CleanableThreadContextMap extends ThreadContextMap2 {
27
28 /**
29 * Removes all given context map keys from the current thread's context map.
30 *
31 * <p>If the current thread does not have a context map it is
32 * created as a side effect.</p>
33
34 * @param keys The keys.
35 * @since 2.8
36 */
37 void removeAll(final Iterable<String> keys);
38
39 }