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
019import java.util.Map;
020
021import org.apache.logging.log4j.util.StringMap;
022
023/**
024 * Extension service provider interface to implement additional custom MDC behavior for
025 * {@link org.apache.logging.log4j.ThreadContext}.
026 *
027 * Consider implementing {@link CleanableThreadContextMap} instead.
028 *
029 * @see ThreadContextMap
030 * @since 2.7
031 */
032public interface ThreadContextMap2 extends ThreadContextMap {
033
034    /**
035     * Puts all given context map entries into the current thread's
036     * context map.
037     *
038     * <p>If the current thread does not have a context map it is
039     * created as a side effect.</p>
040     * @param map The map.
041     * @since 2.7
042     */
043    void putAll(final Map<String, String> map);
044
045    /**
046     * Returns the context data for reading. Note that regardless of whether the returned context data has been
047     * {@linkplain StringMap#freeze() frozen} (made read-only) or not, callers should not attempt to modify
048     * the returned data structure.
049     *
050     * @return the {@code StringMap}
051     */
052    StringMap getReadOnlyContextData();
053}