| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>LogManager xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/velocity/runtime/log/LogManager.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.log; |
| <a name="2" href="#2">2</a> |
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> *</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em> |
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ClassUtils; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * This class is responsible for instantiating the correct LogChute</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The approach is :</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <li></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * First try to see if the user is passing in a living object</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * that is a LogChute, allowing the app to give its living</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * custom loggers.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <li></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Next, run through the (possible) list of classes specified</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * specified as loggers, taking the first one that appears to</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * work. This is how we support finding logkit, log4j or</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * jdk logging, whichever is in the classpath and found first,</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * as all three are listed as defaults.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <li></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Finally, we turn to the System.err stream and print log messages</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * to it if nothing else works.</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl</a></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jon@latchkey.com" target="alexandria_uri">mailto:jon@latchkey.com</a>">Jon S. Stevens</a></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>">Geir Magnusson Jr.</a></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:nbubna@apache.org" target="alexandria_uri">mailto:nbubna@apache.org</a>">Nathan Bubna</a></em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @version $Id: LogManager.java 490011 2006-12-24 12:19:09Z henning $</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/runtime/log/LogManager.html">LogManager</a> |
| <a name="63" href="#63">63</a> { |
| <a name="64" href="#64">64</a> <em class="jxr_comment">// Creates a new logging system or returns an existing one</em> |
| <a name="65" href="#65">65</a> <em class="jxr_comment">// specified by the application.</em> |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> createLogChute(<a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rsvc) <strong class="jxr_keyword">throws</strong> Exception |
| <a name="67" href="#67">67</a> { |
| <a name="68" href="#68">68</a> <a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log = rsvc.getLog(); |
| <a name="69" href="#69">69</a> |
| <a name="70" href="#70">70</a> <em class="jxr_comment">/*<em class="jxr_comment"> If a LogChute or LogSystem instance was set as a configuration</em></em> |
| <a name="71" href="#71">71</a> <em class="jxr_comment"> * value, use that. This is any class the user specifies.</em> |
| <a name="72" href="#72">72</a> <em class="jxr_comment"> */</em> |
| <a name="73" href="#73">73</a> Object o = rsvc.getProperty(RuntimeConstants.RUNTIME_LOG_LOGSYSTEM); |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">if</strong> (o != <strong class="jxr_keyword">null</strong>) |
| <a name="75" href="#75">75</a> { |
| <a name="76" href="#76">76</a> <em class="jxr_comment">// first check for a LogChute</em> |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">if</strong> (o instanceof LogChute) |
| <a name="78" href="#78">78</a> { |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">try</strong> |
| <a name="80" href="#80">80</a> { |
| <a name="81" href="#81">81</a> ((<a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a>)o).init(rsvc); |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> (LogChute)o; |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">catch</strong> (Exception e) |
| <a name="85" href="#85">85</a> { |
| <a name="86" href="#86">86</a> log.error(<span class="jxr_string">"Could not init runtime.log.logsystem "</span> + o, e); |
| <a name="87" href="#87">87</a> } |
| <a name="88" href="#88">88</a> } |
| <a name="89" href="#89">89</a> <em class="jxr_comment">// then check for a LogSystem</em> |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (o instanceof LogSystem) |
| <a name="91" href="#91">91</a> { |
| <a name="92" href="#92">92</a> <em class="jxr_comment">// inform the user about the deprecation</em> |
| <a name="93" href="#93">93</a> log.info(<span class="jxr_string">"LogSystem has been deprecated. Please use a LogChute implementation."</span>); |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">try</strong> |
| <a name="95" href="#95">95</a> { |
| <a name="96" href="#96">96</a> <em class="jxr_comment">// wrap the LogSystem into a chute.</em> |
| <a name="97" href="#97">97</a> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> chute = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/log/LogChuteSystem.html">LogChuteSystem</a>((LogSystem)o); |
| <a name="98" href="#98">98</a> chute.init(rsvc); |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">return</strong> chute; |
| <a name="100" href="#100">100</a> } |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">catch</strong> (Exception e) |
| <a name="102" href="#102">102</a> { |
| <a name="103" href="#103">103</a> log.error(<span class="jxr_string">"Could not init runtime.log.logsystem "</span> + o, e); |
| <a name="104" href="#104">104</a> } |
| <a name="105" href="#105">105</a> } |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">else</strong> |
| <a name="107" href="#107">107</a> { |
| <a name="108" href="#108">108</a> log.warn(o.getClass().getName() + <span class="jxr_string">" object set as runtime.log.logsystem is not a valid log implementation."</span>); |
| <a name="109" href="#109">109</a> } |
| <a name="110" href="#110">110</a> } |
| <a name="111" href="#111">111</a> |
| <a name="112" href="#112">112</a> <em class="jxr_comment">/*<em class="jxr_comment"> otherwise, see if a class was specified. You can put multiple</em></em> |
| <a name="113" href="#113">113</a> <em class="jxr_comment"> * classes, and we use the first one we find.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_comment"> *</em> |
| <a name="115" href="#115">115</a> <em class="jxr_comment"> * Note that the default value of this property contains the</em> |
| <a name="116" href="#116">116</a> <em class="jxr_comment"> * AvalonLogChute, the Log4JLogChute, and the JdkLogChute for</em> |
| <a name="117" href="#117">117</a> <em class="jxr_comment"> * convenience - so we use whichever we find first.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_comment"> */</em> |
| <a name="119" href="#119">119</a> List classes = <strong class="jxr_keyword">new</strong> ArrayList(); |
| <a name="120" href="#120">120</a> Object obj = rsvc.getProperty( RuntimeConstants.RUNTIME_LOG_LOGSYSTEM_CLASS ); |
| <a name="121" href="#121">121</a> |
| <a name="122" href="#122">122</a> <em class="jxr_comment">/*</em> |
| <a name="123" href="#123">123</a> <em class="jxr_comment"> * we might have a list, or not - so check</em> |
| <a name="124" href="#124">124</a> <em class="jxr_comment"> */</em> |
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">if</strong> ( obj instanceof List) |
| <a name="126" href="#126">126</a> { |
| <a name="127" href="#127">127</a> classes = (List) obj; |
| <a name="128" href="#128">128</a> } |
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( obj instanceof String) |
| <a name="130" href="#130">130</a> { |
| <a name="131" href="#131">131</a> classes.add( obj ); |
| <a name="132" href="#132">132</a> } |
| <a name="133" href="#133">133</a> |
| <a name="134" href="#134">134</a> <em class="jxr_comment">/*</em> |
| <a name="135" href="#135">135</a> <em class="jxr_comment"> * now run through the list, trying each. It's ok to</em> |
| <a name="136" href="#136">136</a> <em class="jxr_comment"> * fail with a class not found, as we do this to also</em> |
| <a name="137" href="#137">137</a> <em class="jxr_comment"> * search out a default simple file logger</em> |
| <a name="138" href="#138">138</a> <em class="jxr_comment"> */</em> |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">for</strong>( Iterator ii = classes.iterator(); ii.hasNext(); ) |
| <a name="140" href="#140">140</a> { |
| <a name="141" href="#141">141</a> String claz = (String) ii.next(); |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">if</strong> (claz != <strong class="jxr_keyword">null</strong> && claz.length() > 0 ) |
| <a name="143" href="#143">143</a> { |
| <a name="144" href="#144">144</a> log.debug(<span class="jxr_string">"Trying to use logger class "</span> + claz ); |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">try</strong> |
| <a name="146" href="#146">146</a> { |
| <a name="147" href="#147">147</a> o = ClassUtils.getNewInstance( claz ); |
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (o instanceof LogChute) |
| <a name="149" href="#149">149</a> { |
| <a name="150" href="#150">150</a> ((<a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a>)o).init(rsvc); |
| <a name="151" href="#151">151</a> log.debug(<span class="jxr_string">"Using logger class "</span> + claz); |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> (LogChute)o; |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (o instanceof LogSystem) |
| <a name="155" href="#155">155</a> { |
| <a name="156" href="#156">156</a> <em class="jxr_comment">// inform the user about the deprecation</em> |
| <a name="157" href="#157">157</a> log.info(<span class="jxr_string">"LogSystem has been deprecated. Please use a LogChute implementation."</span>); |
| <a name="158" href="#158">158</a> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> chute = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/log/LogChuteSystem.html">LogChuteSystem</a>((LogSystem)o); |
| <a name="159" href="#159">159</a> chute.init(rsvc); |
| <a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> chute; |
| <a name="161" href="#161">161</a> } |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">else</strong> |
| <a name="163" href="#163">163</a> { |
| <a name="164" href="#164">164</a> log.error(<span class="jxr_string">"The specifid logger class "</span> + claz + |
| <a name="165" href="#165">165</a> <span class="jxr_string">" isn't a valid LogChute implementation."</span>); |
| <a name="166" href="#166">166</a> } |
| <a name="167" href="#167">167</a> } |
| <a name="168" href="#168">168</a> <strong class="jxr_keyword">catch</strong>(NoClassDefFoundError ncdfe) |
| <a name="169" href="#169">169</a> { |
| <a name="170" href="#170">170</a> <em class="jxr_comment">// note these errors for anyone debugging the app</em> |
| <a name="171" href="#171">171</a> log.debug(<span class="jxr_string">"Couldn't find class "</span> + claz + |
| <a name="172" href="#172">172</a> <span class="jxr_string">" or necessary supporting classes in classpath."</span>, |
| <a name="173" href="#173">173</a> ncdfe); |
| <a name="174" href="#174">174</a> } |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">catch</strong>(Exception e) |
| <a name="176" href="#176">176</a> { |
| <a name="177" href="#177">177</a> <em class="jxr_comment">// log init exception at slightly higher priority</em> |
| <a name="178" href="#178">178</a> log.info(<span class="jxr_string">"Failed to initialize an instance of "</span> + claz + |
| <a name="179" href="#179">179</a> <span class="jxr_string">" with the current runtime configuration."</span>, e); |
| <a name="180" href="#180">180</a> } |
| <a name="181" href="#181">181</a> } |
| <a name="182" href="#182">182</a> } |
| <a name="183" href="#183">183</a> |
| <a name="184" href="#184">184</a> <em class="jxr_comment">/*<em class="jxr_comment"> If the above failed, that means either the user specified a</em></em> |
| <a name="185" href="#185">185</a> <em class="jxr_comment"> * logging class that we can't find, there weren't the necessary</em> |
| <a name="186" href="#186">186</a> <em class="jxr_comment"> * dependencies in the classpath for it, or there were the same</em> |
| <a name="187" href="#187">187</a> <em class="jxr_comment"> * problems for the default loggers, log4j and Java1.4+.</em> |
| <a name="188" href="#188">188</a> <em class="jxr_comment"> * Since we really don't know and we want to be sure the user knows</em> |
| <a name="189" href="#189">189</a> <em class="jxr_comment"> * that something went wrong with the logging, let's fall back to the</em> |
| <a name="190" href="#190">190</a> <em class="jxr_comment"> * surefire SystemLogChute. No panicking or failing to log!!</em> |
| <a name="191" href="#191">191</a> <em class="jxr_comment"> */</em> |
| <a name="192" href="#192">192</a> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> slc = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/runtime/log/SystemLogChute.html">SystemLogChute</a>(); |
| <a name="193" href="#193">193</a> slc.init(rsvc); |
| <a name="194" href="#194">194</a> log.debug(<span class="jxr_string">"Using SystemLogChute."</span>); |
| <a name="195" href="#195">195</a> <strong class="jxr_keyword">return</strong> slc; |
| <a name="196" href="#196">196</a> } |
| <a name="197" href="#197">197</a> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * Update the Log instance with the appropriate LogChute and other</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * settings determined by the RuntimeServices.</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * @param log</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * @param rsvc</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @throws Exception</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> updateLog(<a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log, <a href="../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rsvc) <strong class="jxr_keyword">throws</strong> Exception |
| <a name="206" href="#206">206</a> { |
| <a name="207" href="#207">207</a> <em class="jxr_comment">// create a new LogChute using the RuntimeServices</em> |
| <a name="208" href="#208">208</a> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> newLogChute = createLogChute(rsvc); |
| <a name="209" href="#209">209</a> <a href="../../../../../org/apache/velocity/runtime/log/LogChute.html">LogChute</a> oldLogChute = log.getLogChute(); |
| <a name="210" href="#210">210</a> |
| <a name="211" href="#211">211</a> <em class="jxr_comment">// If the old LogChute was the pre-Init logger,</em> |
| <a name="212" href="#212">212</a> <em class="jxr_comment">// dump its messages into the new system first.</em> |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (oldLogChute instanceof HoldingLogChute) |
| <a name="214" href="#214">214</a> { |
| <a name="215" href="#215">215</a> <a href="../../../../../org/apache/velocity/runtime/log/HoldingLogChute.html">HoldingLogChute</a> hlc = (HoldingLogChute)oldLogChute; |
| <a name="216" href="#216">216</a> hlc.transferTo(newLogChute); |
| <a name="217" href="#217">217</a> } |
| <a name="218" href="#218">218</a> |
| <a name="219" href="#219">219</a> <em class="jxr_comment">// pass the new LogChute to the log</em> |
| <a name="220" href="#220">220</a> log.setLogChute(newLogChute); |
| <a name="221" href="#221">221</a> } |
| <a name="222" href="#222">222</a> |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
