| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.config;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.List;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.Level;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Appender;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Filter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Logger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.async.AsyncLoggerConfigDelegate;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.filter.Filterable;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.net.Advertiser;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.script.ScriptManager;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.util.NanoClock;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.util.WatchManager;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Interface that must be implemented to create a configuration.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Custom implementations are recommended to extend {@link AbstractConfiguration}.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @see AbstractConfiguration<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @see org.apache.logging.log4j.core.LifeCycle2<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public interface Configuration extends Filterable {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /** Key for storing the Context properties. */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> String CONTEXT_PROPERTIES = "ContextProperties";<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Returns the configuration name.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> *<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @return the name of the configuration.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> String getName();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * necessary or return the root LoggerConfig if no other matches were found.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @param name The Logger name.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @return The located LoggerConfig.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> LoggerConfig getLoggerConfig(String name);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Returns the Appender with the specified name.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param <T> The expected Appender type.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param name The name of the Appender.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return the Appender with the specified name or null if the Appender cannot be located.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> <T extends Appender> T getAppender(String name);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Returns a Map containing all the Appenders and their name.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return A Map containing each Appender's name and the Appender object.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> Map<String, Appender> getAppenders();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> void addAppender(final Appender appender);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> Map<String, LoggerConfig> getLoggers();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> void addLoggerAppender(Logger logger, Appender appender);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> void addLoggerFilter(Logger logger, Filter filter);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> void setLoggerAdditive(Logger logger, boolean additive);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> void addLogger(final String name, final LoggerConfig loggerConfig);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> void removeLogger(final String name);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Returns the list of packages to scan for plugins for this Configuration.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @return the list of plugin packages.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @since 2.1<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> List<String> getPluginPackages();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> Map<String, String> getProperties();<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Returns the root Logger.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return the root Logger.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> LoggerConfig getRootLogger();<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> void addListener(ConfigurationListener listener);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> void removeListener(ConfigurationListener listener);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> StrSubstitutor getStrSubstitutor();<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> void createConfiguration(Node node, LogEvent event);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> <T> T getComponent(String name);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> void addComponent(String name, Object object);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> void setAdvertiser(Advertiser advertiser);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> Advertiser getAdvertiser();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> boolean isShutdownHookEnabled();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> long getShutdownTimeoutMillis();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> ConfigurationScheduler getScheduler();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Returns the source of this configuration.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> *<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @return the source of this configuration, never {@code null}, but may be<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * {@link org.apache.logging.log4j.core.config.ConfigurationSource#NULL_SOURCE}<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * or<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * {@link org.apache.logging.log4j.core.config.ConfigurationSource#COMPOSITE_SOURCE}<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> ConfigurationSource getConfigurationSource();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> /**<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <p><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Returns a list of descriptors of the custom levels defined in the current configuration. The returned list does<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * <em>not</em> include custom levels that are defined in code with direct calls to {@link Level#forName(String, int)}.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * </p><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * <p><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Note that the list does not include levels of previous configurations. For example, suppose a configuration<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * contains custom levels A, B and C. The configuration is then modified to contain custom levels B, C and D. For<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * the new configuration, this method will return only {B, C, D}, that is, only the custom levels defined in<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * <em>this</em> configuration. The previously defined level A still exists (and can be obtained with<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * {@link Level#getLevel(String)}), it is just not in the current configuration. {@link Level#values()} will return<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * {A, B, C, D and the built-in levels}.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * </p><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> *<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return the custom levels defined in the current configuration<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> List<CustomLevelConfig> getCustomLevels();<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> ScriptManager getScriptManager();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /**<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * Returns the {@code AsyncLoggerConfigDelegate} shared by all<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * {@code AsyncLoggerConfig} instances defined in this Configuration.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return the {@code AsyncLoggerConfigDelegate}<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> AsyncLoggerConfigDelegate getAsyncLoggerConfigDelegate();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Return the WatchManager.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> *<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @return the WatchManager.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> */<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> WatchManager getWatchManager();<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> /*<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * (non-Javadoc)<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> *<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @see<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * org.apache.logging.log4j.core.config.ReliabilityStrategyFactory#getReliabilityStrategy(org.apache.logging.log4j<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * .core.config.LoggerConfig)<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> ReliabilityStrategy getReliabilityStrategy(LoggerConfig loggerConfig);<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> /**<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * Returns the {@link NanoClock} instance for this configuration.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> *<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @return the nano clock<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> NanoClock getNanoClock();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> /**<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * Sets the {@link NanoClock} instance for this configuration.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> *<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @param nanoClock the new nano clock for this configuration. Must be non-null.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> */<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> void setNanoClock(NanoClock nanoClock);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> /**<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * Gets the logger context.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> *<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * @return the logger context.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> */<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> LoggerContext getLoggerContext();<a name="line.209"></a> |
| <span class="sourceLineNo">210</span>}<a name="line.210"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
