blob: 3d973dcf5272dcaf3fddf8437fd7397e515a9061 [file] [log] [blame]
<!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;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.net.URI;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.SortedMap;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.TreeMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.message.MessageFactory;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.message.StringFormatterMessageFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.simple.SimpleLoggerContextFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.spi.LoggerContext;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.spi.Provider;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.spi.Terminable;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.util.LoaderUtil;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.util.ProviderUtil;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.util.StackLocatorUtil;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.util.Strings;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * The anchor point for the Log4j logging system. The most common usage of this class is to obtain a named<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link Logger}. The method {@link #getLogger()} is provided as the most convenient way to obtain a named Logger based<a name="line.40"></a>
<span class="sourceLineNo">041</span> * on the calling class name. This class also provides method for obtaining named Loggers that use<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@link String#format(String, Object...)} style messages instead of the default type of parameterized messages. These<a name="line.42"></a>
<span class="sourceLineNo">043</span> * are obtained through the {@link #getFormatterLogger(Class)} family of methods. Other service provider methods are<a name="line.43"></a>
<span class="sourceLineNo">044</span> * given through the {@link #getContext()} and {@link #getFactory()} family of methods; these methods are not normally<a name="line.44"></a>
<span class="sourceLineNo">045</span> * useful for typical usage of Log4j.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>public class LogManager {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Log4j property to set to the fully qualified class name of a custom implementation of<a name="line.50"></a>
<span class="sourceLineNo">051</span> * {@link org.apache.logging.log4j.spi.LoggerContextFactory}.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static final String FACTORY_PROPERTY_NAME = "log4j2.loggerContextFactory";<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * The name of the root Logger.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public static final String ROOT_LOGGER_NAME = Strings.EMPTY;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> // for convenience<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final String FQCN = LogManager.class.getName();<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private static volatile LoggerContextFactory factory;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Scans the classpath to find all logging implementation. Currently, only one will be used but this could be<a name="line.68"></a>
<span class="sourceLineNo">069</span> * extended to allow multiple implementations to be used.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> static {<a name="line.71"></a>
<span class="sourceLineNo">072</span> // Shortcut binding to force a specific logging implementation.<a name="line.72"></a>
<span class="sourceLineNo">073</span> final PropertiesUtil managerProps = PropertiesUtil.getProperties();<a name="line.73"></a>
<span class="sourceLineNo">074</span> final String factoryClassName = managerProps.getStringProperty(FACTORY_PROPERTY_NAME);<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (factoryClassName != null) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> try {<a name="line.76"></a>
<span class="sourceLineNo">077</span> factory = LoaderUtil.newCheckedInstanceOf(factoryClassName, LoggerContextFactory.class);<a name="line.77"></a>
<span class="sourceLineNo">078</span> } catch (final ClassNotFoundException cnfe) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> LOGGER.error("Unable to locate configured LoggerContextFactory {}", factoryClassName);<a name="line.79"></a>
<span class="sourceLineNo">080</span> } catch (final Exception ex) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> LOGGER.error("Unable to create configured LoggerContextFactory {}", factoryClassName, ex);<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> if (factory == null) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> final SortedMap&lt;Integer, LoggerContextFactory&gt; factories = new TreeMap&lt;&gt;();<a name="line.86"></a>
<span class="sourceLineNo">087</span> // note that the following initial call to ProviderUtil may block until a Provider has been installed when<a name="line.87"></a>
<span class="sourceLineNo">088</span> // running in an OSGi environment<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (ProviderUtil.hasProviders()) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> for (final Provider provider : ProviderUtil.getProviders()) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> final Class&lt;? extends LoggerContextFactory&gt; factoryClass = provider.loadLoggerContextFactory();<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (factoryClass != null) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> try {<a name="line.93"></a>
<span class="sourceLineNo">094</span> factories.put(provider.getPriority(), factoryClass.newInstance());<a name="line.94"></a>
<span class="sourceLineNo">095</span> } catch (final Exception e) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> LOGGER.error("Unable to create class {} specified in provider URL {}", factoryClass.getName(), provider<a name="line.96"></a>
<span class="sourceLineNo">097</span> .getUrl(), e);<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> if (factories.isEmpty()) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> LOGGER.error("Log4j2 could not find a logging implementation. "<a name="line.103"></a>
<span class="sourceLineNo">104</span> + "Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");<a name="line.104"></a>
<span class="sourceLineNo">105</span> factory = new SimpleLoggerContextFactory();<a name="line.105"></a>
<span class="sourceLineNo">106</span> } else if (factories.size() == 1) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> factory = factories.get(factories.lastKey());<a name="line.107"></a>
<span class="sourceLineNo">108</span> } else {<a name="line.108"></a>
<span class="sourceLineNo">109</span> final StringBuilder sb = new StringBuilder("Multiple logging implementations found: \n");<a name="line.109"></a>
<span class="sourceLineNo">110</span> for (final Map.Entry&lt;Integer, LoggerContextFactory&gt; entry : factories.entrySet()) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> sb.append("Factory: ").append(entry.getValue().getClass().getName());<a name="line.111"></a>
<span class="sourceLineNo">112</span> sb.append(", Weighting: ").append(entry.getKey()).append('\n');<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> factory = factories.get(factories.lastKey());<a name="line.114"></a>
<span class="sourceLineNo">115</span> sb.append("Using factory: ").append(factory.getClass().getName());<a name="line.115"></a>
<span class="sourceLineNo">116</span> LOGGER.warn(sb.toString());<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> } else {<a name="line.119"></a>
<span class="sourceLineNo">120</span> LOGGER.error("Log4j2 could not find a logging implementation. "<a name="line.120"></a>
<span class="sourceLineNo">121</span> + "Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");<a name="line.121"></a>
<span class="sourceLineNo">122</span> factory = new SimpleLoggerContextFactory();<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
<span class="sourceLineNo">128</span> * Prevents instantiation<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> protected LogManager() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<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> * Detects if a Logger with the specified name exists. This is a convenience method for porting from version 1.<a name="line.134"></a>
<span class="sourceLineNo">135</span> *<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @param name The Logger name to search for.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @return true if the Logger exists, false otherwise.<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @see LoggerContext#hasLogger(String)<a name="line.138"></a>
<span class="sourceLineNo">139</span> */<a name="line.139"></a>
<span class="sourceLineNo">140</span> public static boolean exists(final String name) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> return getContext().hasLogger(name);<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<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> * Returns the current LoggerContext.<a name="line.145"></a>
<span class="sourceLineNo">146</span> * &lt;p&gt;<a name="line.146"></a>
<span class="sourceLineNo">147</span> * WARNING - The LoggerContext returned by this method may not be the LoggerContext used to create a Logger for the<a name="line.147"></a>
<span class="sourceLineNo">148</span> * calling class.<a name="line.148"></a>
<span class="sourceLineNo">149</span> * &lt;/p&gt;<a name="line.149"></a>
<span class="sourceLineNo">150</span> *<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @return The current LoggerContext.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public static LoggerContext getContext() {<a name="line.153"></a>
<span class="sourceLineNo">154</span> try {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return factory.getContext(FQCN, null, null, true);<a name="line.155"></a>
<span class="sourceLineNo">156</span> } catch (final IllegalStateException ex) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.157"></a>
<span class="sourceLineNo">158</span> return new SimpleLoggerContextFactory().getContext(FQCN, null, null, true);<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
<span class="sourceLineNo">163</span> * Returns a LoggerContext.<a name="line.163"></a>
<span class="sourceLineNo">164</span> *<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.165"></a>
<span class="sourceLineNo">166</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.166"></a>
<span class="sourceLineNo">167</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.167"></a>
<span class="sourceLineNo">168</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @return a LoggerContext.<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> public static LoggerContext getContext(final boolean currentContext) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> // TODO: would it be a terrible idea to try and find the caller ClassLoader here?<a name="line.172"></a>
<span class="sourceLineNo">173</span> try {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return factory.getContext(FQCN, null, null, currentContext, null, null);<a name="line.174"></a>
<span class="sourceLineNo">175</span> } catch (final IllegalStateException ex) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.176"></a>
<span class="sourceLineNo">177</span> return new SimpleLoggerContextFactory().getContext(FQCN, null, null, currentContext, null, null);<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<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> * Returns a LoggerContext.<a name="line.182"></a>
<span class="sourceLineNo">183</span> *<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.184"></a>
<span class="sourceLineNo">185</span> * ClassLoader.<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.186"></a>
<span class="sourceLineNo">187</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.187"></a>
<span class="sourceLineNo">188</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.188"></a>
<span class="sourceLineNo">189</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.189"></a>
<span class="sourceLineNo">190</span> * @return a LoggerContext.<a name="line.190"></a>
<span class="sourceLineNo">191</span> */<a name="line.191"></a>
<span class="sourceLineNo">192</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> try {<a name="line.193"></a>
<span class="sourceLineNo">194</span> return factory.getContext(FQCN, loader, null, currentContext);<a name="line.194"></a>
<span class="sourceLineNo">195</span> } catch (final IllegalStateException ex) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.196"></a>
<span class="sourceLineNo">197</span> return new SimpleLoggerContextFactory().getContext(FQCN, loader, null, currentContext);<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> /**<a name="line.201"></a>
<span class="sourceLineNo">202</span> * Returns a LoggerContext.<a name="line.202"></a>
<span class="sourceLineNo">203</span> *<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.204"></a>
<span class="sourceLineNo">205</span> * ClassLoader.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.206"></a>
<span class="sourceLineNo">207</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.207"></a>
<span class="sourceLineNo">208</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.208"></a>
<span class="sourceLineNo">209</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.209"></a>
<span class="sourceLineNo">210</span> * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.<a name="line.210"></a>
<span class="sourceLineNo">211</span> * @return a LoggerContext.<a name="line.211"></a>
<span class="sourceLineNo">212</span> */<a name="line.212"></a>
<span class="sourceLineNo">213</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.213"></a>
<span class="sourceLineNo">214</span> final Object externalContext) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> try {<a name="line.215"></a>
<span class="sourceLineNo">216</span> return factory.getContext(FQCN, loader, externalContext, currentContext);<a name="line.216"></a>
<span class="sourceLineNo">217</span> } catch (final IllegalStateException ex) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.218"></a>
<span class="sourceLineNo">219</span> return new SimpleLoggerContextFactory().getContext(FQCN, loader, externalContext, currentContext);<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> /**<a name="line.223"></a>
<span class="sourceLineNo">224</span> * Returns a LoggerContext.<a name="line.224"></a>
<span class="sourceLineNo">225</span> *<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.226"></a>
<span class="sourceLineNo">227</span> * ClassLoader.<a name="line.227"></a>
<span class="sourceLineNo">228</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.228"></a>
<span class="sourceLineNo">229</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.229"></a>
<span class="sourceLineNo">230</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.230"></a>
<span class="sourceLineNo">231</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @param configLocation The URI for the configuration to use.<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @return a LoggerContext.<a name="line.233"></a>
<span class="sourceLineNo">234</span> */<a name="line.234"></a>
<span class="sourceLineNo">235</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.235"></a>
<span class="sourceLineNo">236</span> final URI configLocation) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> try {<a name="line.237"></a>
<span class="sourceLineNo">238</span> return factory.getContext(FQCN, loader, null, currentContext, configLocation, null);<a name="line.238"></a>
<span class="sourceLineNo">239</span> } catch (final IllegalStateException ex) {<a name="line.239"></a>
<span class="sourceLineNo">240</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.240"></a>
<span class="sourceLineNo">241</span> return new SimpleLoggerContextFactory().getContext(FQCN, loader, null, currentContext, configLocation,<a name="line.241"></a>
<span class="sourceLineNo">242</span> null);<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<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> * Returns a LoggerContext.<a name="line.247"></a>
<span class="sourceLineNo">248</span> *<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.249"></a>
<span class="sourceLineNo">250</span> * ClassLoader.<a name="line.250"></a>
<span class="sourceLineNo">251</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.251"></a>
<span class="sourceLineNo">252</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.252"></a>
<span class="sourceLineNo">253</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.253"></a>
<span class="sourceLineNo">254</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.254"></a>
<span class="sourceLineNo">255</span> * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.<a name="line.255"></a>
<span class="sourceLineNo">256</span> * @param configLocation The URI for the configuration to use.<a name="line.256"></a>
<span class="sourceLineNo">257</span> * @return a LoggerContext.<a name="line.257"></a>
<span class="sourceLineNo">258</span> */<a name="line.258"></a>
<span class="sourceLineNo">259</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.259"></a>
<span class="sourceLineNo">260</span> final Object externalContext, final URI configLocation) {<a name="line.260"></a>
<span class="sourceLineNo">261</span> try {<a name="line.261"></a>
<span class="sourceLineNo">262</span> return factory.getContext(FQCN, loader, externalContext, currentContext, configLocation, null);<a name="line.262"></a>
<span class="sourceLineNo">263</span> } catch (final IllegalStateException ex) {<a name="line.263"></a>
<span class="sourceLineNo">264</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.264"></a>
<span class="sourceLineNo">265</span> return new SimpleLoggerContextFactory().getContext(FQCN, loader, externalContext, currentContext,<a name="line.265"></a>
<span class="sourceLineNo">266</span> configLocation, null);<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<a name="line.267"></a>
<span class="sourceLineNo">268</span> }<a name="line.268"></a>
<span class="sourceLineNo">269</span><a name="line.269"></a>
<span class="sourceLineNo">270</span> /**<a name="line.270"></a>
<span class="sourceLineNo">271</span> * Returns a LoggerContext.<a name="line.271"></a>
<span class="sourceLineNo">272</span> *<a name="line.272"></a>
<span class="sourceLineNo">273</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.273"></a>
<span class="sourceLineNo">274</span> * ClassLoader.<a name="line.274"></a>
<span class="sourceLineNo">275</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.275"></a>
<span class="sourceLineNo">276</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.276"></a>
<span class="sourceLineNo">277</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.277"></a>
<span class="sourceLineNo">278</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.278"></a>
<span class="sourceLineNo">279</span> * @param externalContext An external context (such as a ServletContext) to be associated with the LoggerContext.<a name="line.279"></a>
<span class="sourceLineNo">280</span> * @param configLocation The URI for the configuration to use.<a name="line.280"></a>
<span class="sourceLineNo">281</span> * @param name The LoggerContext name.<a name="line.281"></a>
<span class="sourceLineNo">282</span> * @return a LoggerContext.<a name="line.282"></a>
<span class="sourceLineNo">283</span> */<a name="line.283"></a>
<span class="sourceLineNo">284</span> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.284"></a>
<span class="sourceLineNo">285</span> final Object externalContext, final URI configLocation, final String name) {<a name="line.285"></a>
<span class="sourceLineNo">286</span> try {<a name="line.286"></a>
<span class="sourceLineNo">287</span> return factory.getContext(FQCN, loader, externalContext, currentContext, configLocation, name);<a name="line.287"></a>
<span class="sourceLineNo">288</span> } catch (final IllegalStateException ex) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.289"></a>
<span class="sourceLineNo">290</span> return new SimpleLoggerContextFactory().getContext(FQCN, loader, externalContext, currentContext,<a name="line.290"></a>
<span class="sourceLineNo">291</span> configLocation, name);<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span> }<a name="line.293"></a>
<span class="sourceLineNo">294</span><a name="line.294"></a>
<span class="sourceLineNo">295</span> /**<a name="line.295"></a>
<span class="sourceLineNo">296</span> * Returns a LoggerContext<a name="line.296"></a>
<span class="sourceLineNo">297</span> *<a name="line.297"></a>
<span class="sourceLineNo">298</span> * @param fqcn The fully qualified class name of the Class that this method is a member of.<a name="line.298"></a>
<span class="sourceLineNo">299</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.299"></a>
<span class="sourceLineNo">300</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.300"></a>
<span class="sourceLineNo">301</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.301"></a>
<span class="sourceLineNo">302</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.302"></a>
<span class="sourceLineNo">303</span> * @return a LoggerContext.<a name="line.303"></a>
<span class="sourceLineNo">304</span> */<a name="line.304"></a>
<span class="sourceLineNo">305</span> protected static LoggerContext getContext(final String fqcn, final boolean currentContext) {<a name="line.305"></a>
<span class="sourceLineNo">306</span> try {<a name="line.306"></a>
<span class="sourceLineNo">307</span> return factory.getContext(fqcn, null, null, currentContext);<a name="line.307"></a>
<span class="sourceLineNo">308</span> } catch (final IllegalStateException ex) {<a name="line.308"></a>
<span class="sourceLineNo">309</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.309"></a>
<span class="sourceLineNo">310</span> return new SimpleLoggerContextFactory().getContext(fqcn, null, null, currentContext);<a name="line.310"></a>
<span class="sourceLineNo">311</span> }<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> * Returns a LoggerContext<a name="line.315"></a>
<span class="sourceLineNo">316</span> *<a name="line.316"></a>
<span class="sourceLineNo">317</span> * @param fqcn The fully qualified class name of the Class that this method is a member of.<a name="line.317"></a>
<span class="sourceLineNo">318</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.318"></a>
<span class="sourceLineNo">319</span> * ClassLoader.<a name="line.319"></a>
<span class="sourceLineNo">320</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.320"></a>
<span class="sourceLineNo">321</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.321"></a>
<span class="sourceLineNo">322</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.322"></a>
<span class="sourceLineNo">323</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.323"></a>
<span class="sourceLineNo">324</span> * @return a LoggerContext.<a name="line.324"></a>
<span class="sourceLineNo">325</span> */<a name="line.325"></a>
<span class="sourceLineNo">326</span> protected static LoggerContext getContext(final String fqcn, final ClassLoader loader,<a name="line.326"></a>
<span class="sourceLineNo">327</span> final boolean currentContext) {<a name="line.327"></a>
<span class="sourceLineNo">328</span> try {<a name="line.328"></a>
<span class="sourceLineNo">329</span> return factory.getContext(fqcn, loader, null, currentContext);<a name="line.329"></a>
<span class="sourceLineNo">330</span> } catch (final IllegalStateException ex) {<a name="line.330"></a>
<span class="sourceLineNo">331</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.331"></a>
<span class="sourceLineNo">332</span> return new SimpleLoggerContextFactory().getContext(fqcn, loader, null, currentContext);<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><a name="line.336"></a>
<span class="sourceLineNo">337</span> /**<a name="line.337"></a>
<span class="sourceLineNo">338</span> * Returns a LoggerContext<a name="line.338"></a>
<span class="sourceLineNo">339</span> *<a name="line.339"></a>
<span class="sourceLineNo">340</span> * @param fqcn The fully qualified class name of the Class that this method is a member of.<a name="line.340"></a>
<span class="sourceLineNo">341</span> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.341"></a>
<span class="sourceLineNo">342</span> * ClassLoader.<a name="line.342"></a>
<span class="sourceLineNo">343</span> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.343"></a>
<span class="sourceLineNo">344</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.344"></a>
<span class="sourceLineNo">345</span> * returned and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.345"></a>
<span class="sourceLineNo">346</span> * be returned. If true then only a single LoggerContext will be returned.<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param configLocation The URI for the configuration to use.<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @param name The LoggerContext name.<a name="line.348"></a>
<span class="sourceLineNo">349</span> * @return a LoggerContext.<a name="line.349"></a>
<span class="sourceLineNo">350</span> */<a name="line.350"></a>
<span class="sourceLineNo">351</span> protected static LoggerContext getContext(final String fqcn, final ClassLoader loader,<a name="line.351"></a>
<span class="sourceLineNo">352</span> final boolean currentContext, final URI configLocation, final String name) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> try {<a name="line.353"></a>
<span class="sourceLineNo">354</span> return factory.getContext(fqcn, loader, null, currentContext, configLocation, name);<a name="line.354"></a>
<span class="sourceLineNo">355</span> } catch (final IllegalStateException ex) {<a name="line.355"></a>
<span class="sourceLineNo">356</span> LOGGER.warn(ex.getMessage() + " Using SimpleLogger");<a name="line.356"></a>
<span class="sourceLineNo">357</span> return new SimpleLoggerContextFactory().getContext(fqcn, loader, null, currentContext);<a name="line.357"></a>
<span class="sourceLineNo">358</span> }<a name="line.358"></a>
<span class="sourceLineNo">359</span> }<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> /**<a name="line.361"></a>
<span class="sourceLineNo">362</span> * Shutdown using the LoggerContext appropriate for the caller of this method.<a name="line.362"></a>
<span class="sourceLineNo">363</span> * This is equivalent to calling {@code LogManager.shutdown(false)}.<a name="line.363"></a>
<span class="sourceLineNo">364</span> *<a name="line.364"></a>
<span class="sourceLineNo">365</span> * This call is synchronous and will block until shut down is complete.<a name="line.365"></a>
<span class="sourceLineNo">366</span> * This may include flushing pending log events over network connections.<a name="line.366"></a>
<span class="sourceLineNo">367</span> *<a name="line.367"></a>
<span class="sourceLineNo">368</span> * @since 2.6<a name="line.368"></a>
<span class="sourceLineNo">369</span> */<a name="line.369"></a>
<span class="sourceLineNo">370</span> public static void shutdown() {<a name="line.370"></a>
<span class="sourceLineNo">371</span> shutdown(false);<a name="line.371"></a>
<span class="sourceLineNo">372</span> }<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span> /**<a name="line.374"></a>
<span class="sourceLineNo">375</span> * Shutdown the logging system if the logging system supports it.<a name="line.375"></a>
<span class="sourceLineNo">376</span> * This is equivalent to calling {@code LogManager.shutdown(LogManager.getContext(currentContext))}.<a name="line.376"></a>
<span class="sourceLineNo">377</span> *<a name="line.377"></a>
<span class="sourceLineNo">378</span> * This call is synchronous and will block until shut down is complete.<a name="line.378"></a>
<span class="sourceLineNo">379</span> * This may include flushing pending log events over network connections.<a name="line.379"></a>
<span class="sourceLineNo">380</span> *<a name="line.380"></a>
<span class="sourceLineNo">381</span> * @param currentContext if true a default LoggerContext (may not be the LoggerContext used to create a Logger<a name="line.381"></a>
<span class="sourceLineNo">382</span> * for the calling class) will be used.<a name="line.382"></a>
<span class="sourceLineNo">383</span> * If false the LoggerContext appropriate for the caller of this method is used. For<a name="line.383"></a>
<span class="sourceLineNo">384</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.384"></a>
<span class="sourceLineNo">385</span> * used and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.385"></a>
<span class="sourceLineNo">386</span> * be used.<a name="line.386"></a>
<span class="sourceLineNo">387</span> * @since 2.6<a name="line.387"></a>
<span class="sourceLineNo">388</span> */<a name="line.388"></a>
<span class="sourceLineNo">389</span> public static void shutdown(final boolean currentContext) {<a name="line.389"></a>
<span class="sourceLineNo">390</span> factory.shutdown(FQCN, null, currentContext, false);<a name="line.390"></a>
<span class="sourceLineNo">391</span> }<a name="line.391"></a>
<span class="sourceLineNo">392</span><a name="line.392"></a>
<span class="sourceLineNo">393</span> /**<a name="line.393"></a>
<span class="sourceLineNo">394</span> * Shutdown the logging system if the logging system supports it.<a name="line.394"></a>
<span class="sourceLineNo">395</span> * This is equivalent to calling {@code LogManager.shutdown(LogManager.getContext(currentContext))}.<a name="line.395"></a>
<span class="sourceLineNo">396</span> *<a name="line.396"></a>
<span class="sourceLineNo">397</span> * This call is synchronous and will block until shut down is complete.<a name="line.397"></a>
<span class="sourceLineNo">398</span> * This may include flushing pending log events over network connections.<a name="line.398"></a>
<span class="sourceLineNo">399</span> *<a name="line.399"></a>
<span class="sourceLineNo">400</span> * @param currentContext if true a default LoggerContext (may not be the LoggerContext used to create a Logger<a name="line.400"></a>
<span class="sourceLineNo">401</span> * for the calling class) will be used.<a name="line.401"></a>
<span class="sourceLineNo">402</span> * If false the LoggerContext appropriate for the caller of this method is used. For<a name="line.402"></a>
<span class="sourceLineNo">403</span> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.403"></a>
<span class="sourceLineNo">404</span> * used and if the caller is a class in the container's classpath then a different LoggerContext may<a name="line.404"></a>
<span class="sourceLineNo">405</span> * be used.<a name="line.405"></a>
<span class="sourceLineNo">406</span> * @param allContexts if true all LoggerContexts that can be located will be shutdown.<a name="line.406"></a>
<span class="sourceLineNo">407</span> * @since 2.13.0<a name="line.407"></a>
<span class="sourceLineNo">408</span> */<a name="line.408"></a>
<span class="sourceLineNo">409</span> public static void shutdown(final boolean currentContext, final boolean allContexts) {<a name="line.409"></a>
<span class="sourceLineNo">410</span> factory.shutdown(FQCN, null, currentContext, allContexts);<a name="line.410"></a>
<span class="sourceLineNo">411</span> }<a name="line.411"></a>
<span class="sourceLineNo">412</span><a name="line.412"></a>
<span class="sourceLineNo">413</span><a name="line.413"></a>
<span class="sourceLineNo">414</span> /**<a name="line.414"></a>
<span class="sourceLineNo">415</span> * Shutdown the logging system if the logging system supports it.<a name="line.415"></a>
<span class="sourceLineNo">416</span> *<a name="line.416"></a>
<span class="sourceLineNo">417</span> * This call is synchronous and will block until shut down is complete.<a name="line.417"></a>
<span class="sourceLineNo">418</span> * This may include flushing pending log events over network connections.<a name="line.418"></a>
<span class="sourceLineNo">419</span> *<a name="line.419"></a>
<span class="sourceLineNo">420</span> * @param context the LoggerContext.<a name="line.420"></a>
<span class="sourceLineNo">421</span> * @since 2.6<a name="line.421"></a>
<span class="sourceLineNo">422</span> */<a name="line.422"></a>
<span class="sourceLineNo">423</span> public static void shutdown(final LoggerContext context) {<a name="line.423"></a>
<span class="sourceLineNo">424</span> if (context != null &amp;&amp; context instanceof Terminable) {<a name="line.424"></a>
<span class="sourceLineNo">425</span> ((Terminable) context).terminate();<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><a name="line.428"></a>
<span class="sourceLineNo">429</span> private static String toLoggerName(final Class&lt;?&gt; cls) {<a name="line.429"></a>
<span class="sourceLineNo">430</span> final String canonicalName = cls.getCanonicalName();<a name="line.430"></a>
<span class="sourceLineNo">431</span> return canonicalName != null ? canonicalName : cls.getName();<a name="line.431"></a>
<span class="sourceLineNo">432</span> }<a name="line.432"></a>
<span class="sourceLineNo">433</span><a name="line.433"></a>
<span class="sourceLineNo">434</span> /**<a name="line.434"></a>
<span class="sourceLineNo">435</span> * Returns the current LoggerContextFactory.<a name="line.435"></a>
<span class="sourceLineNo">436</span> *<a name="line.436"></a>
<span class="sourceLineNo">437</span> * @return The LoggerContextFactory.<a name="line.437"></a>
<span class="sourceLineNo">438</span> */<a name="line.438"></a>
<span class="sourceLineNo">439</span> public static LoggerContextFactory getFactory() {<a name="line.439"></a>
<span class="sourceLineNo">440</span> return factory;<a name="line.440"></a>
<span class="sourceLineNo">441</span> }<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span> /**<a name="line.443"></a>
<span class="sourceLineNo">444</span> * Sets the current LoggerContextFactory to use. Normally, the appropriate LoggerContextFactory is created at<a name="line.444"></a>
<span class="sourceLineNo">445</span> * startup, but in certain environments, a LoggerContextFactory implementation may not be available at this point.<a name="line.445"></a>
<span class="sourceLineNo">446</span> * Thus, an alternative LoggerContextFactory can be set at runtime.<a name="line.446"></a>
<span class="sourceLineNo">447</span> *<a name="line.447"></a>
<span class="sourceLineNo">448</span> * &lt;p&gt;<a name="line.448"></a>
<span class="sourceLineNo">449</span> * Note that any Logger or LoggerContext objects already created will still be valid, but they will no longer be<a name="line.449"></a>
<span class="sourceLineNo">450</span> * accessible through LogManager. Thus, &lt;strong&gt;it is a bad idea to use this method without a good reason&lt;/strong&gt;!<a name="line.450"></a>
<span class="sourceLineNo">451</span> * Generally, this method should be used only during startup before any code starts caching Logger objects.<a name="line.451"></a>
<span class="sourceLineNo">452</span> * &lt;/p&gt;<a name="line.452"></a>
<span class="sourceLineNo">453</span> *<a name="line.453"></a>
<span class="sourceLineNo">454</span> * @param factory the LoggerContextFactory to use.<a name="line.454"></a>
<span class="sourceLineNo">455</span> */<a name="line.455"></a>
<span class="sourceLineNo">456</span> // FIXME: should we allow only one update of the factory?<a name="line.456"></a>
<span class="sourceLineNo">457</span> public static void setFactory(final LoggerContextFactory factory) {<a name="line.457"></a>
<span class="sourceLineNo">458</span> LogManager.factory = factory;<a name="line.458"></a>
<span class="sourceLineNo">459</span> }<a name="line.459"></a>
<span class="sourceLineNo">460</span><a name="line.460"></a>
<span class="sourceLineNo">461</span> /**<a name="line.461"></a>
<span class="sourceLineNo">462</span> * Returns a formatter Logger using the fully qualified name of the calling Class as the Logger name.<a name="line.462"></a>
<span class="sourceLineNo">463</span> * &lt;p&gt;<a name="line.463"></a>
<span class="sourceLineNo">464</span> * This logger lets you use a {@link java.util.Formatter} string in the message to format parameters.<a name="line.464"></a>
<span class="sourceLineNo">465</span> * &lt;/p&gt;<a name="line.465"></a>
<span class="sourceLineNo">466</span> *<a name="line.466"></a>
<span class="sourceLineNo">467</span> * @return The Logger for the calling class.<a name="line.467"></a>
<span class="sourceLineNo">468</span> * @throws UnsupportedOperationException if the calling class cannot be determined.<a name="line.468"></a>
<span class="sourceLineNo">469</span> * @since 2.4<a name="line.469"></a>
<span class="sourceLineNo">470</span> */<a name="line.470"></a>
<span class="sourceLineNo">471</span> public static Logger getFormatterLogger() {<a name="line.471"></a>
<span class="sourceLineNo">472</span> return getFormatterLogger(StackLocatorUtil.getCallerClass(2));<a name="line.472"></a>
<span class="sourceLineNo">473</span> }<a name="line.473"></a>
<span class="sourceLineNo">474</span><a name="line.474"></a>
<span class="sourceLineNo">475</span> /**<a name="line.475"></a>
<span class="sourceLineNo">476</span> * Returns a formatter Logger using the fully qualified name of the Class as the Logger name.<a name="line.476"></a>
<span class="sourceLineNo">477</span> * &lt;p&gt;<a name="line.477"></a>
<span class="sourceLineNo">478</span> * This logger let you use a {@link java.util.Formatter} string in the message to format parameters.<a name="line.478"></a>
<span class="sourceLineNo">479</span> * &lt;/p&gt;<a name="line.479"></a>
<span class="sourceLineNo">480</span> * &lt;p&gt;<a name="line.480"></a>
<span class="sourceLineNo">481</span> * Short-hand for {@code getLogger(clazz, StringFormatterMessageFactory.INSTANCE)}<a name="line.481"></a>
<span class="sourceLineNo">482</span> * &lt;/p&gt;<a name="line.482"></a>
<span class="sourceLineNo">483</span> *<a name="line.483"></a>
<span class="sourceLineNo">484</span> * @param clazz The Class whose name should be used as the Logger name.<a name="line.484"></a>
<span class="sourceLineNo">485</span> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.485"></a>
<span class="sourceLineNo">486</span> * @throws UnsupportedOperationException if {@code clazz} is {@code null} and the calling class cannot be<a name="line.486"></a>
<span class="sourceLineNo">487</span> * determined.<a name="line.487"></a>
<span class="sourceLineNo">488</span> * @see Logger#fatal(Marker, String, Object...)<a name="line.488"></a>
<span class="sourceLineNo">489</span> * @see Logger#fatal(String, Object...)<a name="line.489"></a>
<span class="sourceLineNo">490</span> * @see Logger#error(Marker, String, Object...)<a name="line.490"></a>
<span class="sourceLineNo">491</span> * @see Logger#error(String, Object...)<a name="line.491"></a>
<span class="sourceLineNo">492</span> * @see Logger#warn(Marker, String, Object...)<a name="line.492"></a>
<span class="sourceLineNo">493</span> * @see Logger#warn(String, Object...)<a name="line.493"></a>
<span class="sourceLineNo">494</span> * @see Logger#info(Marker, String, Object...)<a name="line.494"></a>
<span class="sourceLineNo">495</span> * @see Logger#info(String, Object...)<a name="line.495"></a>
<span class="sourceLineNo">496</span> * @see Logger#debug(Marker, String, Object...)<a name="line.496"></a>
<span class="sourceLineNo">497</span> * @see Logger#debug(String, Object...)<a name="line.497"></a>
<span class="sourceLineNo">498</span> * @see Logger#trace(Marker, String, Object...)<a name="line.498"></a>
<span class="sourceLineNo">499</span> * @see Logger#trace(String, Object...)<a name="line.499"></a>
<span class="sourceLineNo">500</span> * @see StringFormatterMessageFactory<a name="line.500"></a>
<span class="sourceLineNo">501</span> */<a name="line.501"></a>
<span class="sourceLineNo">502</span> public static Logger getFormatterLogger(final Class&lt;?&gt; clazz) {<a name="line.502"></a>
<span class="sourceLineNo">503</span> return getLogger(clazz != null ? clazz : StackLocatorUtil.getCallerClass(2),<a name="line.503"></a>
<span class="sourceLineNo">504</span> StringFormatterMessageFactory.INSTANCE);<a name="line.504"></a>
<span class="sourceLineNo">505</span> }<a name="line.505"></a>
<span class="sourceLineNo">506</span><a name="line.506"></a>
<span class="sourceLineNo">507</span> /**<a name="line.507"></a>
<span class="sourceLineNo">508</span> * Returns a formatter Logger using the fully qualified name of the value's Class as the Logger name.<a name="line.508"></a>
<span class="sourceLineNo">509</span> * &lt;p&gt;<a name="line.509"></a>
<span class="sourceLineNo">510</span> * This logger let you use a {@link java.util.Formatter} string in the message to format parameters.<a name="line.510"></a>
<span class="sourceLineNo">511</span> * &lt;/p&gt;<a name="line.511"></a>
<span class="sourceLineNo">512</span> * &lt;p&gt;<a name="line.512"></a>
<span class="sourceLineNo">513</span> * Short-hand for {@code getLogger(value, StringFormatterMessageFactory.INSTANCE)}<a name="line.513"></a>
<span class="sourceLineNo">514</span> * &lt;/p&gt;<a name="line.514"></a>
<span class="sourceLineNo">515</span> *<a name="line.515"></a>
<span class="sourceLineNo">516</span> * @param value The value's whose class name should be used as the Logger name.<a name="line.516"></a>
<span class="sourceLineNo">517</span> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.517"></a>
<span class="sourceLineNo">518</span> * @throws UnsupportedOperationException if {@code value} is {@code null} and the calling class cannot be<a name="line.518"></a>
<span class="sourceLineNo">519</span> * determined.<a name="line.519"></a>
<span class="sourceLineNo">520</span> * @see Logger#fatal(Marker, String, Object...)<a name="line.520"></a>
<span class="sourceLineNo">521</span> * @see Logger#fatal(String, Object...)<a name="line.521"></a>
<span class="sourceLineNo">522</span> * @see Logger#error(Marker, String, Object...)<a name="line.522"></a>
<span class="sourceLineNo">523</span> * @see Logger#error(String, Object...)<a name="line.523"></a>
<span class="sourceLineNo">524</span> * @see Logger#warn(Marker, String, Object...)<a name="line.524"></a>
<span class="sourceLineNo">525</span> * @see Logger#warn(String, Object...)<a name="line.525"></a>
<span class="sourceLineNo">526</span> * @see Logger#info(Marker, String, Object...)<a name="line.526"></a>
<span class="sourceLineNo">527</span> * @see Logger#info(String, Object...)<a name="line.527"></a>
<span class="sourceLineNo">528</span> * @see Logger#debug(Marker, String, Object...)<a name="line.528"></a>
<span class="sourceLineNo">529</span> * @see Logger#debug(String, Object...)<a name="line.529"></a>
<span class="sourceLineNo">530</span> * @see Logger#trace(Marker, String, Object...)<a name="line.530"></a>
<span class="sourceLineNo">531</span> * @see Logger#trace(String, Object...)<a name="line.531"></a>
<span class="sourceLineNo">532</span> * @see StringFormatterMessageFactory<a name="line.532"></a>
<span class="sourceLineNo">533</span> */<a name="line.533"></a>
<span class="sourceLineNo">534</span> public static Logger getFormatterLogger(final Object value) {<a name="line.534"></a>
<span class="sourceLineNo">535</span> return getLogger(value != null ? value.getClass() : StackLocatorUtil.getCallerClass(2),<a name="line.535"></a>
<span class="sourceLineNo">536</span> StringFormatterMessageFactory.INSTANCE);<a name="line.536"></a>
<span class="sourceLineNo">537</span> }<a name="line.537"></a>
<span class="sourceLineNo">538</span><a name="line.538"></a>
<span class="sourceLineNo">539</span> /**<a name="line.539"></a>
<span class="sourceLineNo">540</span> * Returns a formatter Logger with the specified name.<a name="line.540"></a>
<span class="sourceLineNo">541</span> * &lt;p&gt;<a name="line.541"></a>
<span class="sourceLineNo">542</span> * This logger let you use a {@link java.util.Formatter} string in the message to format parameters.<a name="line.542"></a>
<span class="sourceLineNo">543</span> * &lt;/p&gt;<a name="line.543"></a>
<span class="sourceLineNo">544</span> * &lt;p&gt;<a name="line.544"></a>
<span class="sourceLineNo">545</span> * Short-hand for {@code getLogger(name, StringFormatterMessageFactory.INSTANCE)}<a name="line.545"></a>
<span class="sourceLineNo">546</span> * &lt;/p&gt;<a name="line.546"></a>
<span class="sourceLineNo">547</span> *<a name="line.547"></a>
<span class="sourceLineNo">548</span> * @param name The logger name. If null it will default to the name of the calling class.<a name="line.548"></a>
<span class="sourceLineNo">549</span> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.549"></a>
<span class="sourceLineNo">550</span> * @throws UnsupportedOperationException if {@code name} is {@code null} and the calling class cannot be determined.<a name="line.550"></a>
<span class="sourceLineNo">551</span> * @see Logger#fatal(Marker, String, Object...)<a name="line.551"></a>
<span class="sourceLineNo">552</span> * @see Logger#fatal(String, Object...)<a name="line.552"></a>
<span class="sourceLineNo">553</span> * @see Logger#error(Marker, String, Object...)<a name="line.553"></a>
<span class="sourceLineNo">554</span> * @see Logger#error(String, Object...)<a name="line.554"></a>
<span class="sourceLineNo">555</span> * @see Logger#warn(Marker, String, Object...)<a name="line.555"></a>
<span class="sourceLineNo">556</span> * @see Logger#warn(String, Object...)<a name="line.556"></a>
<span class="sourceLineNo">557</span> * @see Logger#info(Marker, String, Object...)<a name="line.557"></a>
<span class="sourceLineNo">558</span> * @see Logger#info(String, Object...)<a name="line.558"></a>
<span class="sourceLineNo">559</span> * @see Logger#debug(Marker, String, Object...)<a name="line.559"></a>
<span class="sourceLineNo">560</span> * @see Logger#debug(String, Object...)<a name="line.560"></a>
<span class="sourceLineNo">561</span> * @see Logger#trace(Marker, String, Object...)<a name="line.561"></a>
<span class="sourceLineNo">562</span> * @see Logger#trace(String, Object...)<a name="line.562"></a>
<span class="sourceLineNo">563</span> * @see StringFormatterMessageFactory<a name="line.563"></a>
<span class="sourceLineNo">564</span> */<a name="line.564"></a>
<span class="sourceLineNo">565</span> public static Logger getFormatterLogger(final String name) {<a name="line.565"></a>
<span class="sourceLineNo">566</span> return name == null ? getFormatterLogger(StackLocatorUtil.getCallerClass(2)) : getLogger(name,<a name="line.566"></a>
<span class="sourceLineNo">567</span> StringFormatterMessageFactory.INSTANCE);<a name="line.567"></a>
<span class="sourceLineNo">568</span> }<a name="line.568"></a>
<span class="sourceLineNo">569</span><a name="line.569"></a>
<span class="sourceLineNo">570</span> private static Class&lt;?&gt; callerClass(final Class&lt;?&gt; clazz) {<a name="line.570"></a>
<span class="sourceLineNo">571</span> if (clazz != null) {<a name="line.571"></a>
<span class="sourceLineNo">572</span> return clazz;<a name="line.572"></a>
<span class="sourceLineNo">573</span> }<a name="line.573"></a>
<span class="sourceLineNo">574</span> final Class&lt;?&gt; candidate = StackLocatorUtil.getCallerClass(3);<a name="line.574"></a>
<span class="sourceLineNo">575</span> if (candidate == null) {<a name="line.575"></a>
<span class="sourceLineNo">576</span> throw new UnsupportedOperationException("No class provided, and an appropriate one cannot be found.");<a name="line.576"></a>
<span class="sourceLineNo">577</span> }<a name="line.577"></a>
<span class="sourceLineNo">578</span> return candidate;<a name="line.578"></a>
<span class="sourceLineNo">579</span> }<a name="line.579"></a>
<span class="sourceLineNo">580</span><a name="line.580"></a>
<span class="sourceLineNo">581</span> /**<a name="line.581"></a>
<span class="sourceLineNo">582</span> * Returns a Logger with the name of the calling class.<a name="line.582"></a>
<span class="sourceLineNo">583</span> *<a name="line.583"></a>
<span class="sourceLineNo">584</span> * @return The Logger for the calling class.<a name="line.584"></a>
<span class="sourceLineNo">585</span> * @throws UnsupportedOperationException if the calling class cannot be determined.<a name="line.585"></a>
<span class="sourceLineNo">586</span> */<a name="line.586"></a>
<span class="sourceLineNo">587</span> public static Logger getLogger() {<a name="line.587"></a>
<span class="sourceLineNo">588</span> return getLogger(StackLocatorUtil.getCallerClass(2));<a name="line.588"></a>
<span class="sourceLineNo">589</span> }<a name="line.589"></a>
<span class="sourceLineNo">590</span><a name="line.590"></a>
<span class="sourceLineNo">591</span> /**<a name="line.591"></a>
<span class="sourceLineNo">592</span> * Returns a Logger using the fully qualified name of the Class as the Logger name.<a name="line.592"></a>
<span class="sourceLineNo">593</span> *<a name="line.593"></a>
<span class="sourceLineNo">594</span> * @param clazz The Class whose name should be used as the Logger name. If null it will default to the calling<a name="line.594"></a>
<span class="sourceLineNo">595</span> * class.<a name="line.595"></a>
<span class="sourceLineNo">596</span> * @return The Logger.<a name="line.596"></a>
<span class="sourceLineNo">597</span> * @throws UnsupportedOperationException if {@code clazz} is {@code null} and the calling class cannot be<a name="line.597"></a>
<span class="sourceLineNo">598</span> * determined.<a name="line.598"></a>
<span class="sourceLineNo">599</span> */<a name="line.599"></a>
<span class="sourceLineNo">600</span> public static Logger getLogger(final Class&lt;?&gt; clazz) {<a name="line.600"></a>
<span class="sourceLineNo">601</span> final Class&lt;?&gt; cls = callerClass(clazz);<a name="line.601"></a>
<span class="sourceLineNo">602</span> return getContext(cls.getClassLoader(), false).getLogger(toLoggerName(cls));<a name="line.602"></a>
<span class="sourceLineNo">603</span> }<a name="line.603"></a>
<span class="sourceLineNo">604</span><a name="line.604"></a>
<span class="sourceLineNo">605</span> /**<a name="line.605"></a>
<span class="sourceLineNo">606</span> * Returns a Logger using the fully qualified name of the Class as the Logger name.<a name="line.606"></a>
<span class="sourceLineNo">607</span> *<a name="line.607"></a>
<span class="sourceLineNo">608</span> * @param clazz The Class whose name should be used as the Logger name. If null it will default to the calling<a name="line.608"></a>
<span class="sourceLineNo">609</span> * class.<a name="line.609"></a>
<span class="sourceLineNo">610</span> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change the<a name="line.610"></a>
<span class="sourceLineNo">611</span> * logger but will log a warning if mismatched.<a name="line.611"></a>
<span class="sourceLineNo">612</span> * @return The Logger.<a name="line.612"></a>
<span class="sourceLineNo">613</span> * @throws UnsupportedOperationException if {@code clazz} is {@code null} and the calling class cannot be<a name="line.613"></a>
<span class="sourceLineNo">614</span> * determined.<a name="line.614"></a>
<span class="sourceLineNo">615</span> */<a name="line.615"></a>
<span class="sourceLineNo">616</span> public static Logger getLogger(final Class&lt;?&gt; clazz, final MessageFactory messageFactory) {<a name="line.616"></a>
<span class="sourceLineNo">617</span> final Class&lt;?&gt; cls = callerClass(clazz);<a name="line.617"></a>
<span class="sourceLineNo">618</span> return getContext(cls.getClassLoader(), false).getLogger(toLoggerName(cls), messageFactory);<a name="line.618"></a>
<span class="sourceLineNo">619</span> }<a name="line.619"></a>
<span class="sourceLineNo">620</span><a name="line.620"></a>
<span class="sourceLineNo">621</span> /**<a name="line.621"></a>
<span class="sourceLineNo">622</span> * Returns a Logger with the name of the calling class.<a name="line.622"></a>
<span class="sourceLineNo">623</span> *<a name="line.623"></a>
<span class="sourceLineNo">624</span> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change the<a name="line.624"></a>
<span class="sourceLineNo">625</span> * logger but will log a warning if mismatched.<a name="line.625"></a>
<span class="sourceLineNo">626</span> * @return The Logger for the calling class.<a name="line.626"></a>
<span class="sourceLineNo">627</span> * @throws UnsupportedOperationException if the calling class cannot be determined.<a name="line.627"></a>
<span class="sourceLineNo">628</span> */<a name="line.628"></a>
<span class="sourceLineNo">629</span> public static Logger getLogger(final MessageFactory messageFactory) {<a name="line.629"></a>
<span class="sourceLineNo">630</span> return getLogger(StackLocatorUtil.getCallerClass(2), messageFactory);<a name="line.630"></a>
<span class="sourceLineNo">631</span> }<a name="line.631"></a>
<span class="sourceLineNo">632</span><a name="line.632"></a>
<span class="sourceLineNo">633</span> /**<a name="line.633"></a>
<span class="sourceLineNo">634</span> * Returns a Logger using the fully qualified class name of the value as the Logger name.<a name="line.634"></a>
<span class="sourceLineNo">635</span> *<a name="line.635"></a>
<span class="sourceLineNo">636</span> * @param value The value whose class name should be used as the Logger name. If null the name of the calling class<a name="line.636"></a>
<span class="sourceLineNo">637</span> * will be used as the logger name.<a name="line.637"></a>
<span class="sourceLineNo">638</span> * @return The Logger.<a name="line.638"></a>
<span class="sourceLineNo">639</span> * @throws UnsupportedOperationException if {@code value} is {@code null} and the calling class cannot be<a name="line.639"></a>
<span class="sourceLineNo">640</span> * determined.<a name="line.640"></a>
<span class="sourceLineNo">641</span> */<a name="line.641"></a>
<span class="sourceLineNo">642</span> public static Logger getLogger(final Object value) {<a name="line.642"></a>
<span class="sourceLineNo">643</span> return getLogger(value != null ? value.getClass() : StackLocatorUtil.getCallerClass(2));<a name="line.643"></a>
<span class="sourceLineNo">644</span> }<a name="line.644"></a>
<span class="sourceLineNo">645</span><a name="line.645"></a>
<span class="sourceLineNo">646</span> /**<a name="line.646"></a>
<span class="sourceLineNo">647</span> * Returns a Logger using the fully qualified class name of the value as the Logger name.<a name="line.647"></a>
<span class="sourceLineNo">648</span> *<a name="line.648"></a>
<span class="sourceLineNo">649</span> * @param value The value whose class name should be used as the Logger name. If null the name of the calling class<a name="line.649"></a>
<span class="sourceLineNo">650</span> * will be used as the logger name.<a name="line.650"></a>
<span class="sourceLineNo">651</span> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change the<a name="line.651"></a>
<span class="sourceLineNo">652</span> * logger but will log a warning if mismatched.<a name="line.652"></a>
<span class="sourceLineNo">653</span> * @return The Logger.<a name="line.653"></a>
<span class="sourceLineNo">654</span> * @throws UnsupportedOperationException if {@code value} is {@code null} and the calling class cannot be<a name="line.654"></a>
<span class="sourceLineNo">655</span> * determined.<a name="line.655"></a>
<span class="sourceLineNo">656</span> */<a name="line.656"></a>
<span class="sourceLineNo">657</span> public static Logger getLogger(final Object value, final MessageFactory messageFactory) {<a name="line.657"></a>
<span class="sourceLineNo">658</span> return getLogger(value != null ? value.getClass() : StackLocatorUtil.getCallerClass(2), messageFactory);<a name="line.658"></a>
<span class="sourceLineNo">659</span> }<a name="line.659"></a>
<span class="sourceLineNo">660</span><a name="line.660"></a>
<span class="sourceLineNo">661</span> /**<a name="line.661"></a>
<span class="sourceLineNo">662</span> * Returns a Logger with the specified name.<a name="line.662"></a>
<span class="sourceLineNo">663</span> *<a name="line.663"></a>
<span class="sourceLineNo">664</span> * @param name The logger name. If null the name of the calling class will be used.<a name="line.664"></a>
<span class="sourceLineNo">665</span> * @return The Logger.<a name="line.665"></a>
<span class="sourceLineNo">666</span> * @throws UnsupportedOperationException if {@code name} is {@code null} and the calling class cannot be determined.<a name="line.666"></a>
<span class="sourceLineNo">667</span> */<a name="line.667"></a>
<span class="sourceLineNo">668</span> public static Logger getLogger(final String name) {<a name="line.668"></a>
<span class="sourceLineNo">669</span> return name != null ? getContext(false).getLogger(name) : getLogger(StackLocatorUtil.getCallerClass(2));<a name="line.669"></a>
<span class="sourceLineNo">670</span> }<a name="line.670"></a>
<span class="sourceLineNo">671</span><a name="line.671"></a>
<span class="sourceLineNo">672</span> /**<a name="line.672"></a>
<span class="sourceLineNo">673</span> * Returns a Logger with the specified name.<a name="line.673"></a>
<span class="sourceLineNo">674</span> *<a name="line.674"></a>
<span class="sourceLineNo">675</span> * @param name The logger name. If null the name of the calling class will be used.<a name="line.675"></a>
<span class="sourceLineNo">676</span> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change the<a name="line.676"></a>
<span class="sourceLineNo">677</span> * logger but will log a warning if mismatched.<a name="line.677"></a>
<span class="sourceLineNo">678</span> * @return The Logger.<a name="line.678"></a>
<span class="sourceLineNo">679</span> * @throws UnsupportedOperationException if {@code name} is {@code null} and the calling class cannot be determined.<a name="line.679"></a>
<span class="sourceLineNo">680</span> */<a name="line.680"></a>
<span class="sourceLineNo">681</span> public static Logger getLogger(final String name, final MessageFactory messageFactory) {<a name="line.681"></a>
<span class="sourceLineNo">682</span> return name != null ? getContext(false).getLogger(name, messageFactory) : getLogger(<a name="line.682"></a>
<span class="sourceLineNo">683</span> StackLocatorUtil.getCallerClass(2), messageFactory);<a name="line.683"></a>
<span class="sourceLineNo">684</span> }<a name="line.684"></a>
<span class="sourceLineNo">685</span><a name="line.685"></a>
<span class="sourceLineNo">686</span> /**<a name="line.686"></a>
<span class="sourceLineNo">687</span> * Returns a Logger with the specified name.<a name="line.687"></a>
<span class="sourceLineNo">688</span> *<a name="line.688"></a>
<span class="sourceLineNo">689</span> * @param fqcn The fully qualified class name of the class that this method is a member of.<a name="line.689"></a>
<span class="sourceLineNo">690</span> * @param name The logger name.<a name="line.690"></a>
<span class="sourceLineNo">691</span> * @return The Logger.<a name="line.691"></a>
<span class="sourceLineNo">692</span> */<a name="line.692"></a>
<span class="sourceLineNo">693</span> protected static Logger getLogger(final String fqcn, final String name) {<a name="line.693"></a>
<span class="sourceLineNo">694</span> return factory.getContext(fqcn, null, null, false).getLogger(name);<a name="line.694"></a>
<span class="sourceLineNo">695</span> }<a name="line.695"></a>
<span class="sourceLineNo">696</span><a name="line.696"></a>
<span class="sourceLineNo">697</span> /**<a name="line.697"></a>
<span class="sourceLineNo">698</span> * Returns the root logger.<a name="line.698"></a>
<span class="sourceLineNo">699</span> *<a name="line.699"></a>
<span class="sourceLineNo">700</span> * @return the root logger, named {@link #ROOT_LOGGER_NAME}.<a name="line.700"></a>
<span class="sourceLineNo">701</span> */<a name="line.701"></a>
<span class="sourceLineNo">702</span> public static Logger getRootLogger() {<a name="line.702"></a>
<span class="sourceLineNo">703</span> return getLogger(ROOT_LOGGER_NAME);<a name="line.703"></a>
<span class="sourceLineNo">704</span> }<a name="line.704"></a>
<span class="sourceLineNo">705</span>}<a name="line.705"></a>
</pre>
</div>
</body>
</html>