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.config;
18
19 import java.util.List;
20 import java.util.Map;
21
22 import org.apache.logging.log4j.Level;
23 import org.apache.logging.log4j.core.Appender;
24 import org.apache.logging.log4j.core.Filter;
25 import org.apache.logging.log4j.core.LogEvent;
26 import org.apache.logging.log4j.core.Logger;
27 import org.apache.logging.log4j.core.async.AsyncLoggerConfigDelegate;
28 import org.apache.logging.log4j.core.filter.Filterable;
29 import org.apache.logging.log4j.core.lookup.StrSubstitutor;
30 import org.apache.logging.log4j.core.net.Advertiser;
31 import org.apache.logging.log4j.core.script.ScriptManager;
32 import org.apache.logging.log4j.core.util.WatchManager;
33
34 /**
35 * Interface that must be implemented to create a configuration.
36 */
37 public interface Configuration extends Filterable {
38
39 /** Key for storing the Context properties. */
40 String CONTEXT_PROPERTIES = "ContextProperties";
41
42 /**
43 * Returns the configuration name.
44 *
45 * @return the name of the configuration.
46 */
47 String getName();
48
49 /**
50 * Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as
51 * necessary or return the root LoggerConfig if no other matches were found.
52 *
53 * @param name The Logger name.
54 * @return The located LoggerConfig.
55 */
56 LoggerConfig getLoggerConfig(String name);
57
58 /**
59 * Returns the Appender with the specified name.
60 *
61 * @param <T> The expected Appender type.
62 * @param name The name of the Appender.
63 * @return the Appender with the specified name or null if the Appender cannot be located.
64 */
65 <T extends Appender> T getAppender(String name);
66
67 /**
68 * Returns a Map containing all the Appenders and their name.
69 *
70 * @return A Map containing each Appender's name and the Appender object.
71 */
72 Map<String, Appender> getAppenders();
73
74 void addAppender(final Appender appender);
75
76 Map<String, LoggerConfig> getLoggers();
77
78 void addLoggerAppender(Logger logger, Appender appender);
79
80 void addLoggerFilter(Logger logger, Filter filter);
81
82 void setLoggerAdditive(Logger logger, boolean additive);
83
84 void addLogger(final String name, final LoggerConfig loggerConfig);
85
86 void removeLogger(final String name);
87
88 /**
89 * Returns the list of packages to scan for plugins for this Configuration.
90 *
91 * @return the list of plugin packages.
92 * @since 2.1
93 */
94 List<String> getPluginPackages();
95
96 Map<String, String> getProperties();
97
98 /**
99 * Returns the root Logger.
100 * @return the root Logger.
101 */
102 LoggerConfig getRootLogger();
103
104 void addListener(ConfigurationListener listener);
105
106 void removeListener(ConfigurationListener listener);
107
108 StrSubstitutor getStrSubstitutor();
109
110 void createConfiguration(Node node, LogEvent event);
111
112 <T> T getComponent(String name);
113
114 void addComponent(String name, Object object);
115
116 void setAdvertiser(Advertiser advertiser);
117
118 Advertiser getAdvertiser();
119
120 boolean isShutdownHookEnabled();
121
122 ConfigurationScheduler getScheduler();
123
124 /**
125 * Returns the source of this configuration.
126 *
127 * @return the source of this configuration
128 */
129 ConfigurationSource getConfigurationSource();
130
131 /**
132 * <p>
133 * Returns a list of descriptors of the custom levels defined in the current configuration. The returned list does
134 * <em>not</em> include custom levels that are defined in code with direct calls to {@link Level#forName(String, int)}.
135 * </p>
136 * <p>
137 * Note that the list does not include levels of previous configurations. For example, suppose a configuration
138 * contains custom levels A, B and C. The configuration is then modified to contain custom levels B, C and D. For
139 * the new configuration, this method will return only {B, C, D}, that is, only the custom levels defined in
140 * <em>this</em> configuration. The previously defined level A still exists (and can be obtained with
141 * {@link Level#getLevel(String)}), it is just not in the current configuration. {@link Level#values()} will return
142 * {A, B, C, D and the built-in levels}.
143 * </p>
144 *
145 * @return the custom levels defined in the current configuration
146 */
147 List<CustomLevelConfig> getCustomLevels();
148
149 ScriptManager getScriptManager();
150
151 /**
152 * Returns the {@code AsyncLoggerConfigDelegate} shared by all
153 * {@code AsyncLoggerConfig} instances defined in this Configuration.
154 *
155 * @return the {@code AsyncLoggerConfigDelegate}
156 */
157 AsyncLoggerConfigDelegate getAsyncLoggerConfigDelegate();
158
159 /**
160 * Return the WatchManager.
161 * @return the WatchManager.
162 */
163 WatchManager getWatchManager();
164
165 /*
166 * (non-Javadoc)
167 *
168 * @see
169 * org.apache.logging.log4j.core.config.ReliabilityStrategyFactory#getReliabilityStrategy(org.apache.logging.log4j
170 * .core.config.LoggerConfig)
171 */
172
173 ReliabilityStrategy getReliabilityStrategy(LoggerConfig loggerConfig);
174
175 }