You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2013/03/19 22:14:40 UTC
svn commit: r855121 [16/22] - in
/websites/production/commons/content/proper/commons-logging/javadocs/api-release:
./ org/ org/apache/ org/apache/commons/ org/apache/commons/logging/
org/apache/commons/logging/class-use/ org/apache/commons/logging/impl...
Added: websites/production/commons/content/proper/commons-logging/javadocs/api-release/src-html/org/apache/commons/logging/LogFactory.html
==============================================================================
--- websites/production/commons/content/proper/commons-logging/javadocs/api-release/src-html/org/apache/commons/logging/LogFactory.html (added)
+++ websites/production/commons/content/proper/commons-logging/javadocs/api-release/src-html/org/apache/commons/logging/LogFactory.html Tue Mar 19 21:14:39 2013
@@ -0,0 +1,1818 @@
+<!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><a name="line.17"></a>
+<span class="sourceLineNo">018</span>package org.apache.commons.logging;<a name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.io.BufferedReader;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import java.io.FileOutputStream;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import java.io.InputStream;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import java.io.InputStreamReader;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import java.io.PrintStream;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import java.lang.reflect.InvocationTargetException;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import java.lang.reflect.Method;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import java.net.URL;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import java.net.URLConnection;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import java.security.AccessController;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import java.security.PrivilegedAction;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import java.util.Enumeration;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import java.util.Hashtable;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import java.util.Properties;<a name="line.34"></a>
+<span class="sourceLineNo">035</span><a name="line.35"></a>
+<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * Factory for creating {@link Log} instances, with discovery and<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * configuration features similar to that employed by standard Java APIs<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * such as JAXP.<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * <p><a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <strong>IMPLEMENTATION NOTE</strong> - This implementation is heavily<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * based on the SAXParserFactory and DocumentBuilderFactory implementations<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * (corresponding to the JAXP pluggability APIs) found in Apache Xerces.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * @version $Id$<a name="line.45"></a>
+<span class="sourceLineNo">046</span> */<a name="line.46"></a>
+<span class="sourceLineNo">047</span>public abstract class LogFactory {<a name="line.47"></a>
+<span class="sourceLineNo">048</span> // Implementation note re AccessController usage<a name="line.48"></a>
+<span class="sourceLineNo">049</span> //<a name="line.49"></a>
+<span class="sourceLineNo">050</span> // It is important to keep code invoked via an AccessController to small<a name="line.50"></a>
+<span class="sourceLineNo">051</span> // auditable blocks. Such code must carefully evaluate all user input<a name="line.51"></a>
+<span class="sourceLineNo">052</span> // (parameters, system properties, config file contents, etc). As an<a name="line.52"></a>
+<span class="sourceLineNo">053</span> // example, a Log implementation should not write to its logfile<a name="line.53"></a>
+<span class="sourceLineNo">054</span> // with an AccessController anywhere in the call stack, otherwise an<a name="line.54"></a>
+<span class="sourceLineNo">055</span> // insecure application could configure the log implementation to write<a name="line.55"></a>
+<span class="sourceLineNo">056</span> // to a protected file using the privileges granted to JCL rather than<a name="line.56"></a>
+<span class="sourceLineNo">057</span> // to the calling application.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> //<a name="line.58"></a>
+<span class="sourceLineNo">059</span> // Under no circumstance should a non-private method return data that is<a name="line.59"></a>
+<span class="sourceLineNo">060</span> // retrieved via an AccessController. That would allow an insecure app<a name="line.60"></a>
+<span class="sourceLineNo">061</span> // to invoke that method and obtain data that it is not permitted to have.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> //<a name="line.62"></a>
+<span class="sourceLineNo">063</span> // Invoking user-supplied code with an AccessController set is not a major<a name="line.63"></a>
+<span class="sourceLineNo">064</span> // issue (eg invoking the constructor of the class specified by<a name="line.64"></a>
+<span class="sourceLineNo">065</span> // HASHTABLE_IMPLEMENTATION_PROPERTY). That class will be in a different<a name="line.65"></a>
+<span class="sourceLineNo">066</span> // trust domain, and therefore must have permissions to do whatever it<a name="line.66"></a>
+<span class="sourceLineNo">067</span> // is trying to do regardless of the permissions granted to JCL. There is<a name="line.67"></a>
+<span class="sourceLineNo">068</span> // a slight issue in that untrusted code may point that environment var<a name="line.68"></a>
+<span class="sourceLineNo">069</span> // to another trusted library, in which case the code runs if both that<a name="line.69"></a>
+<span class="sourceLineNo">070</span> // lib and JCL have the necessary permissions even when the untrusted<a name="line.70"></a>
+<span class="sourceLineNo">071</span> // caller does not. That's a pretty hard route to exploit though.<a name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> // ----------------------------------------------------- Manifest Constants<a name="line.73"></a>
+<span class="sourceLineNo">074</span><a name="line.74"></a>
+<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * The name (<code>priority</code>) of the key in the config file used to<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * specify the priority of that particular config file. The associated value<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * is a floating-point number; higher values take priority over lower values.<a name="line.78"></a>
+<span class="sourceLineNo">079</span> */<a name="line.79"></a>
+<span class="sourceLineNo">080</span> public static final String PRIORITY_KEY = "priority";<a name="line.80"></a>
+<span class="sourceLineNo">081</span><a name="line.81"></a>
+<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * The name (<code>use_tccl</code>) of the key in the config file used<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * to specify whether logging classes should be loaded via the thread<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * context class loader (TCCL), or not. By default, the TCCL is used.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> */<a name="line.86"></a>
+<span class="sourceLineNo">087</span> public static final String TCCL_KEY = "use_tccl";<a name="line.87"></a>
+<span class="sourceLineNo">088</span><a name="line.88"></a>
+<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * The name (<code>org.apache.commons.logging.LogFactory</code>) of the property<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * used to identify the LogFactory implementation<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * class name. This can be used as a system property, or as an entry in a<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * configuration properties file.<a name="line.93"></a>
+<span class="sourceLineNo">094</span> */<a name="line.94"></a>
+<span class="sourceLineNo">095</span> public static final String FACTORY_PROPERTY = "org.apache.commons.logging.LogFactory";<a name="line.95"></a>
+<span class="sourceLineNo">096</span><a name="line.96"></a>
+<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * The fully qualified class name of the fallback <code>LogFactory</code><a name="line.98"></a>
+<span class="sourceLineNo">099</span> * implementation class to use, if no other can be found.<a name="line.99"></a>
+<span class="sourceLineNo">100</span> */<a name="line.100"></a>
+<span class="sourceLineNo">101</span> public static final String FACTORY_DEFAULT = "org.apache.commons.logging.impl.LogFactoryImpl";<a name="line.101"></a>
+<span class="sourceLineNo">102</span><a name="line.102"></a>
+<span class="sourceLineNo">103</span> /**<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * The name (<code>commons-logging.properties</code>) of the properties file to search for.<a name="line.104"></a>
+<span class="sourceLineNo">105</span> */<a name="line.105"></a>
+<span class="sourceLineNo">106</span> public static final String FACTORY_PROPERTIES = "commons-logging.properties";<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * JDK1.3+ <a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider"><a name="line.109"></a>
+<span class="sourceLineNo">110</span> * 'Service Provider' specification</a>.<a name="line.110"></a>
+<span class="sourceLineNo">111</span> */<a name="line.111"></a>
+<span class="sourceLineNo">112</span> protected static final String SERVICE_ID =<a name="line.112"></a>
+<span class="sourceLineNo">113</span> "META-INF/services/org.apache.commons.logging.LogFactory";<a name="line.113"></a>
+<span class="sourceLineNo">114</span><a name="line.114"></a>
+<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * The name (<code>org.apache.commons.logging.diagnostics.dest</code>)<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * of the property used to enable internal commons-logging<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * diagnostic output, in order to get information on what logging<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * implementations are being discovered, what classloaders they<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * are loaded through, etc.<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * <p><a name="line.121"></a>
+<span class="sourceLineNo">122</span> * If a system property of this name is set then the value is<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * assumed to be the name of a file. The special strings<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * STDOUT or STDERR (case-sensitive) indicate output to<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * System.out and System.err respectively.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * <p><a name="line.126"></a>
+<span class="sourceLineNo">127</span> * Diagnostic logging should be used only to debug problematic<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * configurations and should not be set in normal production use.<a name="line.128"></a>
+<span class="sourceLineNo">129</span> */<a name="line.129"></a>
+<span class="sourceLineNo">130</span> public static final String DIAGNOSTICS_DEST_PROPERTY =<a name="line.130"></a>
+<span class="sourceLineNo">131</span> "org.apache.commons.logging.diagnostics.dest";<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> * When null (the usual case), no diagnostic output will be<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * generated by LogFactory or LogFactoryImpl. When non-null,<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * interesting events will be written to the specified object.<a name="line.136"></a>
+<span class="sourceLineNo">137</span> */<a name="line.137"></a>
+<span class="sourceLineNo">138</span> private static PrintStream diagnosticsStream = null;<a name="line.138"></a>
+<span class="sourceLineNo">139</span><a name="line.139"></a>
+<span class="sourceLineNo">140</span> /**<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * A string that gets prefixed to every message output by the<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * logDiagnostic method, so that users can clearly see which<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * LogFactory class is generating the output.<a name="line.143"></a>
+<span class="sourceLineNo">144</span> */<a name="line.144"></a>
+<span class="sourceLineNo">145</span> private static final String diagnosticPrefix;<a name="line.145"></a>
+<span class="sourceLineNo">146</span><a name="line.146"></a>
+<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * Setting this system property<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * (<code>org.apache.commons.logging.LogFactory.HashtableImpl</code>)<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * value allows the <code>Hashtable</code> used to store<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * classloaders to be substituted by an alternative implementation.<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * <p><a name="line.152"></a>
+<span class="sourceLineNo">153</span> * <strong>Note:</strong> <code>LogFactory</code> will print:<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * <code><pre><a name="line.154"></a>
+<span class="sourceLineNo">155</span> * [ERROR] LogFactory: Load of custom hashtable failed</em><a name="line.155"></a>
+<span class="sourceLineNo">156</span> * </pre></code><a name="line.156"></a>
+<span class="sourceLineNo">157</span> * to system error and then continue using a standard Hashtable.<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * <p><a name="line.158"></a>
+<span class="sourceLineNo">159</span> * <strong>Usage:</strong> Set this property when Java is invoked<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * and <code>LogFactory</code> will attempt to load a new instance<a name="line.160"></a>
+<span class="sourceLineNo">161</span> * of the given implementation class.<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * For example, running the following ant scriplet:<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * <code><pre><a name="line.163"></a>
+<span class="sourceLineNo">164</span> * &lt;java classname="${test.runner}" fork="yes" failonerror="${test.failonerror}"&gt;<a name="line.164"></a>
+<span class="sourceLineNo">165</span> * ...<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * &lt;sysproperty<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * key="org.apache.commons.logging.LogFactory.HashtableImpl"<a name="line.167"></a>
+<span class="sourceLineNo">168</span> * value="org.apache.commons.logging.AltHashtable"/&gt;<a name="line.168"></a>
+<span class="sourceLineNo">169</span> * &lt;/java&gt;<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * </pre></code><a name="line.170"></a>
+<span class="sourceLineNo">171</span> * will mean that <code>LogFactory</code> will load an instance of<a name="line.171"></a>
+<span class="sourceLineNo">172</span> * <code>org.apache.commons.logging.AltHashtable</code>.<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * <p><a name="line.173"></a>
+<span class="sourceLineNo">174</span> * A typical use case is to allow a custom<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * Hashtable implementation using weak references to be substituted.<a name="line.175"></a>
+<span class="sourceLineNo">176</span> * This will allow classloaders to be garbage collected without<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * the need to release them (on 1.3+ JVMs only, of course ;).<a name="line.177"></a>
+<span class="sourceLineNo">178</span> */<a name="line.178"></a>
+<span class="sourceLineNo">179</span> public static final String HASHTABLE_IMPLEMENTATION_PROPERTY =<a name="line.179"></a>
+<span class="sourceLineNo">180</span> "org.apache.commons.logging.LogFactory.HashtableImpl";<a name="line.180"></a>
+<span class="sourceLineNo">181</span><a name="line.181"></a>
+<span class="sourceLineNo">182</span> /** Name used to load the weak hashtable implementation by names. */<a name="line.182"></a>
+<span class="sourceLineNo">183</span> private static final String WEAK_HASHTABLE_CLASSNAME =<a name="line.183"></a>
+<span class="sourceLineNo">184</span> "org.apache.commons.logging.impl.WeakHashtable";<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * A reference to the classloader that loaded this class. This is the<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * same as LogFactory.class.getClassLoader(). However computing this<a name="line.188"></a>
+<span class="sourceLineNo">189</span> * value isn't quite as simple as that, as we potentially need to use<a name="line.189"></a>
+<span class="sourceLineNo">190</span> * AccessControllers etc. It's more efficient to compute it once and<a name="line.190"></a>
+<span class="sourceLineNo">191</span> * cache it here.<a name="line.191"></a>
+<span class="sourceLineNo">192</span> */<a name="line.192"></a>
+<span class="sourceLineNo">193</span> private static final ClassLoader thisClassLoader;<a name="line.193"></a>
+<span class="sourceLineNo">194</span><a name="line.194"></a>
+<span class="sourceLineNo">195</span> // ----------------------------------------------------------- Constructors<a name="line.195"></a>
+<span class="sourceLineNo">196</span><a name="line.196"></a>
+<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * Protected constructor that is not available for public use.<a name="line.198"></a>
+<span class="sourceLineNo">199</span> */<a name="line.199"></a>
+<span class="sourceLineNo">200</span> protected LogFactory() {<a name="line.200"></a>
+<span class="sourceLineNo">201</span> }<a name="line.201"></a>
+<span class="sourceLineNo">202</span><a name="line.202"></a>
+<span class="sourceLineNo">203</span> // --------------------------------------------------------- Public Methods<a name="line.203"></a>
+<span class="sourceLineNo">204</span><a name="line.204"></a>
+<span class="sourceLineNo">205</span> /**<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * Return the configuration attribute with the specified name (if any),<a name="line.206"></a>
+<span class="sourceLineNo">207</span> * or <code>null</code> if there is no such attribute.<a name="line.207"></a>
+<span class="sourceLineNo">208</span> *<a name="line.208"></a>
+<span class="sourceLineNo">209</span> * @param name Name of the attribute to return<a name="line.209"></a>
+<span class="sourceLineNo">210</span> */<a name="line.210"></a>
+<span class="sourceLineNo">211</span> public abstract Object getAttribute(String name);<a name="line.211"></a>
+<span class="sourceLineNo">212</span><a name="line.212"></a>
+<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
+<span class="sourceLineNo">214</span> * Return an array containing the names of all currently defined<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * configuration attributes. If there are no such attributes, a zero<a name="line.215"></a>
+<span class="sourceLineNo">216</span> * length array is returned.<a name="line.216"></a>
+<span class="sourceLineNo">217</span> */<a name="line.217"></a>
+<span class="sourceLineNo">218</span> public abstract String[] getAttributeNames();<a name="line.218"></a>
+<span class="sourceLineNo">219</span><a name="line.219"></a>
+<span class="sourceLineNo">220</span> /**<a name="line.220"></a>
+<span class="sourceLineNo">221</span> * Convenience method to derive a name from the specified class and<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * call <code>getInstance(String)</code> with it.<a name="line.222"></a>
+<span class="sourceLineNo">223</span> *<a name="line.223"></a>
+<span class="sourceLineNo">224</span> * @param clazz Class for which a suitable Log name will be derived<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * @throws LogConfigurationException if a suitable <code>Log</code><a name="line.225"></a>
+<span class="sourceLineNo">226</span> * instance cannot be returned<a name="line.226"></a>
+<span class="sourceLineNo">227</span> */<a name="line.227"></a>
+<span class="sourceLineNo">228</span> public abstract Log getInstance(Class clazz)<a name="line.228"></a>
+<span class="sourceLineNo">229</span> throws LogConfigurationException;<a name="line.229"></a>
+<span class="sourceLineNo">230</span><a name="line.230"></a>
+<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
+<span class="sourceLineNo">232</span> * Construct (if necessary) and return a <code>Log</code> instance,<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * using the factory's current set of configuration attributes.<a name="line.233"></a>
+<span class="sourceLineNo">234</span> * <p><a name="line.234"></a>
+<span class="sourceLineNo">235</span> * <strong>NOTE</strong> - Depending upon the implementation of<a name="line.235"></a>
+<span class="sourceLineNo">236</span> * the <code>LogFactory</code> you are using, the <code>Log</code><a name="line.236"></a>
+<span class="sourceLineNo">237</span> * instance you are returned may or may not be local to the current<a name="line.237"></a>
+<span class="sourceLineNo">238</span> * application, and may or may not be returned again on a subsequent<a name="line.238"></a>
+<span class="sourceLineNo">239</span> * call with the same name argument.<a name="line.239"></a>
+<span class="sourceLineNo">240</span> *<a name="line.240"></a>
+<span class="sourceLineNo">241</span> * @param name Logical name of the <code>Log</code> instance to be<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * returned (the meaning of this name is only known to the underlying<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * logging implementation that is being wrapped)<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * @throws LogConfigurationException if a suitable <code>Log</code><a name="line.244"></a>
+<span class="sourceLineNo">245</span> * instance cannot be returned<a name="line.245"></a>
+<span class="sourceLineNo">246</span> */<a name="line.246"></a>
+<span class="sourceLineNo">247</span> public abstract Log getInstance(String name)<a name="line.247"></a>
+<span class="sourceLineNo">248</span> throws LogConfigurationException;<a name="line.248"></a>
+<span class="sourceLineNo">249</span><a name="line.249"></a>
+<span class="sourceLineNo">250</span> /**<a name="line.250"></a>
+<span class="sourceLineNo">251</span> * Release any internal references to previously created {@link Log}<a name="line.251"></a>
+<span class="sourceLineNo">252</span> * instances returned by this factory. This is useful in environments<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * like servlet containers, which implement application reloading by<a name="line.253"></a>
+<span class="sourceLineNo">254</span> * throwing away a ClassLoader. Dangling references to objects in that<a name="line.254"></a>
+<span class="sourceLineNo">255</span> * class loader would prevent garbage collection.<a name="line.255"></a>
+<span class="sourceLineNo">256</span> */<a name="line.256"></a>
+<span class="sourceLineNo">257</span> public abstract void release();<a name="line.257"></a>
+<span class="sourceLineNo">258</span><a name="line.258"></a>
+<span class="sourceLineNo">259</span> /**<a name="line.259"></a>
+<span class="sourceLineNo">260</span> * Remove any configuration attribute associated with the specified name.<a name="line.260"></a>
+<span class="sourceLineNo">261</span> * If there is no such attribute, no action is taken.<a name="line.261"></a>
+<span class="sourceLineNo">262</span> *<a name="line.262"></a>
+<span class="sourceLineNo">263</span> * @param name Name of the attribute to remove<a name="line.263"></a>
+<span class="sourceLineNo">264</span> */<a name="line.264"></a>
+<span class="sourceLineNo">265</span> public abstract void removeAttribute(String name);<a name="line.265"></a>
+<span class="sourceLineNo">266</span><a name="line.266"></a>
+<span class="sourceLineNo">267</span> /**<a name="line.267"></a>
+<span class="sourceLineNo">268</span> * Set the configuration attribute with the specified name. Calling<a name="line.268"></a>
+<span class="sourceLineNo">269</span> * this with a <code>null</code> value is equivalent to calling<a name="line.269"></a>
+<span class="sourceLineNo">270</span> * <code>removeAttribute(name)</code>.<a name="line.270"></a>
+<span class="sourceLineNo">271</span> *<a name="line.271"></a>
+<span class="sourceLineNo">272</span> * @param name Name of the attribute to set<a name="line.272"></a>
+<span class="sourceLineNo">273</span> * @param value Value of the attribute to set, or <code>null</code><a name="line.273"></a>
+<span class="sourceLineNo">274</span> * to remove any setting for this attribute<a name="line.274"></a>
+<span class="sourceLineNo">275</span> */<a name="line.275"></a>
+<span class="sourceLineNo">276</span> public abstract void setAttribute(String name, Object value);<a name="line.276"></a>
+<span class="sourceLineNo">277</span><a name="line.277"></a>
+<span class="sourceLineNo">278</span> // ------------------------------------------------------- Static Variables<a name="line.278"></a>
+<span class="sourceLineNo">279</span><a name="line.279"></a>
+<span class="sourceLineNo">280</span> /**<a name="line.280"></a>
+<span class="sourceLineNo">281</span> * The previously constructed <code>LogFactory</code> instances, keyed by<a name="line.281"></a>
+<span class="sourceLineNo">282</span> * the <code>ClassLoader</code> with which it was created.<a name="line.282"></a>
+<span class="sourceLineNo">283</span> */<a name="line.283"></a>
+<span class="sourceLineNo">284</span> protected static Hashtable factories = null;<a name="line.284"></a>
+<span class="sourceLineNo">285</span><a name="line.285"></a>
+<span class="sourceLineNo">286</span> /**<a name="line.286"></a>
+<span class="sourceLineNo">287</span> * Previously constructed <code>LogFactory</code> instance as in the<a name="line.287"></a>
+<span class="sourceLineNo">288</span> * <code>factories</code> map, but for the case where<a name="line.288"></a>
+<span class="sourceLineNo">289</span> * <code>getClassLoader</code> returns <code>null</code>.<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * This can happen when:<a name="line.290"></a>
+<span class="sourceLineNo">291</span> * <ul><a name="line.291"></a>
+<span class="sourceLineNo">292</span> * <li>using JDK1.1 and the calling code is loaded via the system<a name="line.292"></a>
+<span class="sourceLineNo">293</span> * classloader (very common)</li><a name="line.293"></a>
+<span class="sourceLineNo">294</span> * <li>using JDK1.2+ and the calling code is loaded via the boot<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * classloader (only likely for embedded systems work).</li><a name="line.295"></a>
+<span class="sourceLineNo">296</span> * </ul><a name="line.296"></a>
+<span class="sourceLineNo">297</span> * Note that <code>factories</code> is a <i>Hashtable</i> (not a HashMap),<a name="line.297"></a>
+<span class="sourceLineNo">298</span> * and hashtables don't allow null as a key.<a name="line.298"></a>
+<span class="sourceLineNo">299</span> * @deprecated since 1.1.2<a name="line.299"></a>
+<span class="sourceLineNo">300</span> */<a name="line.300"></a>
+<span class="sourceLineNo">301</span> protected static volatile LogFactory nullClassLoaderFactory = null;<a name="line.301"></a>
+<span class="sourceLineNo">302</span><a name="line.302"></a>
+<span class="sourceLineNo">303</span> /**<a name="line.303"></a>
+<span class="sourceLineNo">304</span> * Create the hashtable which will be used to store a map of<a name="line.304"></a>
+<span class="sourceLineNo">305</span> * (context-classloader -> logfactory-object). Version 1.2+ of Java<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * supports "weak references", allowing a custom Hashtable class<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * to be used which uses only weak references to its keys. Using weak<a name="line.307"></a>
+<span class="sourceLineNo">308</span> * references can fix memory leaks on webapp unload in some cases (though<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * not all). Version 1.1 of Java does not support weak references, so we<a name="line.309"></a>
+<span class="sourceLineNo">310</span> * must dynamically determine which we are using. And just for fun, this<a name="line.310"></a>
+<span class="sourceLineNo">311</span> * code also supports the ability for a system property to specify an<a name="line.311"></a>
+<span class="sourceLineNo">312</span> * arbitrary Hashtable implementation name.<a name="line.312"></a>
+<span class="sourceLineNo">313</span> * <p><a name="line.313"></a>
+<span class="sourceLineNo">314</span> * Note that the correct way to ensure no memory leaks occur is to ensure<a name="line.314"></a>
+<span class="sourceLineNo">315</span> * that LogFactory.release(contextClassLoader) is called whenever a<a name="line.315"></a>
+<span class="sourceLineNo">316</span> * webapp is undeployed.<a name="line.316"></a>
+<span class="sourceLineNo">317</span> */<a name="line.317"></a>
+<span class="sourceLineNo">318</span> private static final Hashtable createFactoryStore() {<a name="line.318"></a>
+<span class="sourceLineNo">319</span> Hashtable result = null;<a name="line.319"></a>
+<span class="sourceLineNo">320</span> String storeImplementationClass;<a name="line.320"></a>
+<span class="sourceLineNo">321</span> try {<a name="line.321"></a>
+<span class="sourceLineNo">322</span> storeImplementationClass = getSystemProperty(HASHTABLE_IMPLEMENTATION_PROPERTY, null);<a name="line.322"></a>
+<span class="sourceLineNo">323</span> } catch (SecurityException ex) {<a name="line.323"></a>
+<span class="sourceLineNo">324</span> // Permissions don't allow this to be accessed. Default to the "modern"<a name="line.324"></a>
+<span class="sourceLineNo">325</span> // weak hashtable implementation if it is available.<a name="line.325"></a>
+<span class="sourceLineNo">326</span> storeImplementationClass = null;<a name="line.326"></a>
+<span class="sourceLineNo">327</span> }<a name="line.327"></a>
+<span class="sourceLineNo">328</span><a name="line.328"></a>
+<span class="sourceLineNo">329</span> if (storeImplementationClass == null) {<a name="line.329"></a>
+<span class="sourceLineNo">330</span> storeImplementationClass = WEAK_HASHTABLE_CLASSNAME;<a name="line.330"></a>
+<span class="sourceLineNo">331</span> }<a name="line.331"></a>
+<span class="sourceLineNo">332</span> try {<a name="line.332"></a>
+<span class="sourceLineNo">333</span> Class implementationClass = Class.forName(storeImplementationClass);<a name="line.333"></a>
+<span class="sourceLineNo">334</span> result = (Hashtable) implementationClass.newInstance();<a name="line.334"></a>
+<span class="sourceLineNo">335</span> } catch (Throwable t) {<a name="line.335"></a>
+<span class="sourceLineNo">336</span> handleThrowable(t); // may re-throw t<a name="line.336"></a>
+<span class="sourceLineNo">337</span><a name="line.337"></a>
+<span class="sourceLineNo">338</span> // ignore<a name="line.338"></a>
+<span class="sourceLineNo">339</span> if (!WEAK_HASHTABLE_CLASSNAME.equals(storeImplementationClass)) {<a name="line.339"></a>
+<span class="sourceLineNo">340</span> // if the user's trying to set up a custom implementation, give a clue<a name="line.340"></a>
+<span class="sourceLineNo">341</span> if (isDiagnosticsEnabled()) {<a name="line.341"></a>
+<span class="sourceLineNo">342</span> // use internal logging to issue the warning<a name="line.342"></a>
+<span class="sourceLineNo">343</span> logDiagnostic("[ERROR] LogFactory: Load of custom hashtable failed");<a name="line.343"></a>
+<span class="sourceLineNo">344</span> } else {<a name="line.344"></a>
+<span class="sourceLineNo">345</span> // we *really* want this output, even if diagnostics weren't<a name="line.345"></a>
+<span class="sourceLineNo">346</span> // explicitly enabled by the user.<a name="line.346"></a>
+<span class="sourceLineNo">347</span> System.err.println("[ERROR] LogFactory: Load of custom hashtable failed");<a name="line.347"></a>
+<span class="sourceLineNo">348</span> }<a name="line.348"></a>
+<span class="sourceLineNo">349</span> }<a name="line.349"></a>
+<span class="sourceLineNo">350</span> }<a name="line.350"></a>
+<span class="sourceLineNo">351</span> if (result == null) {<a name="line.351"></a>
+<span class="sourceLineNo">352</span> result = new Hashtable();<a name="line.352"></a>
+<span class="sourceLineNo">353</span> }<a name="line.353"></a>
+<span class="sourceLineNo">354</span> return result;<a name="line.354"></a>
+<span class="sourceLineNo">355</span> }<a name="line.355"></a>
+<span class="sourceLineNo">356</span><a name="line.356"></a>
+<span class="sourceLineNo">357</span> // --------------------------------------------------------- Static Methods<a name="line.357"></a>
+<span class="sourceLineNo">358</span><a name="line.358"></a>
+<span class="sourceLineNo">359</span> /** Utility method to safely trim a string. */<a name="line.359"></a>
+<span class="sourceLineNo">360</span> private static String trim(String src) {<a name="line.360"></a>
+<span class="sourceLineNo">361</span> if (src == null) {<a name="line.361"></a>
+<span class="sourceLineNo">362</span> return null;<a name="line.362"></a>
+<span class="sourceLineNo">363</span> }<a name="line.363"></a>
+<span class="sourceLineNo">364</span> return src.trim();<a name="line.364"></a>
+<span class="sourceLineNo">365</span> }<a name="line.365"></a>
+<span class="sourceLineNo">366</span><a name="line.366"></a>
+<span class="sourceLineNo">367</span> /**<a name="line.367"></a>
+<span class="sourceLineNo">368</span> * Checks whether the supplied Throwable is one that needs to be<a name="line.368"></a>
+<span class="sourceLineNo">369</span> * re-thrown and ignores all others.<a name="line.369"></a>
+<span class="sourceLineNo">370</span> *<a name="line.370"></a>
+<span class="sourceLineNo">371</span> * The following errors are re-thrown:<a name="line.371"></a>
+<span class="sourceLineNo">372</span> * <ul><a name="line.372"></a>
+<span class="sourceLineNo">373</span> * <li>ThreadDeath</li><a name="line.373"></a>
+<span class="sourceLineNo">374</span> * <li>VirtualMachineError</li><a name="line.374"></a>
+<span class="sourceLineNo">375</span> * </ul><a name="line.375"></a>
+<span class="sourceLineNo">376</span> *<a name="line.376"></a>
+<span class="sourceLineNo">377</span> * @param t the Throwable to check<a name="line.377"></a>
+<span class="sourceLineNo">378</span> */<a name="line.378"></a>
+<span class="sourceLineNo">379</span> protected static void handleThrowable(Throwable t) {<a name="line.379"></a>
+<span class="sourceLineNo">380</span> if (t instanceof ThreadDeath) {<a name="line.380"></a>
+<span class="sourceLineNo">381</span> throw (ThreadDeath) t;<a name="line.381"></a>
+<span class="sourceLineNo">382</span> }<a name="line.382"></a>
+<span class="sourceLineNo">383</span> if (t instanceof VirtualMachineError) {<a name="line.383"></a>
+<span class="sourceLineNo">384</span> throw (VirtualMachineError) t;<a name="line.384"></a>
+<span class="sourceLineNo">385</span> }<a name="line.385"></a>
+<span class="sourceLineNo">386</span> // All other instances of Throwable will be silently ignored<a name="line.386"></a>
+<span class="sourceLineNo">387</span> }<a name="line.387"></a>
+<span class="sourceLineNo">388</span><a name="line.388"></a>
+<span class="sourceLineNo">389</span> /**<a name="line.389"></a>
+<span class="sourceLineNo">390</span> * Construct (if necessary) and return a <code>LogFactory</code><a name="line.390"></a>
+<span class="sourceLineNo">391</span> * instance, using the following ordered lookup procedure to determine<a name="line.391"></a>
+<span class="sourceLineNo">392</span> * the name of the implementation class to be loaded.<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * <p><a name="line.393"></a>
+<span class="sourceLineNo">394</span> * <ul><a name="line.394"></a>
+<span class="sourceLineNo">395</span> * <li>The <code>org.apache.commons.logging.LogFactory</code> system<a name="line.395"></a>
+<span class="sourceLineNo">396</span> * property.</li><a name="line.396"></a>
+<span class="sourceLineNo">397</span> * <li>The JDK 1.3 Service Discovery mechanism</li><a name="line.397"></a>
+<span class="sourceLineNo">398</span> * <li>Use the properties file <code>commons-logging.properties</code><a name="line.398"></a>
+<span class="sourceLineNo">399</span> * file, if found in the class path of this class. The configuration<a name="line.399"></a>
+<span class="sourceLineNo">400</span> * file is in standard <code>java.util.Properties</code> format and<a name="line.400"></a>
+<span class="sourceLineNo">401</span> * contains the fully qualified name of the implementation class<a name="line.401"></a>
+<span class="sourceLineNo">402</span> * with the key being the system property defined above.</li><a name="line.402"></a>
+<span class="sourceLineNo">403</span> * <li>Fall back to a default implementation class<a name="line.403"></a>
+<span class="sourceLineNo">404</span> * (<code>org.apache.commons.logging.impl.LogFactoryImpl</code>).</li><a name="line.404"></a>
+<span class="sourceLineNo">405</span> * </ul><a name="line.405"></a>
+<span class="sourceLineNo">406</span> * <p><a name="line.406"></a>
+<span class="sourceLineNo">407</span> * <em>NOTE</em> - If the properties file method of identifying the<a name="line.407"></a>
+<span class="sourceLineNo">408</span> * <code>LogFactory</code> implementation class is utilized, all of the<a name="line.408"></a>
+<span class="sourceLineNo">409</span> * properties defined in this file will be set as configuration attributes<a name="line.409"></a>
+<span class="sourceLineNo">410</span> * on the corresponding <code>LogFactory</code> instance.<a name="line.410"></a>
+<span class="sourceLineNo">411</span> * <p><a name="line.411"></a>
+<span class="sourceLineNo">412</span> * <em>NOTE</em> - In a multi-threaded environment it is possible<a name="line.412"></a>
+<span class="sourceLineNo">413</span> * that two different instances will be returned for the same<a name="line.413"></a>
+<span class="sourceLineNo">414</span> * classloader environment.<a name="line.414"></a>
+<span class="sourceLineNo">415</span> *<a name="line.415"></a>
+<span class="sourceLineNo">416</span> * @throws LogConfigurationException if the implementation class is not<a name="line.416"></a>
+<span class="sourceLineNo">417</span> * available or cannot be instantiated.<a name="line.417"></a>
+<span class="sourceLineNo">418</span> */<a name="line.418"></a>
+<span class="sourceLineNo">419</span> public static LogFactory getFactory() throws LogConfigurationException {<a name="line.419"></a>
+<span class="sourceLineNo">420</span> // Identify the class loader we will be using<a name="line.420"></a>
+<span class="sourceLineNo">421</span> ClassLoader contextClassLoader = getContextClassLoaderInternal();<a name="line.421"></a>
+<span class="sourceLineNo">422</span><a name="line.422"></a>
+<span class="sourceLineNo">423</span> if (contextClassLoader == null) {<a name="line.423"></a>
+<span class="sourceLineNo">424</span> // This is an odd enough situation to report about. This<a name="line.424"></a>
+<span class="sourceLineNo">425</span> // output will be a nuisance on JDK1.1, as the system<a name="line.425"></a>
+<span class="sourceLineNo">426</span> // classloader is null in that environment.<a name="line.426"></a>
+<span class="sourceLineNo">427</span> if (isDiagnosticsEnabled()) {<a name="line.427"></a>
+<span class="sourceLineNo">428</span> logDiagnostic("Context classloader is null.");<a name="line.428"></a>
+<span class="sourceLineNo">429</span> }<a name="line.429"></a>
+<span class="sourceLineNo">430</span> }<a name="line.430"></a>
+<span class="sourceLineNo">431</span><a name="line.431"></a>
+<span class="sourceLineNo">432</span> // Return any previously registered factory for this class loader<a name="line.432"></a>
+<span class="sourceLineNo">433</span> LogFactory factory = getCachedFactory(contextClassLoader);<a name="line.433"></a>
+<span class="sourceLineNo">434</span> if (factory != null) {<a name="line.434"></a>
+<span class="sourceLineNo">435</span> return factory;<a name="line.435"></a>
+<span class="sourceLineNo">436</span> }<a name="line.436"></a>
+<span class="sourceLineNo">437</span><a name="line.437"></a>
+<span class="sourceLineNo">438</span> if (isDiagnosticsEnabled()) {<a name="line.438"></a>
+<span class="sourceLineNo">439</span> logDiagnostic(<a name="line.439"></a>
+<span class="sourceLineNo">440</span> "[LOOKUP] LogFactory implementation requested for the first time for context classloader " +<a name="line.440"></a>
+<span class="sourceLineNo">441</span> objectId(contextClassLoader));<a name="line.441"></a>
+<span class="sourceLineNo">442</span> logHierarchy("[LOOKUP] ", contextClassLoader);<a name="line.442"></a>
+<span class="sourceLineNo">443</span> }<a name="line.443"></a>
+<span class="sourceLineNo">444</span><a name="line.444"></a>
+<span class="sourceLineNo">445</span> // Load properties file.<a name="line.445"></a>
+<span class="sourceLineNo">446</span> //<a name="line.446"></a>
+<span class="sourceLineNo">447</span> // If the properties file exists, then its contents are used as<a name="line.447"></a>
+<span class="sourceLineNo">448</span> // "attributes" on the LogFactory implementation class. One particular<a name="line.448"></a>
+<span class="sourceLineNo">449</span> // property may also control which LogFactory concrete subclass is<a name="line.449"></a>
+<span class="sourceLineNo">450</span> // used, but only if other discovery mechanisms fail..<a name="line.450"></a>
+<span class="sourceLineNo">451</span> //<a name="line.451"></a>
+<span class="sourceLineNo">452</span> // As the properties file (if it exists) will be used one way or<a name="line.452"></a>
+<span class="sourceLineNo">453</span> // another in the end we may as well look for it first.<a name="line.453"></a>
+<span class="sourceLineNo">454</span><a name="line.454"></a>
+<span class="sourceLineNo">455</span> Properties props = getConfigurationFile(contextClassLoader, FACTORY_PROPERTIES);<a name="line.455"></a>
+<span class="sourceLineNo">456</span><a name="line.456"></a>
+<span class="sourceLineNo">457</span> // Determine whether we will be using the thread context class loader to<a name="line.457"></a>
+<span class="sourceLineNo">458</span> // load logging classes or not by checking the loaded properties file (if any).<a name="line.458"></a>
+<span class="sourceLineNo">459</span> ClassLoader baseClassLoader = contextClassLoader;<a name="line.459"></a>
+<span class="sourceLineNo">460</span> if (props != null) {<a name="line.460"></a>
+<span class="sourceLineNo">461</span> String useTCCLStr = props.getProperty(TCCL_KEY);<a name="line.461"></a>
+<span class="sourceLineNo">462</span> if (useTCCLStr != null) {<a name="line.462"></a>
+<span class="sourceLineNo">463</span> // The Boolean.valueOf(useTCCLStr).booleanValue() formulation<a name="line.463"></a>
+<span class="sourceLineNo">464</span> // is required for Java 1.2 compatibility.<a name="line.464"></a>
+<span class="sourceLineNo">465</span> if (Boolean.valueOf(useTCCLStr).booleanValue() == false) {<a name="line.465"></a>
+<span class="sourceLineNo">466</span> // Don't use current context classloader when locating any<a name="line.466"></a>
+<span class="sourceLineNo">467</span> // LogFactory or Log classes, just use the class that loaded<a name="line.467"></a>
+<span class="sourceLineNo">468</span> // this abstract class. When this class is deployed in a shared<a name="line.468"></a>
+<span class="sourceLineNo">469</span> // classpath of a container, it means webapps cannot deploy their<a name="line.469"></a>
+<span class="sourceLineNo">470</span> // own logging implementations. It also means that it is up to the<a name="line.470"></a>
+<span class="sourceLineNo">471</span> // implementation whether to load library-specific config files<a name="line.471"></a>
+<span class="sourceLineNo">472</span> // from the TCCL or not.<a name="line.472"></a>
+<span class="sourceLineNo">473</span> baseClassLoader = thisClassLoader;<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> }<a name="line.476"></a>
+<span class="sourceLineNo">477</span><a name="line.477"></a>
+<span class="sourceLineNo">478</span> // Determine which concrete LogFactory subclass to use.<a name="line.478"></a>
+<span class="sourceLineNo">479</span> // First, try a global system property<a name="line.479"></a>
+<span class="sourceLineNo">480</span> if (isDiagnosticsEnabled()) {<a name="line.480"></a>
+<span class="sourceLineNo">481</span> logDiagnostic("[LOOKUP] Looking for system property [" + FACTORY_PROPERTY +<a name="line.481"></a>
+<span class="sourceLineNo">482</span> "] to define the LogFactory subclass to use...");<a name="line.482"></a>
+<span class="sourceLineNo">483</span> }<a name="line.483"></a>
+<span class="sourceLineNo">484</span><a name="line.484"></a>
+<span class="sourceLineNo">485</span> try {<a name="line.485"></a>
+<span class="sourceLineNo">486</span> String factoryClass = getSystemProperty(FACTORY_PROPERTY, null);<a name="line.486"></a>
+<span class="sourceLineNo">487</span> if (factoryClass != null) {<a name="line.487"></a>
+<span class="sourceLineNo">488</span> if (isDiagnosticsEnabled()) {<a name="line.488"></a>
+<span class="sourceLineNo">489</span> logDiagnostic("[LOOKUP] Creating an instance of LogFactory class '" + factoryClass +<a name="line.489"></a>
+<span class="sourceLineNo">490</span> "' as specified by system property " + FACTORY_PROPERTY);<a name="line.490"></a>
+<span class="sourceLineNo">491</span> }<a name="line.491"></a>
+<span class="sourceLineNo">492</span> factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);<a name="line.492"></a>
+<span class="sourceLineNo">493</span> } else {<a name="line.493"></a>
+<span class="sourceLineNo">494</span> if (isDiagnosticsEnabled()) {<a name="line.494"></a>
+<span class="sourceLineNo">495</span> logDiagnostic("[LOOKUP] No system property [" + FACTORY_PROPERTY + "] defined.");<a name="line.495"></a>
+<span class="sourceLineNo">496</span> }<a name="line.496"></a>
+<span class="sourceLineNo">497</span> }<a name="line.497"></a>
+<span class="sourceLineNo">498</span> } catch (SecurityException e) {<a name="line.498"></a>
+<span class="sourceLineNo">499</span> if (isDiagnosticsEnabled()) {<a name="line.499"></a>
+<span class="sourceLineNo">500</span> logDiagnostic("[LOOKUP] A security exception occurred while trying to create an" +<a name="line.500"></a>
+<span class="sourceLineNo">501</span> " instance of the custom factory class" + ": [" + trim(e.getMessage()) +<a name="line.501"></a>
+<span class="sourceLineNo">502</span> "]. Trying alternative implementations...");<a name="line.502"></a>
+<span class="sourceLineNo">503</span> }<a name="line.503"></a>
+<span class="sourceLineNo">504</span> // ignore<a name="line.504"></a>
+<span class="sourceLineNo">505</span> } catch (RuntimeException e) {<a name="line.505"></a>
+<span class="sourceLineNo">506</span> // This is not consistent with the behaviour when a bad LogFactory class is<a name="line.506"></a>
+<span class="sourceLineNo">507</span> // specified in a services file.<a name="line.507"></a>
+<span class="sourceLineNo">508</span> //<a name="line.508"></a>
+<span class="sourceLineNo">509</span> // One possible exception that can occur here is a ClassCastException when<a name="line.509"></a>
+<span class="sourceLineNo">510</span> // the specified class wasn't castable to this LogFactory type.<a name="line.510"></a>
+<span class="sourceLineNo">511</span> if (isDiagnosticsEnabled()) {<a name="line.511"></a>
+<span class="sourceLineNo">512</span> logDiagnostic("[LOOKUP] An exception occurred while trying to create an" +<a name="line.512"></a>
+<span class="sourceLineNo">513</span> " instance of the custom factory class" + ": [" +<a name="line.513"></a>
+<span class="sourceLineNo">514</span> trim(e.getMessage()) +<a name="line.514"></a>
+<span class="sourceLineNo">515</span> "] as specified by a system property.");<a name="line.515"></a>
+<span class="sourceLineNo">516</span> }<a name="line.516"></a>
+<span class="sourceLineNo">517</span> throw e;<a name="line.517"></a>
+<span class="sourceLineNo">518</span> }<a name="line.518"></a>
+<span class="sourceLineNo">519</span><a name="line.519"></a>
+<span class="sourceLineNo">520</span> // Second, try to find a service by using the JDK1.3 class<a name="line.520"></a>
+<span class="sourceLineNo">521</span> // discovery mechanism, which involves putting a file with the name<a name="line.521"></a>
+<span class="sourceLineNo">522</span> // of an interface class in the META-INF/services directory, where the<a name="line.522"></a>
+<span class="sourceLineNo">523</span> // contents of the file is a single line specifying a concrete class<a name="line.523"></a>
+<span class="sourceLineNo">524</span> // that implements the desired interface.<a name="line.524"></a>
+<span class="sourceLineNo">525</span><a name="line.525"></a>
+<span class="sourceLineNo">526</span> if (factory == null) {<a name="line.526"></a>
+<span class="sourceLineNo">527</span> if (isDiagnosticsEnabled()) {<a name="line.527"></a>
+<span class="sourceLineNo">528</span> logDiagnostic("[LOOKUP] Looking for a resource file of name [" + SERVICE_ID +<a name="line.528"></a>
+<span class="sourceLineNo">529</span> "] to define the LogFactory subclass to use...");<a name="line.529"></a>
+<span class="sourceLineNo">530</span> }<a name="line.530"></a>
+<span class="sourceLineNo">531</span> try {<a name="line.531"></a>
+<span class="sourceLineNo">532</span> final InputStream is = getResourceAsStream(contextClassLoader, SERVICE_ID);<a name="line.532"></a>
+<span class="sourceLineNo">533</span><a name="line.533"></a>
+<span class="sourceLineNo">534</span> if( is != null ) {<a name="line.534"></a>
+<span class="sourceLineNo">535</span> // This code is needed by EBCDIC and other strange systems.<a name="line.535"></a>
+<span class="sourceLineNo">536</span> // It's a fix for bugs reported in xerces<a name="line.536"></a>
+<span class="sourceLineNo">537</span> BufferedReader rd;<a name="line.537"></a>
+<span class="sourceLineNo">538</span> try {<a name="line.538"></a>
+<span class="sourceLineNo">539</span> rd = new BufferedReader(new InputStreamReader(is, "UTF-8"));<a name="line.539"></a>
+<span class="sourceLineNo">540</span> } catch (java.io.UnsupportedEncodingException e) {<a name="line.540"></a>
+<span class="sourceLineNo">541</span> rd = new BufferedReader(new InputStreamReader(is));<a name="line.541"></a>
+<span class="sourceLineNo">542</span> }<a name="line.542"></a>
+<span class="sourceLineNo">543</span><a name="line.543"></a>
+<span class="sourceLineNo">544</span> String factoryClassName = rd.readLine();<a name="line.544"></a>
+<span class="sourceLineNo">545</span> rd.close();<a name="line.545"></a>
+<span class="sourceLineNo">546</span><a name="line.546"></a>
+<span class="sourceLineNo">547</span> if (factoryClassName != null && ! "".equals(factoryClassName)) {<a name="line.547"></a>
+<span class="sourceLineNo">548</span> if (isDiagnosticsEnabled()) {<a name="line.548"></a>
+<span class="sourceLineNo">549</span> logDiagnostic("[LOOKUP] Creating an instance of LogFactory class " +<a name="line.549"></a>
+<span class="sourceLineNo">550</span> factoryClassName +<a name="line.550"></a>
+<span class="sourceLineNo">551</span> " as specified by file '" + SERVICE_ID +<a name="line.551"></a>
+<span class="sourceLineNo">552</span> "' which was present in the path of the context classloader.");<a name="line.552"></a>
+<span class="sourceLineNo">553</span> }<a name="line.553"></a>
+<span class="sourceLineNo">554</span> factory = newFactory(factoryClassName, baseClassLoader, contextClassLoader );<a name="line.554"></a>
+<span class="sourceLineNo">555</span> }<a name="line.555"></a>
+<span class="sourceLineNo">556</span> } else {<a name="line.556"></a>
+<span class="sourceLineNo">557</span> // is == null<a name="line.557"></a>
+<span class="sourceLineNo">558</span> if (isDiagnosticsEnabled()) {<a name="line.558"></a>
+<span class="sourceLineNo">559</span> logDiagnostic("[LOOKUP] No resource file with name '" + SERVICE_ID + "' found.");<a name="line.559"></a>
+<span class="sourceLineNo">560</span> }<a name="line.560"></a>
+<span class="sourceLineNo">561</span> }<a name="line.561"></a>
+<span class="sourceLineNo">562</span> } catch (Exception ex) {<a name="line.562"></a>
+<span class="sourceLineNo">563</span> // note: if the specified LogFactory class wasn't compatible with LogFactory<a name="line.563"></a>
+<span class="sourceLineNo">564</span> // for some reason, a ClassCastException will be caught here, and attempts will<a name="line.564"></a>
+<span class="sourceLineNo">565</span> // continue to find a compatible class.<a name="line.565"></a>
+<span class="sourceLineNo">566</span> if (isDiagnosticsEnabled()) {<a name="line.566"></a>
+<span class="sourceLineNo">567</span> logDiagnostic(<a name="line.567"></a>
+<span class="sourceLineNo">568</span> "[LOOKUP] A security exception occurred while trying to create an" +<a name="line.568"></a>
+<span class="sourceLineNo">569</span> " instance of the custom factory class" +<a name="line.569"></a>
+<span class="sourceLineNo">570</span> ": [" + trim(ex.getMessage()) +<a name="line.570"></a>
+<span class="sourceLineNo">571</span> "]. Trying alternative implementations...");<a name="line.571"></a>
+<span class="sourceLineNo">572</span> }<a name="line.572"></a>
+<span class="sourceLineNo">573</span> // ignore<a name="line.573"></a>
+<span class="sourceLineNo">574</span> }<a name="line.574"></a>
+<span class="sourceLineNo">575</span> }<a name="line.575"></a>
+<span class="sourceLineNo">576</span><a name="line.576"></a>
+<span class="sourceLineNo">577</span> // Third try looking into the properties file read earlier (if found)<a name="line.577"></a>
+<span class="sourceLineNo">578</span><a name="line.578"></a>
+<span class="sourceLineNo">579</span> if (factory == null) {<a name="line.579"></a>
+<span class="sourceLineNo">580</span> if (props != null) {<a name="line.580"></a>
+<span class="sourceLineNo">581</span> if (isDiagnosticsEnabled()) {<a name="line.581"></a>
+<span class="sourceLineNo">582</span> logDiagnostic(<a name="line.582"></a>
+<span class="sourceLineNo">583</span> "[LOOKUP] Looking in properties file for entry with key '" + FACTORY_PROPERTY +<a name="line.583"></a>
+<span class="sourceLineNo">584</span> "' to define the LogFactory subclass to use...");<a name="line.584"></a>
+<span class="sourceLineNo">585</span> }<a name="line.585"></a>
+<span class="sourceLineNo">586</span> String factoryClass = props.getProperty(FACTORY_PROPERTY);<a name="line.586"></a>
+<span class="sourceLineNo">587</span> if (factoryClass != null) {<a name="line.587"></a>
+<span class="sourceLineNo">588</span> if (isDiagnosticsEnabled()) {<a name="line.588"></a>
+<span class="sourceLineNo">589</span> logDiagnostic(<a name="line.589"></a>
+<span class="sourceLineNo">590</span> "[LOOKUP] Properties file specifies LogFactory subclass '" + factoryClass + "'");<a name="line.590"></a>
+<span class="sourceLineNo">591</span> }<a name="line.591"></a>
+<span class="sourceLineNo">592</span> factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);<a name="line.592"></a>
+<span class="sourceLineNo">593</span><a name="line.593"></a>
+<span class="sourceLineNo">594</span> // TODO: think about whether we need to handle exceptions from newFactory<a name="line.594"></a>
+<span class="sourceLineNo">595</span> } else {<a name="line.595"></a>
+<span class="sourceLineNo">596</span> if (isDiagnosticsEnabled()) {<a name="line.596"></a>
+<span class="sourceLineNo">597</span> logDiagnostic("[LOOKUP] Properties file has no entry specifying LogFactory subclass.");<a name="line.597"></a>
+<span class="sourceLineNo">598</span> }<a name="line.598"></a>
+<span class="sourceLineNo">599</span> }<a name="line.599"></a>
+<span class="sourceLineNo">600</span> } else {<a name="line.600"></a>
+<span class="sourceLineNo">601</span> if (isDiagnosticsEnabled()) {<a name="line.601"></a>
+<span class="sourceLineNo">602</span> logDiagnostic("[LOOKUP] No properties file available to determine" + " LogFactory subclass from..");<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><a name="line.606"></a>
+<span class="sourceLineNo">607</span> // Fourth, try the fallback implementation class<a name="line.607"></a>
+<span class="sourceLineNo">608</span><a name="line.608"></a>
+<span class="sourceLineNo">609</span> if (factory == null) {<a name="line.609"></a>
+<span class="sourceLineNo">610</span> if (isDiagnosticsEnabled()) {<a name="line.610"></a>
+<span class="sourceLineNo">611</span> logDiagnostic(<a name="line.611"></a>
+<span class="sourceLineNo">612</span> "[LOOKUP] Loading the default LogFactory implementation '" + FACTORY_DEFAULT +<a name="line.612"></a>
+<span class="sourceLineNo">613</span> "' via the same classloader that loaded this LogFactory" +<a name="line.613"></a>
+<span class="sourceLineNo">614</span> " class (ie not looking in the context classloader).");<a name="line.614"></a>
+<span class="sourceLineNo">615</span> }<a name="line.615"></a>
+<span class="sourceLineNo">616</span><a name="line.616"></a>
+<span class="sourceLineNo">617</span> // Note: unlike the above code which can try to load custom LogFactory<a name="line.617"></a>
+<span class="sourceLineNo">618</span> // implementations via the TCCL, we don't try to load the default LogFactory<a name="line.618"></a>
+<span class="sourceLineNo">619</span> // implementation via the context classloader because:<a name="line.619"></a>
+<span class="sourceLineNo">620</span> // * that can cause problems (see comments in newFactory method)<a name="line.620"></a>
+<span class="sourceLineNo">621</span> // * no-one should be customising the code of the default class<a name="line.621"></a>
+<span class="sourceLineNo">622</span> // Yes, we do give up the ability for the child to ship a newer<a name="line.622"></a>
+<span class="sourceLineNo">623</span> // version of the LogFactoryImpl class and have it used dynamically<a name="line.623"></a>
+<span class="sourceLineNo">624</span> // by an old LogFactory class in the parent, but that isn't<a name="line.624"></a>
+<span class="sourceLineNo">625</span> // necessarily a good idea anyway.<a name="line.625"></a>
+<span class="sourceLineNo">626</span> factory = newFactory(FACTORY_DEFAULT, thisClassLoader, contextClassLoader);<a name="line.626"></a>
+<span class="sourceLineNo">627</span> }<a name="line.627"></a>
+<span class="sourceLineNo">628</span><a name="line.628"></a>
+<span class="sourceLineNo">629</span> if (factory != null) {<a name="line.629"></a>
+<span class="sourceLineNo">630</span> /**<a name="line.630"></a>
+<span class="sourceLineNo">631</span> * Always cache using context class loader.<a name="line.631"></a>
+<span class="sourceLineNo">632</span> */<a name="line.632"></a>
+<span class="sourceLineNo">633</span> cacheFactory(contextClassLoader, factory);<a name="line.633"></a>
+<span class="sourceLineNo">634</span><a name="line.634"></a>
+<span class="sourceLineNo">635</span> if (props != null) {<a name="line.635"></a>
+<span class="sourceLineNo">636</span> Enumeration names = props.propertyNames();<a name="line.636"></a>
+<span class="sourceLineNo">637</span> while (names.hasMoreElements()) {<a name="line.637"></a>
+<span class="sourceLineNo">638</span> String name = (String) names.nextElement();<a name="line.638"></a>
+<span class="sourceLineNo">639</span> String value = props.getProperty(name);<a name="line.639"></a>
+<span class="sourceLineNo">640</span> factory.setAttribute(name, value);<a name="line.640"></a>
+<span class="sourceLineNo">641</span> }<a name="line.641"></a>
+<span class="sourceLineNo">642</span> }<a name="line.642"></a>
+<span class="sourceLineNo">643</span> }<a name="line.643"></a>
+<span class="sourceLineNo">644</span><a name="line.644"></a>
+<span class="sourceLineNo">645</span> return factory;<a name="line.645"></a>
+<span class="sourceLineNo">646</span> }<a name="line.646"></a>
+<span class="sourceLineNo">647</span><a name="line.647"></a>
+<span class="sourceLineNo">648</span> /**<a name="line.648"></a>
+<span class="sourceLineNo">649</span> * Convenience method to return a named logger, without the application<a name="line.649"></a>
+<span class="sourceLineNo">650</span> * having to care about factories.<a name="line.650"></a>
+<span class="sourceLineNo">651</span> *<a name="line.651"></a>
+<span class="sourceLineNo">652</span> * @param clazz Class from which a log name will be derived<a name="line.652"></a>
+<span class="sourceLineNo">653</span> * @throws LogConfigurationException if a suitable <code>Log</code><a name="line.653"></a>
+<span class="sourceLineNo">654</span> * instance cannot be returned<a name="line.654"></a>
+<span class="sourceLineNo">655</span> */<a name="line.655"></a>
+<span class="sourceLineNo">656</span> public static Log getLog(Class clazz) throws LogConfigurationException {<a name="line.656"></a>
+<span class="sourceLineNo">657</span> return getFactory().getInstance(clazz);<a name="line.657"></a>
+<span class="sourceLineNo">658</span> }<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> * Convenience method to return a named logger, without the application<a name="line.661"></a>
+<span class="sourceLineNo">662</span> * having to care about factories.<a name="line.662"></a>
+<span class="sourceLineNo">663</span> *<a name="line.663"></a>
+<span class="sourceLineNo">664</span> * @param name Logical name of the <code>Log</code> instance to be<a name="line.664"></a>
+<span class="sourceLineNo">665</span> * returned (the meaning of this name is only known to the underlying<a name="line.665"></a>
+<span class="sourceLineNo">666</span> * logging implementation that is being wrapped)<a name="line.666"></a>
+<span class="sourceLineNo">667</span> * @throws LogConfigurationException if a suitable <code>Log</code><a name="line.667"></a>
+<span class="sourceLineNo">668</span> * instance cannot be returned<a name="line.668"></a>
+<span class="sourceLineNo">669</span> */<a name="line.669"></a>
+<span class="sourceLineNo">670</span> public static Log getLog(String name) throws LogConfigurationException {<a name="line.670"></a>
+<span class="sourceLineNo">671</span> return getFactory().getInstance(name);<a name="line.671"></a>
+<span class="sourceLineNo">672</span> }<a name="line.672"></a>
+<span class="sourceLineNo">673</span><a name="line.673"></a>
+<span class="sourceLineNo">674</span> /**<a name="line.674"></a>
+<span class="sourceLineNo">675</span> * Release any internal references to previously created {@link LogFactory}<a name="line.675"></a>
+<span class="sourceLineNo">676</span> * instances that have been associated with the specified class loader<a name="line.676"></a>
+<span class="sourceLineNo">677</span> * (if any), after calling the instance method <code>release()</code> on<a name="line.677"></a>
+<span class="sourceLineNo">678</span> * each of them.<a name="line.678"></a>
+<span class="sourceLineNo">679</span> *<a name="line.679"></a>
+<span class="sourceLineNo">680</span> * @param classLoader ClassLoader for which to release the LogFactory<a name="line.680"></a>
+<span class="sourceLineNo">681</span> */<a name="line.681"></a>
+<span class="sourceLineNo">682</span> public static void release(ClassLoader classLoader) {<a name="line.682"></a>
+<span class="sourceLineNo">683</span> if (isDiagnosticsEnabled()) {<a name="line.683"></a>
+<span class="sourceLineNo">684</span> logDiagnostic("Releasing factory for classloader " + objectId(classLoader));<a name="line.684"></a>
+<span class="sourceLineNo">685</span> }<a name="line.685"></a>
+<span class="sourceLineNo">686</span> // factories is not final and could be replaced in this block.<a name="line.686"></a>
+<span class="sourceLineNo">687</span> final Hashtable factories = LogFactory.factories;<a name="line.687"></a>
+<span class="sourceLineNo">688</span> synchronized (factories) {<a name="line.688"></a>
+<span class="sourceLineNo">689</span> if (classLoader == null) {<a name="line.689"></a>
+<span class="sourceLineNo">690</span> if (nullClassLoaderFactory != null) {<a name="line.690"></a>
+<span class="sourceLineNo">691</span> nullClassLoaderFactory.release();<a name="line.691"></a>
+<span class="sourceLineNo">692</span> nullClassLoaderFactory = null;<a name="line.692"></a>
+<span class="sourceLineNo">693</span> }<a name="line.693"></a>
+<span class="sourceLineNo">694</span> } else {<a name="line.694"></a>
+<span class="sourceLineNo">695</span> final LogFactory factory = (LogFactory) factories.get(classLoader);<a name="line.695"></a>
+<span class="sourceLineNo">696</span> if (factory != null) {<a name="line.696"></a>
+<span class="sourceLineNo">697</span> factory.release();<a name="line.697"></a>
+<span class="sourceLineNo">698</span> factories.remove(classLoader);<a name="line.698"></a>
+<span class="sourceLineNo">699</span> }<a name="line.699"></a>
+<span class="sourceLineNo">700</span> }<a name="line.700"></a>
+<span class="sourceLineNo">701</span> }<a name="line.701"></a>
+<span class="sourceLineNo">702</span> }<a name="line.702"></a>
+<span class="sourceLineNo">703</span><a name="line.703"></a>
+<span class="sourceLineNo">704</span> /**<a name="line.704"></a>
+<span class="sourceLineNo">705</span> * Release any internal references to previously created {@link LogFactory}<a name="line.705"></a>
+<span class="sourceLineNo">706</span> * instances, after calling the instance method <code>release()</code> on<a name="line.706"></a>
+<span class="sourceLineNo">707</span> * each of them. This is useful in environments like servlet containers,<a name="line.707"></a>
+<span class="sourceLineNo">708</span> * which implement application reloading by throwing away a ClassLoader.<a name="line.708"></a>
+<span class="sourceLineNo">709</span> * Dangling references to objects in that class loader would prevent<a name="line.709"></a>
+<span class="sourceLineNo">710</span> * garbage collection.<a name="line.710"></a>
+<span class="sourceLineNo">711</span> */<a name="line.711"></a>
+<span class="sourceLineNo">712</span> public static void releaseAll() {<a name="line.712"></a>
+<span class="sourceLineNo">713</span> if (isDiagnosticsEnabled()) {<a name="line.713"></a>
+<span class="sourceLineNo">714</span> logDiagnostic("Releasing factory for all classloaders.");<a name="line.714"></a>
+<span class="sourceLineNo">715</span> }<a name="line.715"></a>
+<span class="sourceLineNo">716</span> // factories is not final and could be replaced in this block.<a name="line.716"></a>
+<span class="sourceLineNo">717</span> final Hashtable factories = LogFactory.factories;<a name="line.717"></a>
+<span class="sourceLineNo">718</span> synchronized (factories) {<a name="line.718"></a>
+<span class="sourceLineNo">719</span> final Enumeration elements = factories.elements();<a name="line.719"></a>
+<span class="sourceLineNo">720</span> while (elements.hasMoreElements()) {<a name="line.720"></a>
+<span class="sourceLineNo">721</span> LogFactory element = (LogFactory) elements.nextElement();<a name="line.721"></a>
+<span class="sourceLineNo">722</span> element.release();<a name="line.722"></a>
+<span class="sourceLineNo">723</span> }<a name="line.723"></a>
+<span class="sourceLineNo">724</span> factories.clear();<a name="line.724"></a>
+<span class="sourceLineNo">725</span><a name="line.725"></a>
+<span class="sourceLineNo">726</span> if (nullClassLoaderFactory != null) {<a name="line.726"></a>
+<span class="sourceLineNo">727</span> nullClassLoaderFactory.release();<a name="line.727"></a>
+<span class="sourceLineNo">728</span> nullClassLoaderFactory = null;<a name="line.728"></a>
+<span class="sourceLineNo">729</span> }<a name="line.729"></a>
+<span class="sourceLineNo">730</span> }<a name="line.730"></a>
+<span class="sourceLineNo">731</span> }<a name="line.731"></a>
+<span class="sourceLineNo">732</span><a name="line.732"></a>
+<span class="sourceLineNo">733</span> // ------------------------------------------------------ Protected Methods<a name="line.733"></a>
+<span class="sourceLineNo">734</span><a name="line.734"></a>
+<span class="sourceLineNo">735</span> /**<a name="line.735"></a>
+<span class="sourceLineNo">736</span> * Safely get access to the classloader for the specified class.<a name="line.736"></a>
+<span class="sourceLineNo">737</span> * <p><a name="line.737"></a>
+<span class="sourceLineNo">738</span> * Theoretically, calling getClassLoader can throw a security exception,<a name="line.738"></a>
+<span class="sourceLineNo">739</span> * and so should be done under an AccessController in order to provide<a name="line.739"></a>
+<span class="sourceLineNo">740</span> * maximum flexibility. However in practice people don't appear to use<a name="line.740"></a>
+<span class="sourceLineNo">741</span> * security policies that forbid getClassLoader calls. So for the moment<a name="line.741"></a>
+<span class="sourceLineNo">742</span> * all code is written to call this method rather than Class.getClassLoader,<a name="line.742"></a>
+<span class="sourceLineNo">743</span> * so that we could put AccessController stuff in this method without any<a name="line.743"></a>
+<span class="sourceLineNo">744</span> * disruption later if we need to.<a name="line.744"></a>
+<span class="sourceLineNo">745</span> * <p><a name="line.745"></a>
+<span class="sourceLineNo">746</span> * Even when using an AccessController, however, this method can still<a name="line.746"></a>
+<span class="sourceLineNo">747</span> * throw SecurityException. Commons-logging basically relies on the<a name="line.747"></a>
+<span class="sourceLineNo">748</span> * ability to access classloaders, ie a policy that forbids all<a name="line.748"></a>
+<span class="sourceLineNo">749</span> * classloader access will also prevent commons-logging from working:<a name="line.749"></a>
+<span class="sourceLineNo">750</span> * currently this method will throw an exception preventing the entire app<a name="line.750"></a>
+<span class="sourceLineNo">751</span> * from starting up. Maybe it would be good to detect this situation and<a name="line.751"></a>
+<span class="sourceLineNo">752</span> * just disable all commons-logging? Not high priority though - as stated<a name="line.752"></a>
+<span class="sourceLineNo">753</span> * above, security policies that prevent classloader access aren't common.<a name="line.753"></a>
+<span class="sourceLineNo">754</span> * <p><a name="line.754"></a>
+<span class="sourceLineNo">755</span> * Note that returning an object fetched via an AccessController would<a name="line.755"></a>
+<span class="sourceLineNo">756</span> * technically be a security flaw anyway; untrusted code that has access<a name="line.756"></a>
+<span class="sourceLineNo">757</span> * to a trusted JCL library could use it to fetch the classloader for<a name="line.757"></a>
+<span class="sourceLineNo">758</span> * a class even when forbidden to do so directly.<a name="line.758"></a>
+<span class="sourceLineNo">759</span> *<a name="line.759"></a>
+<span class="sourceLineNo">760</span> * @since 1.1<a name="line.760"></a>
+<span class="sourceLineNo">761</span> */<a name="line.761"></a>
+<span class="sourceLineNo">762</span> protected static ClassLoader getClassLoader(Class clazz) {<a name="line.762"></a>
+<span class="sourceLineNo">763</span> try {<a name="line.763"></a>
+<span class="sourceLineNo">764</span> return clazz.getClassLoader();<a name="line.764"></a>
+<span class="sourceLineNo">765</span> } catch (SecurityException ex) {<a name="line.765"></a>
+<span class="sourceLineNo">766</span> if (isDiagnosticsEnabled()) {<a name="line.766"></a>
+<span class="sourceLineNo">767</span> logDiagnostic("Unable to get classloader for class '" + clazz +<a name="line.767"></a>
+<span class="sourceLineNo">768</span> "' due to security restrictions - " + ex.getMessage());<a name="line.768"></a>
+<span class="sourceLineNo">769</span> }<a name="line.769"></a>
+<span class="sourceLineNo">770</span> throw ex;<a name="line.770"></a>
+<span class="sourceLineNo">771</span> }<a name="line.771"></a>
+<span class="sourceLineNo">772</span> }<a name="line.772"></a>
+<span class="sourceLineNo">773</span><a name="line.773"></a>
+<span class="sourceLineNo">774</span> /**<a name="line.774"></a>
+<span class="sourceLineNo">775</span> * Returns the current context classloader.<a name="line.775"></a>
+<span class="sourceLineNo">776</span> * <p><a name="line.776"></a>
+<span class="sourceLineNo">777</span> * In versions prior to 1.1, this method did not use an AccessController.<a name="line.777"></a>
+<span class="sourceLineNo">778</span> * In version 1.1, an AccessController wrapper was incorrectly added to<a name="line.778"></a>
+<span class="sourceLineNo">779</span> * this method, causing a minor security flaw.<a name="line.779"></a>
+<span class="sourceLineNo">780</span> * <p><a name="line.780"></a>
+<span class="sourceLineNo">781</span> * In version 1.1.1 this change was reverted; this method no longer uses<a name="line.781"></a>
+<span class="sourceLineNo">782</span> * an AccessController. User code wishing to obtain the context classloader<a name="line.782"></a>
+<span class="sourceLineNo">783</span> * must invoke this method via AccessController.doPrivileged if it needs<a name="line.783"></a>
+<span class="sourceLineNo">784</span> * support for that.<a name="line.784"></a>
+<span class="sourceLineNo">785</span> *<a name="line.785"></a>
+<span class="sourceLineNo">786</span> * @return the context classloader associated with the current thread,<a name="line.786"></a>
+<span class="sourceLineNo">787</span> * or null if security doesn't allow it.<a name="line.787"></a>
+<span class="sourceLineNo">788</span> * @throws LogConfigurationException if there was some weird error while<a name="line.788"></a>
+<span class="sourceLineNo">789</span> * attempting to get the context classloader.<a name="line.789"></a>
+<span class="sourceLineNo">790</span> * @throws SecurityException if the current java security policy doesn't<a name="line.790"></a>
+<span class="sourceLineNo">791</span> * allow this class to access the context classloader.<a name="line.791"></a>
+<span class="sourceLineNo">792</span> */<a name="line.792"></a>
+<span class="sourceLineNo">793</span> protected static ClassLoader getContextClassLoader() throws LogConfigurationException {<a name="line.793"></a>
+<span class="sourceLineNo">794</span> return directGetContextClassLoader();<a name="line.794"></a>
+<span class="sourceLineNo">795</span> }<a name="line.795"></a>
+<span class="sourceLineNo">796</span><a name="line.796"></a>
+<span class="sourceLineNo">797</span> /**<a name="line.797"></a>
+<span class="sourceLineNo">798</span> * Calls LogFactory.directGetContextClassLoader under the control of an<a name="line.798"></a>
+<span class="sourceLineNo">799</span> * AccessController class. This means that java code running under a<a name="line.799"></a>
+<span class="sourceLineNo">800</span> * security manager that forbids access to ClassLoaders will still work<a name="line.800"></a>
+<span class="sourceLineNo">801</span> * if this class is given appropriate privileges, even when the caller<a name="line.801"></a>
+<span class="sourceLineNo">802</span> * doesn't have such privileges. Without using an AccessController, the<a name="line.802"></a>
+<span class="sourceLineNo">803</span> * the entire call stack must have the privilege before the call is<a name="line.803"></a>
+<span class="sourceLineNo">804</span> * allowed.<a name="line.804"></a>
+<span class="sourceLineNo">805</span> *<a name="line.805"></a>
+<span class="sourceLineNo">806</span> * @return the context classloader associated with the current thread,<a name="line.806"></a>
+<span class="sourceLineNo">807</span> * or null if security doesn't allow it.<a name="line.807"></a>
+<span class="sourceLineNo">808</span> * @throws LogConfigurationException if there was some weird error while<a name="line.808"></a>
+<span class="sourceLineNo">809</span> * attempting to get the context classloader.<a name="line.809"></a>
+<span class="sourceLineNo">810</span> * @throws SecurityException if the current java security policy doesn't<a name="line.810"></a>
+<span class="sourceLineNo">811</span> * allow this class to access the context classloader.<a name="line.811"></a>
+<span class="sourceLineNo">812</span> */<a name="line.812"></a>
+<span class="sourceLineNo">813</span> private static ClassLoader getContextClassLoaderInternal() throws LogConfigurationException {<a name="line.813"></a>
+<span class="sourceLineNo">814</span> return (ClassLoader)AccessController.doPrivileged(<a name="line.814"></a>
+<span class="sourceLineNo">815</span> new PrivilegedAction() {<a name="line.815"></a>
+<span class="sourceLineNo">816</span> public Object run() {<a name="line.816"></a>
+<span class="sourceLineNo">817</span> return directGetContextClassLoader();<a name="line.817"></a>
+<span class="sourceLineNo">818</span> }<a name="line.818"></a>
+<span class="sourceLineNo">819</span> });<a name="line.819"></a>
+<span class="sourceLineNo">820</span> }<a name="line.820"></a>
+<span class="sourceLineNo">821</span><a name="line.821"></a>
+<span class="sourceLineNo">822</span> /**<a name="line.822"></a>
+<span class="sourceLineNo">823</span> * Return the thread context class loader if available; otherwise return null.<a name="line.823"></a>
+<span class="sourceLineNo">824</span> * <p><a name="line.824"></a>
+<span class="sourceLineNo">825</span> * Most/all code should call getContextClassLoaderInternal rather than<a name="line.825"></a>
+<span class="sourceLineNo">826</span> * calling this method directly.<a name="line.826"></a>
+<span class="sourceLineNo">827</span> * <p><a name="line.827"></a>
+<span class="sourceLineNo">828</span> * The thread context class loader is available for JDK 1.2<a name="line.828"></a>
+<span class="sourceLineNo">829</span> * or later, if certain security conditions are met.<a name="line.829"></a>
+<span class="sourceLineNo">830</span> * <p><a name="line.830"></a>
+<span class="sourceLineNo">831</span> * Note that no internal logging is done within this method because<a name="line.831"></a>
+<span class="sourceLineNo">832</span> * this method is called every time LogFactory.getLogger() is called,<a name="line.832"></a>
+<span class="sourceLineNo">833</span> * and we don't want too much output generated here.<a name="line.833"></a>
+<span class="sourceLineNo">834</span> *<a name="line.834"></a>
+<span class="sourceLineNo">835</span> * @throws LogConfigurationException if a suitable class loader<a name="line.835"></a>
+<span class="sourceLineNo">836</span> * cannot be identified.<a name="line.836"></a>
[... 976 lines stripped ...]