001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.spi;
018
019/**
020 * Extension service provider interface to implement additional custom MDC behavior for
021 * {@link org.apache.logging.log4j.ThreadContext}.
022 *
023 * @see ThreadContextMap
024 * @since 2.8
025 */
026public interface CleanableThreadContextMap extends ThreadContextMap2 {
027
028    /**
029     * Removes all given context map keys from the current thread's context map.
030     *
031     * <p>If the current thread does not have a context map it is
032     * created as a side effect.</p>
033
034     * @param keys The keys.
035     * @since 2.8
036     */
037    void removeAll(final Iterable<String> keys);
038
039}