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.core.util; 18 19 import org.apache.logging.log4j.core.impl.JdkMapAdapterStringMap; 20 import org.apache.logging.log4j.util.StringMap; 21 22 import java.util.Map; 23 24 /** 25 * Source of context data to be added to each log event. 26 */ 27 public interface ContextDataProvider { 28 29 /** 30 * Returns a Map containing context data to be injected into the event or null if no context data is to be added. 31 * @return A Map containing the context data or null. 32 */ 33 Map<String, String> supplyContextData(); 34 35 /** 36 * Returns the context data as a StringMap. 37 * @return the context data in a StringMap. 38 */ 39 default StringMap supplyStringMap() { 40 return new JdkMapAdapterStringMap(supplyContextData()); 41 } 42 }