blob: a766196f08a0cbe2457bfe36ed8f3b93b5eb6628 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.net.URI;<a name="line.19"></a>
<FONT color="green">020</FONT> import java.util.Formatter;<a name="line.20"></a>
<FONT color="green">021</FONT> import java.util.Iterator;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.Map;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.SortedMap;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.TreeMap;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.logging.log4j.message.MessageFactory;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.logging.log4j.message.StringFormatterMessageFactory;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.logging.log4j.simple.SimpleLoggerContextFactory;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.logging.log4j.spi.LoggerContext;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.logging.log4j.spi.Provider;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.logging.log4j.status.StatusLogger;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.logging.log4j.util.ProviderUtil;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * The anchor point for the logging system.<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public class LogManager {<a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * The name of the root Logger.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> public static final String ROOT_LOGGER_NAME = "";<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> private static final String FACTORY_PROPERTY_NAME = "log4j2.loggerContextFactory";<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> private static LoggerContextFactory factory;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Scans the classpath to find all logging implementation. Currently, only one will<a name="line.52"></a>
<FONT color="green">053</FONT> * be used but this could be extended to allow multiple implementations to be used.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> static {<a name="line.55"></a>
<FONT color="green">056</FONT> // Shortcut binding to force a specific logging implementation.<a name="line.56"></a>
<FONT color="green">057</FONT> final PropertiesUtil managerProps = PropertiesUtil.getProperties();<a name="line.57"></a>
<FONT color="green">058</FONT> final String factoryClass = managerProps.getStringProperty(FACTORY_PROPERTY_NAME);<a name="line.58"></a>
<FONT color="green">059</FONT> final ClassLoader cl = ProviderUtil.findClassLoader();<a name="line.59"></a>
<FONT color="green">060</FONT> if (factoryClass != null) {<a name="line.60"></a>
<FONT color="green">061</FONT> try {<a name="line.61"></a>
<FONT color="green">062</FONT> final Class&lt;?&gt; clazz = cl.loadClass(factoryClass);<a name="line.62"></a>
<FONT color="green">063</FONT> if (LoggerContextFactory.class.isAssignableFrom(clazz)) {<a name="line.63"></a>
<FONT color="green">064</FONT> factory = (LoggerContextFactory) clazz.newInstance();<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> } catch (final ClassNotFoundException cnfe) {<a name="line.66"></a>
<FONT color="green">067</FONT> LOGGER.error("Unable to locate configured LoggerContextFactory {}", factoryClass);<a name="line.67"></a>
<FONT color="green">068</FONT> } catch (final Exception ex) {<a name="line.68"></a>
<FONT color="green">069</FONT> LOGGER.error("Unable to create configured LoggerContextFactory {}", factoryClass, ex);<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> if (factory == null) {<a name="line.73"></a>
<FONT color="green">074</FONT> final SortedMap&lt;Integer, LoggerContextFactory&gt; factories = new TreeMap&lt;Integer, LoggerContextFactory&gt;();<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> if (ProviderUtil.hasProviders()) {<a name="line.76"></a>
<FONT color="green">077</FONT> final Iterator&lt;Provider&gt; providers = ProviderUtil.getProviders();<a name="line.77"></a>
<FONT color="green">078</FONT> while (providers.hasNext()) {<a name="line.78"></a>
<FONT color="green">079</FONT> final Provider provider = providers.next();<a name="line.79"></a>
<FONT color="green">080</FONT> final String className = provider.getClassName();<a name="line.80"></a>
<FONT color="green">081</FONT> if (className != null) {<a name="line.81"></a>
<FONT color="green">082</FONT> try {<a name="line.82"></a>
<FONT color="green">083</FONT> final Class&lt;?&gt; clazz = cl.loadClass(className);<a name="line.83"></a>
<FONT color="green">084</FONT> if (LoggerContextFactory.class.isAssignableFrom(clazz)) {<a name="line.84"></a>
<FONT color="green">085</FONT> factories.put(provider.getPriority(), (LoggerContextFactory) clazz.newInstance());<a name="line.85"></a>
<FONT color="green">086</FONT> } else {<a name="line.86"></a>
<FONT color="green">087</FONT> LOGGER.error(className + " does not implement " + LoggerContextFactory.class.getName());<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> } catch (final ClassNotFoundException cnfe) {<a name="line.89"></a>
<FONT color="green">090</FONT> LOGGER.error("Unable to locate class " + className + " specified in " +<a name="line.90"></a>
<FONT color="green">091</FONT> provider.getURL().toString(), cnfe);<a name="line.91"></a>
<FONT color="green">092</FONT> } catch (final IllegalAccessException iae) {<a name="line.92"></a>
<FONT color="green">093</FONT> LOGGER.error("Unable to create class " + className + " specified in " +<a name="line.93"></a>
<FONT color="green">094</FONT> provider.getURL().toString(), iae);<a name="line.94"></a>
<FONT color="green">095</FONT> } catch (final Exception e) {<a name="line.95"></a>
<FONT color="green">096</FONT> LOGGER.error("Unable to create class " + className + " specified in " +<a name="line.96"></a>
<FONT color="green">097</FONT> provider.getURL().toString(), e);<a name="line.97"></a>
<FONT color="green">098</FONT> e.printStackTrace();<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> if (factories.size() == 0) {<a name="line.103"></a>
<FONT color="green">104</FONT> LOGGER.error("Unable to locate a logging implementation, using SimpleLogger");<a name="line.104"></a>
<FONT color="green">105</FONT> factory = new SimpleLoggerContextFactory();<a name="line.105"></a>
<FONT color="green">106</FONT> } else {<a name="line.106"></a>
<FONT color="green">107</FONT> final StringBuilder sb = new StringBuilder("Multiple logging implementations found: \n");<a name="line.107"></a>
<FONT color="green">108</FONT> for (final Map.Entry&lt;Integer, LoggerContextFactory&gt; entry : factories.entrySet()) {<a name="line.108"></a>
<FONT color="green">109</FONT> sb.append("Factory: ").append(entry.getValue().getClass().getName());<a name="line.109"></a>
<FONT color="green">110</FONT> sb.append(", Weighting: ").append(entry.getKey()).append("\n");<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> factory = factories.get(factories.lastKey());<a name="line.112"></a>
<FONT color="green">113</FONT> sb.append("Using factory: ").append(factory.getClass().getName());<a name="line.113"></a>
<FONT color="green">114</FONT> LOGGER.warn(sb.toString());<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> } else {<a name="line.117"></a>
<FONT color="green">118</FONT> LOGGER.error("Unable to locate a logging implementation, using SimpleLogger");<a name="line.118"></a>
<FONT color="green">119</FONT> factory = new SimpleLoggerContextFactory();<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> <a name="line.123"></a>
<FONT color="green">124</FONT> /**<a name="line.124"></a>
<FONT color="green">125</FONT> * Prevents instantiation<a name="line.125"></a>
<FONT color="green">126</FONT> */<a name="line.126"></a>
<FONT color="green">127</FONT> protected LogManager() {<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> /**<a name="line.130"></a>
<FONT color="green">131</FONT> * Returns the current LoggerContext.<a name="line.131"></a>
<FONT color="green">132</FONT> * &lt;p&gt;<a name="line.132"></a>
<FONT color="green">133</FONT> * WARNING - The LoggerContext returned by this method may not be the LoggerContext used to create a Logger<a name="line.133"></a>
<FONT color="green">134</FONT> * for the calling class.<a name="line.134"></a>
<FONT color="green">135</FONT> * @return The current LoggerContext.<a name="line.135"></a>
<FONT color="green">136</FONT> */<a name="line.136"></a>
<FONT color="green">137</FONT> public static LoggerContext getContext() {<a name="line.137"></a>
<FONT color="green">138</FONT> return factory.getContext(LogManager.class.getName(), null, true);<a name="line.138"></a>
<FONT color="green">139</FONT> }<a name="line.139"></a>
<FONT color="green">140</FONT> <a name="line.140"></a>
<FONT color="green">141</FONT> /**<a name="line.141"></a>
<FONT color="green">142</FONT> * Returns a LoggerContext.<a name="line.142"></a>
<FONT color="green">143</FONT> *<a name="line.143"></a>
<FONT color="green">144</FONT> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.144"></a>
<FONT color="green">145</FONT> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.145"></a>
<FONT color="green">146</FONT> * returned and if the caller is a class in the container's classpath then a different LoggerContext may be<a name="line.146"></a>
<FONT color="green">147</FONT> * returned. If true then only a single LoggerContext will be returned.<a name="line.147"></a>
<FONT color="green">148</FONT> * @return a LoggerContext.<a name="line.148"></a>
<FONT color="green">149</FONT> */<a name="line.149"></a>
<FONT color="green">150</FONT> public static LoggerContext getContext(final boolean currentContext) {<a name="line.150"></a>
<FONT color="green">151</FONT> return factory.getContext(LogManager.class.getName(), null, currentContext);<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> /**<a name="line.154"></a>
<FONT color="green">155</FONT> * Returns a LoggerContext.<a name="line.155"></a>
<FONT color="green">156</FONT> *<a name="line.156"></a>
<FONT color="green">157</FONT> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.157"></a>
<FONT color="green">158</FONT> * ClassLoader.<a name="line.158"></a>
<FONT color="green">159</FONT> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.159"></a>
<FONT color="green">160</FONT> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.160"></a>
<FONT color="green">161</FONT> * returned and if the caller is a class in the container's classpath then a different LoggerContext may be<a name="line.161"></a>
<FONT color="green">162</FONT> * returned. If true then only a single LoggerContext will be returned.<a name="line.162"></a>
<FONT color="green">163</FONT> * @return a LoggerContext.<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext) {<a name="line.165"></a>
<FONT color="green">166</FONT> return factory.getContext(LogManager.class.getName(), loader, currentContext);<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> /**<a name="line.169"></a>
<FONT color="green">170</FONT> * Returns a LoggerContext.<a name="line.170"></a>
<FONT color="green">171</FONT> *<a name="line.171"></a>
<FONT color="green">172</FONT> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.172"></a>
<FONT color="green">173</FONT> * ClassLoader.<a name="line.173"></a>
<FONT color="green">174</FONT> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.174"></a>
<FONT color="green">175</FONT> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.175"></a>
<FONT color="green">176</FONT> * returned and if the caller is a class in the container's classpath then a different LoggerContext may be<a name="line.176"></a>
<FONT color="green">177</FONT> * returned. If true then only a single LoggerContext will be returned.<a name="line.177"></a>
<FONT color="green">178</FONT> * @param configLocation The URI for the configuration to use.<a name="line.178"></a>
<FONT color="green">179</FONT> * @return a LoggerContext.<a name="line.179"></a>
<FONT color="green">180</FONT> */<a name="line.180"></a>
<FONT color="green">181</FONT> public static LoggerContext getContext(final ClassLoader loader, final boolean currentContext,<a name="line.181"></a>
<FONT color="green">182</FONT> URI configLocation) {<a name="line.182"></a>
<FONT color="green">183</FONT> return factory.getContext(LogManager.class.getName(), loader, currentContext, configLocation);<a name="line.183"></a>
<FONT color="green">184</FONT> }<a name="line.184"></a>
<FONT color="green">185</FONT> <a name="line.185"></a>
<FONT color="green">186</FONT> /**<a name="line.186"></a>
<FONT color="green">187</FONT> * Returns a LoggerContext<a name="line.187"></a>
<FONT color="green">188</FONT> * @param fqcn The fully qualified class name of the Class that this method is a member of.<a name="line.188"></a>
<FONT color="green">189</FONT> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.189"></a>
<FONT color="green">190</FONT> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.190"></a>
<FONT color="green">191</FONT> * returned and if the caller is a class in the container's classpath then a different LoggerContext may be<a name="line.191"></a>
<FONT color="green">192</FONT> * returned. If true then only a single LoggerContext will be returned.<a name="line.192"></a>
<FONT color="green">193</FONT> * @return a LoggerContext.<a name="line.193"></a>
<FONT color="green">194</FONT> */<a name="line.194"></a>
<FONT color="green">195</FONT> protected static LoggerContext getContext(final String fqcn, final boolean currentContext) {<a name="line.195"></a>
<FONT color="green">196</FONT> return factory.getContext(fqcn, null, currentContext);<a name="line.196"></a>
<FONT color="green">197</FONT> }<a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> /**<a name="line.199"></a>
<FONT color="green">200</FONT> * Returns a LoggerContext<a name="line.200"></a>
<FONT color="green">201</FONT> * @param fqcn The fully qualified class name of the Class that this method is a member of.<a name="line.201"></a>
<FONT color="green">202</FONT> * @param loader The ClassLoader for the context. If null the context will attempt to determine the appropriate<a name="line.202"></a>
<FONT color="green">203</FONT> * ClassLoader.<a name="line.203"></a>
<FONT color="green">204</FONT> * @param currentContext if false the LoggerContext appropriate for the caller of this method is returned. For<a name="line.204"></a>
<FONT color="green">205</FONT> * example, in a web application if the caller is a class in WEB-INF/lib then one LoggerContext may be<a name="line.205"></a>
<FONT color="green">206</FONT> * returned and if the caller is a class in the container's classpath then a different LoggerContext may be<a name="line.206"></a>
<FONT color="green">207</FONT> * returned. If true then only a single LoggerContext will be returned.<a name="line.207"></a>
<FONT color="green">208</FONT> * @return a LoggerContext.<a name="line.208"></a>
<FONT color="green">209</FONT> */<a name="line.209"></a>
<FONT color="green">210</FONT> protected static LoggerContext getContext(final String fqcn, final ClassLoader loader,<a name="line.210"></a>
<FONT color="green">211</FONT> final boolean currentContext) {<a name="line.211"></a>
<FONT color="green">212</FONT> return factory.getContext(fqcn, loader, currentContext);<a name="line.212"></a>
<FONT color="green">213</FONT> }<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> /**<a name="line.215"></a>
<FONT color="green">216</FONT> * Returns the LoggerContextFactory.<a name="line.216"></a>
<FONT color="green">217</FONT> * @return The LoggerContextFactory.<a name="line.217"></a>
<FONT color="green">218</FONT> */<a name="line.218"></a>
<FONT color="green">219</FONT> public static LoggerContextFactory getFactory() {<a name="line.219"></a>
<FONT color="green">220</FONT> return factory;<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> <a name="line.222"></a>
<FONT color="green">223</FONT> /**<a name="line.223"></a>
<FONT color="green">224</FONT> * Returns a formatter Logger using the fully qualified name of the Class as the Logger name.<a name="line.224"></a>
<FONT color="green">225</FONT> * &lt;p&gt;<a name="line.225"></a>
<FONT color="green">226</FONT> * This logger let you use a {@link Formatter} string in the message to format parameters.<a name="line.226"></a>
<FONT color="green">227</FONT> * &lt;/p&gt;<a name="line.227"></a>
<FONT color="green">228</FONT> * &lt;p&gt;<a name="line.228"></a>
<FONT color="green">229</FONT> * Short-hand for {@code getLogger(clazz, StringFormatterMessageFactory.INSTANCE)}<a name="line.229"></a>
<FONT color="green">230</FONT> * &lt;/p&gt;<a name="line.230"></a>
<FONT color="green">231</FONT> *<a name="line.231"></a>
<FONT color="green">232</FONT> * @param clazz<a name="line.232"></a>
<FONT color="green">233</FONT> * The Class whose name should be used as the Logger name.<a name="line.233"></a>
<FONT color="green">234</FONT> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.234"></a>
<FONT color="green">235</FONT> * @see Logger#fatal(Marker, String, Object...)<a name="line.235"></a>
<FONT color="green">236</FONT> * @see Logger#fatal(String, Object...)<a name="line.236"></a>
<FONT color="green">237</FONT> * @see Logger#error(Marker, String, Object...)<a name="line.237"></a>
<FONT color="green">238</FONT> * @see Logger#error(String, Object...)<a name="line.238"></a>
<FONT color="green">239</FONT> * @see Logger#warn(Marker, String, Object...)<a name="line.239"></a>
<FONT color="green">240</FONT> * @see Logger#warn(String, Object...)<a name="line.240"></a>
<FONT color="green">241</FONT> * @see Logger#info(Marker, String, Object...)<a name="line.241"></a>
<FONT color="green">242</FONT> * @see Logger#info(String, Object...)<a name="line.242"></a>
<FONT color="green">243</FONT> * @see Logger#debug(Marker, String, Object...)<a name="line.243"></a>
<FONT color="green">244</FONT> * @see Logger#debug(String, Object...)<a name="line.244"></a>
<FONT color="green">245</FONT> * @see Logger#trace(Marker, String, Object...)<a name="line.245"></a>
<FONT color="green">246</FONT> * @see Logger#trace(String, Object...)<a name="line.246"></a>
<FONT color="green">247</FONT> * @see StringFormatterMessageFactory<a name="line.247"></a>
<FONT color="green">248</FONT> */<a name="line.248"></a>
<FONT color="green">249</FONT> public static Logger getFormatterLogger(final Class&lt;?&gt; clazz) {<a name="line.249"></a>
<FONT color="green">250</FONT> return getLogger(clazz, StringFormatterMessageFactory.INSTANCE);<a name="line.250"></a>
<FONT color="green">251</FONT> }<a name="line.251"></a>
<FONT color="green">252</FONT> <a name="line.252"></a>
<FONT color="green">253</FONT> /**<a name="line.253"></a>
<FONT color="green">254</FONT> * Returns a formatter Logger using the fully qualified name of the value's Class as the Logger name.<a name="line.254"></a>
<FONT color="green">255</FONT> * &lt;p&gt;<a name="line.255"></a>
<FONT color="green">256</FONT> * This logger let you use a {@link Formatter} string in the message to format parameters.<a name="line.256"></a>
<FONT color="green">257</FONT> * &lt;/p&gt;<a name="line.257"></a>
<FONT color="green">258</FONT> * &lt;p&gt;<a name="line.258"></a>
<FONT color="green">259</FONT> * Short-hand for {@code getLogger(value, StringFormatterMessageFactory.INSTANCE)}<a name="line.259"></a>
<FONT color="green">260</FONT> * &lt;/p&gt;<a name="line.260"></a>
<FONT color="green">261</FONT> *<a name="line.261"></a>
<FONT color="green">262</FONT> * @param value<a name="line.262"></a>
<FONT color="green">263</FONT> * The value's whose class name should be used as the Logger name.<a name="line.263"></a>
<FONT color="green">264</FONT> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.264"></a>
<FONT color="green">265</FONT> * @see Logger#fatal(Marker, String, Object...)<a name="line.265"></a>
<FONT color="green">266</FONT> * @see Logger#fatal(String, Object...)<a name="line.266"></a>
<FONT color="green">267</FONT> * @see Logger#error(Marker, String, Object...)<a name="line.267"></a>
<FONT color="green">268</FONT> * @see Logger#error(String, Object...)<a name="line.268"></a>
<FONT color="green">269</FONT> * @see Logger#warn(Marker, String, Object...)<a name="line.269"></a>
<FONT color="green">270</FONT> * @see Logger#warn(String, Object...)<a name="line.270"></a>
<FONT color="green">271</FONT> * @see Logger#info(Marker, String, Object...)<a name="line.271"></a>
<FONT color="green">272</FONT> * @see Logger#info(String, Object...)<a name="line.272"></a>
<FONT color="green">273</FONT> * @see Logger#debug(Marker, String, Object...)<a name="line.273"></a>
<FONT color="green">274</FONT> * @see Logger#debug(String, Object...)<a name="line.274"></a>
<FONT color="green">275</FONT> * @see Logger#trace(Marker, String, Object...)<a name="line.275"></a>
<FONT color="green">276</FONT> * @see Logger#trace(String, Object...)<a name="line.276"></a>
<FONT color="green">277</FONT> * @see StringFormatterMessageFactory<a name="line.277"></a>
<FONT color="green">278</FONT> */<a name="line.278"></a>
<FONT color="green">279</FONT> public static Logger getFormatterLogger(final Object value) {<a name="line.279"></a>
<FONT color="green">280</FONT> return getLogger(value, StringFormatterMessageFactory.INSTANCE);<a name="line.280"></a>
<FONT color="green">281</FONT> }<a name="line.281"></a>
<FONT color="green">282</FONT> <a name="line.282"></a>
<FONT color="green">283</FONT> /**<a name="line.283"></a>
<FONT color="green">284</FONT> * Returns a formatter Logger with the specified name.<a name="line.284"></a>
<FONT color="green">285</FONT> * &lt;p&gt;<a name="line.285"></a>
<FONT color="green">286</FONT> * This logger let you use a {@link Formatter} string in the message to format parameters.<a name="line.286"></a>
<FONT color="green">287</FONT> * &lt;/p&gt;<a name="line.287"></a>
<FONT color="green">288</FONT> * &lt;p&gt;<a name="line.288"></a>
<FONT color="green">289</FONT> * Short-hand for {@code getLogger(name, StringFormatterMessageFactory.INSTANCE)}<a name="line.289"></a>
<FONT color="green">290</FONT> * &lt;/p&gt;<a name="line.290"></a>
<FONT color="green">291</FONT> *<a name="line.291"></a>
<FONT color="green">292</FONT> * @param name<a name="line.292"></a>
<FONT color="green">293</FONT> * The logger name.<a name="line.293"></a>
<FONT color="green">294</FONT> * @return The Logger, created with a {@link StringFormatterMessageFactory}<a name="line.294"></a>
<FONT color="green">295</FONT> * @see Logger#fatal(Marker, String, Object...)<a name="line.295"></a>
<FONT color="green">296</FONT> * @see Logger#fatal(String, Object...)<a name="line.296"></a>
<FONT color="green">297</FONT> * @see Logger#error(Marker, String, Object...)<a name="line.297"></a>
<FONT color="green">298</FONT> * @see Logger#error(String, Object...)<a name="line.298"></a>
<FONT color="green">299</FONT> * @see Logger#warn(Marker, String, Object...)<a name="line.299"></a>
<FONT color="green">300</FONT> * @see Logger#warn(String, Object...)<a name="line.300"></a>
<FONT color="green">301</FONT> * @see Logger#info(Marker, String, Object...)<a name="line.301"></a>
<FONT color="green">302</FONT> * @see Logger#info(String, Object...)<a name="line.302"></a>
<FONT color="green">303</FONT> * @see Logger#debug(Marker, String, Object...)<a name="line.303"></a>
<FONT color="green">304</FONT> * @see Logger#debug(String, Object...)<a name="line.304"></a>
<FONT color="green">305</FONT> * @see Logger#trace(Marker, String, Object...)<a name="line.305"></a>
<FONT color="green">306</FONT> * @see Logger#trace(String, Object...)<a name="line.306"></a>
<FONT color="green">307</FONT> * @see StringFormatterMessageFactory<a name="line.307"></a>
<FONT color="green">308</FONT> */<a name="line.308"></a>
<FONT color="green">309</FONT> public static Logger getFormatterLogger(final String name) {<a name="line.309"></a>
<FONT color="green">310</FONT> return getLogger(name, StringFormatterMessageFactory.INSTANCE);<a name="line.310"></a>
<FONT color="green">311</FONT> }<a name="line.311"></a>
<FONT color="green">312</FONT> <a name="line.312"></a>
<FONT color="green">313</FONT> /**<a name="line.313"></a>
<FONT color="green">314</FONT> * Returns a Logger using the fully qualified name of the Class as the Logger name.<a name="line.314"></a>
<FONT color="green">315</FONT> * @param clazz The Class whose name should be used as the Logger name.<a name="line.315"></a>
<FONT color="green">316</FONT> * @return The Logger.<a name="line.316"></a>
<FONT color="green">317</FONT> */<a name="line.317"></a>
<FONT color="green">318</FONT> public static Logger getLogger(final Class&lt;?&gt; clazz) {<a name="line.318"></a>
<FONT color="green">319</FONT> return getLogger(clazz != null ? clazz.getName() : null);<a name="line.319"></a>
<FONT color="green">320</FONT> }<a name="line.320"></a>
<FONT color="green">321</FONT> <a name="line.321"></a>
<FONT color="green">322</FONT> /**<a name="line.322"></a>
<FONT color="green">323</FONT> * Returns a Logger using the fully qualified name of the Class as the Logger name.<a name="line.323"></a>
<FONT color="green">324</FONT> * @param clazz The Class whose name should be used as the Logger name.<a name="line.324"></a>
<FONT color="green">325</FONT> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change<a name="line.325"></a>
<FONT color="green">326</FONT> * the logger but will log a warning if mismatched.<a name="line.326"></a>
<FONT color="green">327</FONT> * @return The Logger.<a name="line.327"></a>
<FONT color="green">328</FONT> */<a name="line.328"></a>
<FONT color="green">329</FONT> public static Logger getLogger(final Class&lt;?&gt; clazz, final MessageFactory messageFactory) {<a name="line.329"></a>
<FONT color="green">330</FONT> return getLogger(clazz != null ? clazz.getName() : null, messageFactory);<a name="line.330"></a>
<FONT color="green">331</FONT> }<a name="line.331"></a>
<FONT color="green">332</FONT> <a name="line.332"></a>
<FONT color="green">333</FONT> /**<a name="line.333"></a>
<FONT color="green">334</FONT> * Returns a Logger using the fully qualified class name of the value as the Logger name.<a name="line.334"></a>
<FONT color="green">335</FONT> * @param value The value whose class name should be used as the Logger name.<a name="line.335"></a>
<FONT color="green">336</FONT> * @return The Logger.<a name="line.336"></a>
<FONT color="green">337</FONT> */<a name="line.337"></a>
<FONT color="green">338</FONT> public static Logger getLogger(final Object value) {<a name="line.338"></a>
<FONT color="green">339</FONT> return getLogger(value != null ? value.getClass() : null);<a name="line.339"></a>
<FONT color="green">340</FONT> }<a name="line.340"></a>
<FONT color="green">341</FONT> <a name="line.341"></a>
<FONT color="green">342</FONT> /**<a name="line.342"></a>
<FONT color="green">343</FONT> * Returns a Logger using the fully qualified class name of the value as the Logger name.<a name="line.343"></a>
<FONT color="green">344</FONT> * @param value The value whose class name should be used as the Logger name.<a name="line.344"></a>
<FONT color="green">345</FONT> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change<a name="line.345"></a>
<FONT color="green">346</FONT> * the logger but will log a warning if mismatched.<a name="line.346"></a>
<FONT color="green">347</FONT> * @return The Logger.<a name="line.347"></a>
<FONT color="green">348</FONT> */<a name="line.348"></a>
<FONT color="green">349</FONT> public static Logger getLogger(final Object value, final MessageFactory messageFactory) {<a name="line.349"></a>
<FONT color="green">350</FONT> return getLogger(value != null ? value.getClass() : null, messageFactory);<a name="line.350"></a>
<FONT color="green">351</FONT> }<a name="line.351"></a>
<FONT color="green">352</FONT> <a name="line.352"></a>
<FONT color="green">353</FONT> /**<a name="line.353"></a>
<FONT color="green">354</FONT> * Returns a Logger with the specified name.<a name="line.354"></a>
<FONT color="green">355</FONT> *<a name="line.355"></a>
<FONT color="green">356</FONT> * @param name The logger name.<a name="line.356"></a>
<FONT color="green">357</FONT> * @return The Logger.<a name="line.357"></a>
<FONT color="green">358</FONT> */<a name="line.358"></a>
<FONT color="green">359</FONT> public static Logger getLogger(final String name) {<a name="line.359"></a>
<FONT color="green">360</FONT> return factory.getContext(LogManager.class.getName(), null, false).getLogger(name);<a name="line.360"></a>
<FONT color="green">361</FONT> }<a name="line.361"></a>
<FONT color="green">362</FONT> <a name="line.362"></a>
<FONT color="green">363</FONT> /**<a name="line.363"></a>
<FONT color="green">364</FONT> * Returns a Logger with the specified name.<a name="line.364"></a>
<FONT color="green">365</FONT> *<a name="line.365"></a>
<FONT color="green">366</FONT> * @param name The logger name.<a name="line.366"></a>
<FONT color="green">367</FONT> * @param messageFactory The message factory is used only when creating a logger, subsequent use does not change<a name="line.367"></a>
<FONT color="green">368</FONT> * the logger but will log a warning if mismatched.<a name="line.368"></a>
<FONT color="green">369</FONT> * @return The Logger.<a name="line.369"></a>
<FONT color="green">370</FONT> */<a name="line.370"></a>
<FONT color="green">371</FONT> public static Logger getLogger(final String name, final MessageFactory messageFactory) {<a name="line.371"></a>
<FONT color="green">372</FONT> return factory.getContext(LogManager.class.getName(), null, false).getLogger(name, messageFactory);<a name="line.372"></a>
<FONT color="green">373</FONT> }<a name="line.373"></a>
<FONT color="green">374</FONT> <a name="line.374"></a>
<FONT color="green">375</FONT> /**<a name="line.375"></a>
<FONT color="green">376</FONT> * Returns a Logger with the specified name.<a name="line.376"></a>
<FONT color="green">377</FONT> *<a name="line.377"></a>
<FONT color="green">378</FONT> * @param fqcn The fully qualified class name of the class that this method is a member of.<a name="line.378"></a>
<FONT color="green">379</FONT> * @param name The logger name.<a name="line.379"></a>
<FONT color="green">380</FONT> * @return The Logger.<a name="line.380"></a>
<FONT color="green">381</FONT> */<a name="line.381"></a>
<FONT color="green">382</FONT> protected static Logger getLogger(final String fqcn, final String name) {<a name="line.382"></a>
<FONT color="green">383</FONT> return factory.getContext(fqcn, null, false).getLogger(name);<a name="line.383"></a>
<FONT color="green">384</FONT> }<a name="line.384"></a>
<FONT color="green">385</FONT> }<a name="line.385"></a>
</PRE>
</BODY>
</HTML>