org.apache.logging.log4j.core.config.Configuration Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache license, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the license for the specific language governing permissions and
* limitations under the license.
*/
package org.apache.logging.log4j.core.config;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.filter.Filterable;
import org.apache.logging.log4j.core.lookup.StrSubstitutor;
import org.apache.logging.log4j.core.net.Advertiser;
import java.util.List;
import java.util.Map;
/**
* Interface that must be implemented to create a configuration.
*/
public interface Configuration extends Filterable {
/** Key for storing the Context properties. */
String CONTEXT_PROPERTIES = "ContextProperties";
/**
* Returns the configuration name.
*
* @return the name of the configuration.
*/
String getName();
/**
* Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as
* necessary or return the root LoggerConfig if no other matches were found.
*
* @param name The Logger name.
* @return The located LoggerConfig.
*/
LoggerConfig getLoggerConfig(String name);
/**
* Returns the Appender with the specified name.
*
* @param name The name of the Appender.
* @return the Appender with the specified name or null if the Appender cannot be located.
*/
Appender getAppender(String name);
/**
* Returns a Map containing all the Appenders and their name.
*
* @return A Map containing each Appender's name and the Appender object.
*/
Map getAppenders();
void addAppender(final Appender appender);
Map getLoggers();
void addLoggerAppender(Logger logger, Appender appender);
void addLoggerFilter(Logger logger, Filter filter);
void setLoggerAdditive(Logger logger, boolean additive);
void addLogger(final String name, final LoggerConfig loggerConfig);
void removeLogger(final String name);
/**
* Returns the list of packages to scan for plugins for this Configuration.
*
* @return the list of plugin packages.
* @since 2.1
*/
List getPluginPackages();
Map getProperties();
void addListener(ConfigurationListener listener);
void removeListener(ConfigurationListener listener);
StrSubstitutor getStrSubstitutor();
void createConfiguration(Node node, LogEvent event);
T getComponent(String name);
void addComponent(String name, Object object);
void setConfigurationMonitor(ConfigurationMonitor monitor);
ConfigurationMonitor getConfigurationMonitor();
void setAdvertiser(Advertiser advertiser);
Advertiser getAdvertiser();
boolean isShutdownHookEnabled();
/**
* Returns the source of this configuration.
*
* @return the source of this configuration
*/
ConfigurationSource getConfigurationSource();
/**
*
* Returns a list of descriptors of the custom levels defined in the current configuration. The returned list does
* not include custom levels that are defined in code with direct calls to {@link Level#forName(String, int)}.
*
*
* Note that the list does not include levels of previous configurations. For example, suppose a configuration
* contains custom levels A, B and C. The configuration is then modified to contain custom levels B, C and D. For
* the new configuration, this method will return only {B, C, D}, that is, only the custom levels defined in
* this configuration. The previously defined level A still exists (and can be obtained with
* {@link Level#getLevel(String)}), it is just not in the current configuration. {@link Level#values()} will return
* {A, B, C, D and the built-in levels}.
*
*
* @return the custom levels defined in the current configuration
*/
List getCustomLevels();
}