| <!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 org.apache.logging.log4j.Level;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.logging.log4j.LogManager;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.Logger;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.impl.Log4jContextFactory;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.util.NetUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.Strings;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.net.URI;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.ArrayList;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.Map;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.concurrent.TimeUnit;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Initializes and configure the Logging system. This class provides several ways to construct a LoggerContext using<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * the location of a configuration file, a context name, and various optional parameters.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public final class Configurator {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private static final String FQCN = Configurator.class.getName();<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private static Log4jContextFactory getFactory() {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> final LoggerContextFactory factory = LogManager.getFactory();<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> if (factory instanceof Log4jContextFactory) {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> return (Log4jContextFactory) factory;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> } else if (factory != null) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> LOGGER.error("LogManager returned an instance of {} which does not implement {}. Unable to initialize Log4j.",<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> factory.getClass().getName(), Log4jContextFactory.class.getName());<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> return null;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> } else {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> LOGGER.fatal("LogManager did not return a LoggerContextFactory. This indicates something has gone terribly wrong!");<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> return null;<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><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * Initializes the Logging Context.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @param loader The ClassLoader for the Context (or null).<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @param source The InputSource for the configuration.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @return The LoggerContext.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public static LoggerContext initialize(final ClassLoader loader,<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> final ConfigurationSource source) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return initialize(loader, source, null);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Initializes the Logging Context.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param loader The ClassLoader for the Context (or null).<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @param source The InputSource for the configuration.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @param externalContext The external context to be attached to the LoggerContext.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @return The LoggerContext.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public static LoggerContext initialize(final ClassLoader loader,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final ConfigurationSource source,<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> final Object externalContext)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> try {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> final Log4jContextFactory factory = getFactory();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return factory == null ? null :<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> factory.getContext(FQCN, loader, externalContext, false, source);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> } catch (final Exception ex) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> LOGGER.error("There was a problem obtaining a LoggerContext using the configuration source [{}]", source, ex);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return null;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Initializes the Logging Context.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param name The Context name.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param loader The ClassLoader for the Context (or null).<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param configLocation The configuration for the logging context.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @return The LoggerContext or null if an error occurred (check the status logger).<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public static LoggerContext initialize(final String name, final ClassLoader loader, final String configLocation) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return initialize(name, loader, configLocation, null);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Initializes the Logging Context.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param name The Context name.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param loader The ClassLoader for the Context (or null).<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param configLocation The configuration for the logging context (or null, or blank).<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param externalContext The external context to be attached to the LoggerContext<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return The LoggerContext or null if an error occurred (check the status logger).<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public static LoggerContext initialize(final String name, final ClassLoader loader, final String configLocation,<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> final Object externalContext) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> if (Strings.isBlank(configLocation)) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return initialize(name, loader, (URI) null, externalContext);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (configLocation.contains(",")) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final String[] parts = configLocation.split(",");<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> String scheme = null;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> final List<URI> uris = new ArrayList<>(parts.length);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> for (final String part : parts) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> final URI uri = NetUtils.toURI(scheme != null ? scheme + ":" + part.trim() : part.trim());<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (scheme == null && uri.getScheme() != null) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> scheme = uri.getScheme();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> uris.add(uri);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return initialize(name, loader, uris, externalContext);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return initialize(name, loader, NetUtils.toURI(configLocation), externalContext);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> /**<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * Initializes the Logging Context.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param name The Context name.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param loader The ClassLoader for the Context (or null).<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param configLocation The configuration for the logging context.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return The LoggerContext.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public static LoggerContext initialize(final String name, final ClassLoader loader, final URI configLocation) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return initialize(name, loader, configLocation, null);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<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> * Initializes the Logging Context.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @param name The Context name.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @param loader The ClassLoader for the Context (or null).<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param configLocation The configuration for the logging context (or null).<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param externalContext The external context to be attached to the LoggerContext<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @return The LoggerContext.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public static LoggerContext initialize(final String name, final ClassLoader loader, final URI configLocation,<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> final Object externalContext) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> try {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> final Log4jContextFactory factory = getFactory();<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return factory == null ? null :<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> factory.getContext(FQCN, loader, externalContext, false, configLocation, name);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> } catch (final Exception ex) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> LOGGER.error("There was a problem initializing the LoggerContext [{}] using configuration at [{}].",<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> name, configLocation, ex);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return null;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> public static LoggerContext initialize(final String name, final ClassLoader loader, final List<URI> configLocations,<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> final Object externalContext) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> try {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> final Log4jContextFactory factory = getFactory();<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return factory == null ?<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> null :<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> factory.getContext(FQCN, loader, externalContext, false, configLocations, name);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> } catch (final Exception ex) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> LOGGER.error("There was a problem initializing the LoggerContext [{}] using configurations at [{}].", name,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> configLocations, ex);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return null;<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> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Initializes the Logging Context.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param name The Context name.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @param configLocation The configuration for the logging context.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @return The LoggerContext or null if an error occurred (check the status logger).<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public static LoggerContext initialize(final String name, final String configLocation) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return initialize(name, null, configLocation);<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> /**<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * Initializes the Logging Context.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @param configuration The Configuration.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @return The LoggerContext.<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public static LoggerContext initialize(final Configuration configuration) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> return initialize(null, configuration, null);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> /**<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * Initializes the Logging Context.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param loader The ClassLoader.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @param configuration The Configuration.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * @return The LoggerContext.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> */<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> public static LoggerContext initialize(final ClassLoader loader, final Configuration configuration) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return initialize(loader, configuration, null);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> /**<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * Initializes the Logging Context.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @param loader The ClassLoader.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @param configuration The Configuration.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @param externalContext - The external context to be attached to the LoggerContext.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * @return The LoggerContext.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> */<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public static LoggerContext initialize(final ClassLoader loader, final Configuration configuration, final Object externalContext) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> try {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> final Log4jContextFactory factory = getFactory();<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return factory == null ? null :<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> factory.getContext(FQCN, loader, externalContext, false, configuration);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> } catch (final Exception ex) {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> LOGGER.error("There was a problem initializing the LoggerContext using configuration {}",<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> configuration.getName(), ex);<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return null;<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Reconfigure using an already constructed Configuration.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param configuration The configuration.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @since 2.13.0<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> */<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> public static void reconfigure(final Configuration configuration) {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> try {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> final Log4jContextFactory factory = getFactory();<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> if (factory != null) {<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> factory.getContext(FQCN, null, null, false)<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> .reconfigure(configuration);<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> } catch (final Exception ex) {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> LOGGER.error("There was a problem initializing the LoggerContext using configuration {}",<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> configuration.getName(), ex);<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> /**<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * Reload the existing reconfiguration.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @since 2.12.0<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> */<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public static void reconfigure() {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> try {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> Log4jContextFactory factory = getFactory();<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> if (factory != null) {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> factory.getSelector().getContext(FQCN, null, false).reconfigure();<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> } else {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> LOGGER.warn("Unable to reconfigure - Log4j has not been initialized.");<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> } catch (final Exception ex) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> LOGGER.error("Error encountered trying to reconfigure logging", ex);<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> /**<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * Reconfigure with a potentially new configuration.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @param uri The location of the configuration.<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @since 2.12.0<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> */<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> public static void reconfigure(final URI uri) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> try {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> Log4jContextFactory factory = getFactory();<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> if (factory != null) {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> factory.getSelector().getContext(FQCN, null, false).setConfigLocation(uri);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> } else {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> LOGGER.warn("Unable to reconfigure - Log4j has not been initialized.");<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> } catch (final Exception ex) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> LOGGER.error("Error encountered trying to reconfigure logging", ex);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> }<a name="line.280"></a> |
| <span class="sourceLineNo">281</span><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> /**<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * Sets the levels of <code>parentLogger</code> and all 'child' loggers to the given <code>level</code>.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param parentLogger the parent logger<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @param level the new level<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> */<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> public static void setAllLevels(final String parentLogger, final Level level) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> // 1) get logger config<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> // 2) if exact match, use it, if not, create it.<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> // 3) set level on logger config<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> // 4) update child logger configs with level<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> // 5) update loggers<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> final LoggerContext loggerContext = LoggerContext.getContext(false);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> final Configuration config = loggerContext.getConfiguration();<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> boolean set = setLevel(parentLogger, level, config);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> for (final Map.Entry<String, LoggerConfig> entry : config.getLoggers().entrySet()) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> if (entry.getKey().startsWith(parentLogger)) {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> set |= setLevel(entry.getValue(), level);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> }<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> if (set) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> loggerContext.updateLoggers();<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> }<a name="line.304"></a> |
| <span class="sourceLineNo">305</span><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> private static boolean setLevel(final LoggerConfig loggerConfig, final Level level) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> final boolean set = !loggerConfig.getLevel().equals(level);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> if (set) {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> loggerConfig.setLevel(level);<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> }<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> return set;<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> /**<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * Sets logger levels.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> *<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * @param levelMap<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * a levelMap where keys are level names and values are new<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * Levels.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> */<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> public static void setLevel(final Map<String, Level> levelMap) {<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> final LoggerContext loggerContext = LoggerContext.getContext(false);<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> final Configuration config = loggerContext.getConfiguration();<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> boolean set = false;<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> for (final Map.Entry<String, Level> entry : levelMap.entrySet()) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> final String loggerName = entry.getKey();<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> final Level level = entry.getValue();<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> set |= setLevel(loggerName, level, config);<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> if (set) {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> loggerContext.updateLoggers();<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> }<a name="line.333"></a> |
| <span class="sourceLineNo">334</span><a name="line.334"></a> |
| <span class="sourceLineNo">335</span> /**<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * Sets a logger's level.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> *<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @param loggerName<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * the logger name<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @param level<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * the new level<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> */<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> public static void setLevel(final String loggerName, final Level level) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> final LoggerContext loggerContext = LoggerContext.getContext(false);<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> if (Strings.isEmpty(loggerName)) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> setRootLevel(level);<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> } else {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> if (setLevel(loggerName, level, loggerContext.getConfiguration())) {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> loggerContext.updateLoggers();<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span><a name="line.353"></a> |
| <span class="sourceLineNo">354</span> private static boolean setLevel(final String loggerName, final Level level, final Configuration config) {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> boolean set;<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> LoggerConfig loggerConfig = config.getLoggerConfig(loggerName);<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if (!loggerName.equals(loggerConfig.getName())) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> // TODO Should additivity be inherited?<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> loggerConfig = new LoggerConfig(loggerName, level, true);<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> config.addLogger(loggerName, loggerConfig);<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> loggerConfig.setLevel(level);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> set = true;<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> } else {<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> set = setLevel(loggerConfig, level);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> return set;<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> /**<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * Sets the root logger's level.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> *<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @param level<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * the new level<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> */<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> public static void setRootLevel(final Level level) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> final LoggerContext loggerContext = LoggerContext.getContext(false);<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> final LoggerConfig loggerConfig = loggerContext.getConfiguration().getRootLogger();<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> if (!loggerConfig.getLevel().equals(level)) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> loggerConfig.setLevel(level);<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> loggerContext.updateLoggers();<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> }<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> }<a name="line.382"></a> |
| <span class="sourceLineNo">383</span><a name="line.383"></a> |
| <span class="sourceLineNo">384</span> /**<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * Shuts down the given logger context. This request does not wait for Log4j tasks to complete.<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * <p><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * Log4j starts threads to perform certain actions like file rollovers; calling this method will not wait until the<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * rollover thread is done. When this method returns, these tasks' status are undefined, the tasks may be done or<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * not.<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * </p><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> *<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * @param ctx<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * the logger context to shut down, may be null.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> */<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> public static void shutdown(final LoggerContext ctx) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> if (ctx != null) {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> ctx.stop();<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> }<a name="line.399"></a> |
| <span class="sourceLineNo">400</span><a name="line.400"></a> |
| <span class="sourceLineNo">401</span> /**<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * Shuts down the given logger context.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * <p><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * Log4j can start threads to perform certain actions like file rollovers; calling this method with a positive<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * timeout will block until the rollover thread is done.<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * </p><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> *<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * @param ctx<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * the logger context to shut down, may be null.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @param timeout<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * the maximum time to wait<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * @param timeUnit<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * the time unit of the timeout argument<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * @return {@code true} if the logger context terminated and {@code false} if the timeout elapsed before<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * termination.<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> *<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * @see LoggerContext#stop(long, TimeUnit)<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> *<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * @since 2.7<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> */<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> public static boolean shutdown(final LoggerContext ctx, final long timeout, final TimeUnit timeUnit) {<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> if (ctx != null) {<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> return ctx.stop(timeout, timeUnit);<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> return true;<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> }<a name="line.426"></a> |
| <span class="sourceLineNo">427</span><a name="line.427"></a> |
| <span class="sourceLineNo">428</span> private Configurator() {<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> // empty<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> }<a name="line.430"></a> |
| <span class="sourceLineNo">431</span>}<a name="line.431"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
