Modified: logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/LoggingEventFieldResolver.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/LoggingEventFieldResolver.html?rev=569263&r1=569262&r2=569263&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/LoggingEventFieldResolver.html (original) +++ logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/LoggingEventFieldResolver.html Thu Aug 23 23:01:46 2007 @@ -29,245 +29,244 @@ <a name="20" href="#20">20</a> <strong>import</strong> java.util.ArrayList; <a name="21" href="#21">21</a> <strong>import</strong> java.util.List; <a name="22" href="#22">22</a> <strong>import</strong> java.util.StringTokenizer; -<a name="23" href="#23">23</a> +<a name="23" href="#23">23</a> <strong>import</strong> java.util.Locale; <a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <a name="26" href="#26">26</a> <em>/**<em>*</em></em> <a name="27" href="#27">27</a> <em> * A singleton helper utility which accepts a field name</em> -<a name="28" href="#28">28</a> <em> * and a LoggingEvent and returns the</em> -<a name="29" href="#29">29</a> <em> * String value of that field.</em> -<a name="30" href="#30">30</a> <em> *</em> -<a name="31" href="#31">31</a> <em> * This class defines a grammar used in creation of an expression-based Rule.</em> -<a name="32" href="#32">32</a> <em> *</em> -<a name="33" href="#33">33</a> <em> * The only available method is</em> -<a name="34" href="#34">34</a> <em> * Object getField(String fieldName, LoggingEvent event).</em> -<a name="35" href="#35">35</a> <em> *</em> -<a name="36" href="#36">36</a> <em> * Here is a description of the mapping of field names in the grammar</em> -<a name="37" href="#37">37</a> <em> * to fields on the logging event. While the getField method returns an Object,</em> -<a name="38" href="#38">38</a> <em> * the individual types returned per field are described here:</em> -<a name="39" href="#39">39</a> <em> *</em> -<a name="40" href="#40">40</a> <em> * Field Name Field value (String representation Return type</em> -<a name="41" href="#41">41</a> <em> * LOGGER category name (logger) String</em> -<a name="42" href="#42">42</a> <em> * LEVEL level Level</em> -<a name="43" href="#43">43</a> <em> * CLASS locationInformation's class name String</em> -<a name="44" href="#44">44</a> <em> * FILE locationInformation's file name String</em> -<a name="45" href="#45">45</a> <em> * LINE locationInformation's line number String</em> -<a name="46" href="#46">46</a> <em> * METHOD locationInformation's method name String</em> -<a name="47" href="#47">47</a> <em> * MSG message Object</em> -<a name="48" href="#48">48</a> <em> * NDC NDC String</em> -<a name="49" href="#49">49</a> <em> * EXCEPTION throwable string representation ThrowableInformation</em> -<a name="50" href="#50">50</a> <em> * TIMESTAMP timestamp Long</em> -<a name="51" href="#51">51</a> <em> * THREAD thread String</em> -<a name="52" href="#52">52</a> <em> * PROP.keyName entry in the Property hashtable String</em> -<a name="53" href="#53">53</a> <em> * mapped to the key [keyName]</em> -<a name="54" href="#54">54</a> -<a name="55" href="#55">55</a> <em> * NOTE: the values for the 'keyName' portion of the MDC and PROP mappings must</em> -<a name="56" href="#56">56</a> <em> * be an exact match to the key in the hashTable (case sensitive).</em> -<a name="57" href="#57">57</a> <em> *</em> -<a name="58" href="#58">58</a> <em> * If the passed-in field is null or doesn't match an entry</em> -<a name="59" href="#59">59</a> <em> * in the above-described mapping, an exception is thrown.</em> -<a name="60" href="#60">60</a> <em> *</em> -<a name="61" href="#61">61</a> <em> * @author Scott Deboy ([EMAIL PROTECTED])</em> -<a name="62" href="#62">62</a> <em> * @author Paul Smith ([EMAIL PROTECTED])</em> -<a name="63" href="#63">63</a> <em> *</em> -<a name="64" href="#64">64</a> <em> */</em> -<a name="65" href="#65">65</a> <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> { -<a name="66" href="#66">66</a> <em>/**<em>*</em></em> -<a name="67" href="#67">67</a> <em> * Keyword list.</em> -<a name="68" href="#68">68</a> <em> */</em> -<a name="69" href="#69">69</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> List KEYWORD_LIST = <strong>new</strong> ArrayList(); -<a name="70" href="#70">70</a> <em>/**<em>*</em></em> -<a name="71" href="#71">71</a> <em> * LOGGER string literal.</em> -<a name="72" href="#72">72</a> <em> */</em> -<a name="73" href="#73">73</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LOGGER_FIELD = <span class="string">"LOGGER"</span>; -<a name="74" href="#74">74</a> <em>/**<em>*</em></em> -<a name="75" href="#75">75</a> <em> * LEVEL string literal.</em> -<a name="76" href="#76">76</a> <em> */</em> -<a name="77" href="#77">77</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LEVEL_FIELD = <span class="string">"LEVEL"</span>; -<a name="78" href="#78">78</a> <em>/**<em>*</em></em> -<a name="79" href="#79">79</a> <em> * CLASS string literal.</em> -<a name="80" href="#80">80</a> <em> */</em> -<a name="81" href="#81">81</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String CLASS_FIELD = <span class="string">"CLASS"</span>; -<a name="82" href="#82">82</a> <em>/**<em>*</em></em> -<a name="83" href="#83">83</a> <em> * FILE string literal.</em> -<a name="84" href="#84">84</a> <em> */</em> -<a name="85" href="#85">85</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String FILE_FIELD = <span class="string">"FILE"</span>; -<a name="86" href="#86">86</a> <em>/**<em>*</em></em> -<a name="87" href="#87">87</a> <em> * LINE string literal.</em> -<a name="88" href="#88">88</a> <em> */</em> -<a name="89" href="#89">89</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LINE_FIELD = <span class="string">"LINE"</span>; -<a name="90" href="#90">90</a> <em>/**<em>*</em></em> -<a name="91" href="#91">91</a> <em> * METHOD string literal.</em> -<a name="92" href="#92">92</a> <em> */</em> -<a name="93" href="#93">93</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String METHOD_FIELD = <span class="string">"METHOD"</span>; -<a name="94" href="#94">94</a> <em>/**<em>*</em></em> -<a name="95" href="#95">95</a> <em> * MSG string literal.</em> -<a name="96" href="#96">96</a> <em> */</em> -<a name="97" href="#97">97</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String MSG_FIELD = <span class="string">"MSG"</span>; -<a name="98" href="#98">98</a> <em>/**<em>*</em></em> -<a name="99" href="#99">99</a> <em> * NDC string literal.</em> -<a name="100" href="#100">100</a> <em> */</em> -<a name="101" href="#101">101</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NDC_FIELD = <span class="string">"NDC"</span>; -<a name="102" href="#102">102</a> <em>/**<em>*</em></em> -<a name="103" href="#103">103</a> <em> * EXCEPTION string literal.</em> -<a name="104" href="#104">104</a> <em> */</em> -<a name="105" href="#105">105</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String EXCEPTION_FIELD = <span class="string">"EXCEPTION"</span>; -<a name="106" href="#106">106</a> <em>/**<em>*</em></em> -<a name="107" href="#107">107</a> <em> * TIMESTAMP string literal.</em> -<a name="108" href="#108">108</a> <em> */</em> -<a name="109" href="#109">109</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String TIMESTAMP_FIELD = <span class="string">"TIMESTAMP"</span>; -<a name="110" href="#110">110</a> <em>/**<em>*</em></em> -<a name="111" href="#111">111</a> <em> * THREAD string literal.</em> -<a name="112" href="#112">112</a> <em> */</em> -<a name="113" href="#113">113</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String THREAD_FIELD = <span class="string">"THREAD"</span>; -<a name="114" href="#114">114</a> <em>/**<em>*</em></em> -<a name="115" href="#115">115</a> <em> * PROP. string literal.</em> -<a name="116" href="#116">116</a> <em> */</em> -<a name="117" href="#117">117</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PROP_FIELD = <span class="string">"PROP."</span>; -<a name="118" href="#118">118</a> <em>/**<em>*</em></em> -<a name="119" href="#119">119</a> <em> * empty string literal.</em> -<a name="120" href="#120">120</a> <em> */</em> -<a name="121" href="#121">121</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String EMPTY_STRING = <span class="string">""</span>; -<a name="122" href="#122">122</a> <em>/**<em>*</em></em> -<a name="123" href="#123">123</a> <em> * LOGGER string literal.</em> -<a name="124" href="#124">124</a> <em> */</em> -<a name="125" href="#125">125</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> RESOLVER = -<a name="126" href="#126">126</a> <strong>new</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a>(); -<a name="127" href="#127">127</a> -<a name="128" href="#128">128</a> <em>/**<em>*</em></em> -<a name="129" href="#129">129</a> <em> * Create new instance.</em> -<a name="130" href="#130">130</a> <em> */</em> -<a name="131" href="#131">131</a> <strong>private</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a>() { -<a name="132" href="#132">132</a> <strong>super</strong>(); -<a name="133" href="#133">133</a> KEYWORD_LIST.add(LOGGER_FIELD); -<a name="134" href="#134">134</a> KEYWORD_LIST.add(LEVEL_FIELD); -<a name="135" href="#135">135</a> KEYWORD_LIST.add(CLASS_FIELD); -<a name="136" href="#136">136</a> KEYWORD_LIST.add(FILE_FIELD); -<a name="137" href="#137">137</a> KEYWORD_LIST.add(LINE_FIELD); -<a name="138" href="#138">138</a> KEYWORD_LIST.add(METHOD_FIELD); -<a name="139" href="#139">139</a> KEYWORD_LIST.add(MSG_FIELD); -<a name="140" href="#140">140</a> KEYWORD_LIST.add(NDC_FIELD); -<a name="141" href="#141">141</a> KEYWORD_LIST.add(EXCEPTION_FIELD); -<a name="142" href="#142">142</a> KEYWORD_LIST.add(TIMESTAMP_FIELD); -<a name="143" href="#143">143</a> KEYWORD_LIST.add(THREAD_FIELD); -<a name="144" href="#144">144</a> KEYWORD_LIST.add(PROP_FIELD); -<a name="145" href="#145">145</a> } -<a name="146" href="#146">146</a> -<a name="147" href="#147">147</a> <em>/**<em>*</em></em> -<a name="148" href="#148">148</a> <em> * Apply fields.</em> -<a name="149" href="#149">149</a> <em> * @param replaceText replacement text.</em> -<a name="150" href="#150">150</a> <em> * @param event logging event.</em> -<a name="151" href="#151">151</a> <em> * @return evaluted expression</em> -<a name="152" href="#152">152</a> <em> */</em> -<a name="153" href="#153">153</a> <strong>public</strong> String applyFields(<strong>final</strong> String replaceText, -<a name="154" href="#154">154</a> <strong>final</strong> LoggingEvent event) { -<a name="155" href="#155">155</a> <strong>if</strong> (replaceText == <strong>null</strong>) { -<a name="156" href="#156">156</a> <strong>return</strong> <strong>null</strong>; -<a name="157" href="#157">157</a> } -<a name="158" href="#158">158</a> StringTokenizer tokenizer = <strong>new</strong> StringTokenizer(replaceText); -<a name="159" href="#159">159</a> StringBuffer result = <strong>new</strong> StringBuffer(); -<a name="160" href="#160">160</a> <strong>boolean</strong> found = false; -<a name="161" href="#161">161</a> -<a name="162" href="#162">162</a> <strong>while</strong> (tokenizer.hasMoreTokens()) { -<a name="163" href="#163">163</a> String token = tokenizer.nextToken(); -<a name="164" href="#164">164</a> <strong>if</strong> (isField(token) || token.toUpperCase().startsWith(PROP_FIELD)) { -<a name="165" href="#165">165</a> result.append(getValue(token, event).toString()); -<a name="166" href="#166">166</a> found = <strong>true</strong>; -<a name="167" href="#167">167</a> } <strong>else</strong> { -<a name="168" href="#168">168</a> result.append(token); -<a name="169" href="#169">169</a> } -<a name="170" href="#170">170</a> } -<a name="171" href="#171">171</a> <strong>if</strong> (found) { -<a name="172" href="#172">172</a> <strong>return</strong> result.toString(); -<a name="173" href="#173">173</a> } -<a name="174" href="#174">174</a> <strong>return</strong> <strong>null</strong>; -<a name="175" href="#175">175</a> } -<a name="176" href="#176">176</a> -<a name="177" href="#177">177</a> <em>/**<em>*</em></em> -<a name="178" href="#178">178</a> <em> * Get singleton instance.</em> -<a name="179" href="#179">179</a> <em> * @return singleton instance</em> -<a name="180" href="#180">180</a> <em> */</em> -<a name="181" href="#181">181</a> <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> getInstance() { -<a name="182" href="#182">182</a> <strong>return</strong> RESOLVER; -<a name="183" href="#183">183</a> } -<a name="184" href="#184">184</a> -<a name="185" href="#185">185</a> <em>/**<em>*</em></em> -<a name="186" href="#186">186</a> <em> * Determines if specified string is a recognized field.</em> -<a name="187" href="#187">187</a> <em> * @param fieldName field name</em> -<a name="188" href="#188">188</a> <em> * @return true if recognized field.</em> -<a name="189" href="#189">189</a> <em> */</em> -<a name="190" href="#190">190</a> <strong>public</strong> <strong>boolean</strong> isField(<strong>final</strong> String fieldName) { -<a name="191" href="#191">191</a> <strong>if</strong> (fieldName != <strong>null</strong>) { -<a name="192" href="#192">192</a> <strong>return</strong> (KEYWORD_LIST.contains( -<a name="193" href="#193">193</a> fieldName.toUpperCase()) -<a name="194" href="#194">194</a> || fieldName.toUpperCase().startsWith(PROP_FIELD)); -<a name="195" href="#195">195</a> } -<a name="196" href="#196">196</a> <strong>return</strong> false; -<a name="197" href="#197">197</a> } -<a name="198" href="#198">198</a> -<a name="199" href="#199">199</a> <em>/**<em>*</em></em> -<a name="200" href="#200">200</a> <em> * Get value of field.</em> -<a name="201" href="#201">201</a> <em> * @param fieldName field</em> -<a name="202" href="#202">202</a> <em> * @param event event</em> -<a name="203" href="#203">203</a> <em> * @return value of field</em> -<a name="204" href="#204">204</a> <em> */</em> -<a name="205" href="#205">205</a> <strong>public</strong> Object getValue(<strong>final</strong> String fieldName, -<a name="206" href="#206">206</a> <strong>final</strong> LoggingEvent event) { -<a name="207" href="#207">207</a> String upperField = fieldName.toUpperCase(); -<a name="208" href="#208">208</a> <strong>if</strong> (LOGGER_FIELD.equals(upperField)) { -<a name="209" href="#209">209</a> <strong>return</strong> event.getLoggerName(); -<a name="210" href="#210">210</a> } <strong>else</strong> <strong>if</strong> (LEVEL_FIELD.equals(upperField)) { -<a name="211" href="#211">211</a> <strong>return</strong> event.getLevel(); -<a name="212" href="#212">212</a> } <strong>else</strong> <strong>if</strong> (MSG_FIELD.equals(upperField)) { -<a name="213" href="#213">213</a> <strong>return</strong> event.getMessage(); -<a name="214" href="#214">214</a> } <strong>else</strong> <strong>if</strong> (NDC_FIELD.equals(upperField)) { -<a name="215" href="#215">215</a> String ndcValue = event.getNDC(); -<a name="216" href="#216">216</a> <strong>return</strong> ((ndcValue == <strong>null</strong>) ? EMPTY_STRING : ndcValue); -<a name="217" href="#217">217</a> } <strong>else</strong> <strong>if</strong> (EXCEPTION_FIELD.equals(upperField)) { -<a name="218" href="#218">218</a> String[] throwableRep = event.getThrowableStrRep(); -<a name="219" href="#219">219</a> <strong>if</strong> (throwableRep == <strong>null</strong>) { -<a name="220" href="#220">220</a> <strong>return</strong> EMPTY_STRING; -<a name="221" href="#221">221</a> } <strong>else</strong> { -<a name="222" href="#222">222</a> <strong>return</strong> getExceptionMessage(throwableRep); -<a name="223" href="#223">223</a> } -<a name="224" href="#224">224</a> } <strong>else</strong> <strong>if</strong> (TIMESTAMP_FIELD.equals(upperField)) { -<a name="225" href="#225">225</a> <strong>return</strong> <strong>new</strong> Long(event.timeStamp); -<a name="226" href="#226">226</a> } <strong>else</strong> <strong>if</strong> (THREAD_FIELD.equals(upperField)) { -<a name="227" href="#227">227</a> <strong>return</strong> event.getThreadName(); -<a name="228" href="#228">228</a> } <strong>else</strong> <strong>if</strong> (upperField.startsWith(PROP_FIELD)) { -<a name="229" href="#229">229</a> <em class="comment">//note: need to use actual fieldname since case matters</em> -<a name="230" href="#230">230</a> Object propValue = event.getMDC(fieldName.substring(5)); -<a name="231" href="#231">231</a> <strong>return</strong> ((propValue == <strong>null</strong>) ? EMPTY_STRING : propValue.toString()); -<a name="232" href="#232">232</a> } <strong>else</strong> { -<a name="233" href="#233">233</a> LocationInfo info = event.getLocationInformation(); -<a name="234" href="#234">234</a> <strong>if</strong> (CLASS_FIELD.equals(upperField)) { -<a name="235" href="#235">235</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getClassName()); -<a name="236" href="#236">236</a> } <strong>else</strong> <strong>if</strong> (FILE_FIELD.equals(upperField)) { -<a name="237" href="#237">237</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getFileName()); -<a name="238" href="#238">238</a> } <strong>else</strong> <strong>if</strong> (LINE_FIELD.equals(upperField)) { -<a name="239" href="#239">239</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getLineNumber()); -<a name="240" href="#240">240</a> } <strong>else</strong> <strong>if</strong> (METHOD_FIELD.equals(upperField)) { -<a name="241" href="#241">241</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getMethodName()); -<a name="242" href="#242">242</a> } -<a name="243" href="#243">243</a> } -<a name="244" href="#244">244</a> -<a name="245" href="#245">245</a> <em class="comment">//there wasn't a match, so throw a runtime exception</em> -<a name="246" href="#246">246</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Unsupported field name: "</span> + fieldName); -<a name="247" href="#247">247</a> } -<a name="248" href="#248">248</a> -<a name="249" href="#249">249</a> <em>/**<em>*</em></em> -<a name="250" href="#250">250</a> <em> * Get message from throwable representation.</em> -<a name="251" href="#251">251</a> <em> * @param exception exception</em> -<a name="252" href="#252">252</a> <em> * @return message</em> -<a name="253" href="#253">253</a> <em> */</em> -<a name="254" href="#254">254</a> <strong>private</strong> <strong>static</strong> String getExceptionMessage(<strong>final</strong> String[] exception) { -<a name="255" href="#255">255</a> StringBuffer buff = <strong>new</strong> StringBuffer(); -<a name="256" href="#256">256</a> <strong>for</strong> (<strong>int</strong> i = 0; i < exception.length; i++) { -<a name="257" href="#257">257</a> buff.append(exception[i]); -<a name="258" href="#258">258</a> } -<a name="259" href="#259">259</a> <strong>return</strong> buff.toString(); -<a name="260" href="#260">260</a> } -<a name="261" href="#261">261</a> } +<a name="28" href="#28">28</a> <em> * and a LoggingEvent and returns the value of that field.</em> +<a name="29" href="#29">29</a> <em> *</em> +<a name="30" href="#30">30</a> <em> * This class defines a grammar used in creation of an expression-based Rule.</em> +<a name="31" href="#31">31</a> <em> *</em> +<a name="32" href="#32">32</a> <em> * The only available method is</em> +<a name="33" href="#33">33</a> <em> * Object getField(String fieldName, LoggingEvent event).</em> +<a name="34" href="#34">34</a> <em> *</em> +<a name="35" href="#35">35</a> <em> * Here is a description of the mapping of field names in the grammar</em> +<a name="36" href="#36">36</a> <em> * to fields on the logging event. While the getField method returns an Object,</em> +<a name="37" href="#37">37</a> <em> * the individual types returned per field are described here:</em> +<a name="38" href="#38">38</a> <em> *</em> +<a name="39" href="#39">39</a> <em> * Field Name Field value (String representation Return type</em> +<a name="40" href="#40">40</a> <em> * LOGGER category name (logger) String</em> +<a name="41" href="#41">41</a> <em> * LEVEL level Level</em> +<a name="42" href="#42">42</a> <em> * CLASS locationInformation's class name String</em> +<a name="43" href="#43">43</a> <em> * FILE locationInformation's file name String</em> +<a name="44" href="#44">44</a> <em> * LINE locationInformation's line number String</em> +<a name="45" href="#45">45</a> <em> * METHOD locationInformation's method name String</em> +<a name="46" href="#46">46</a> <em> * MSG message Object</em> +<a name="47" href="#47">47</a> <em> * NDC NDC String</em> +<a name="48" href="#48">48</a> <em> * EXCEPTION throwable string representation ThrowableInformation</em> +<a name="49" href="#49">49</a> <em> * TIMESTAMP timestamp Long</em> +<a name="50" href="#50">50</a> <em> * THREAD thread String</em> +<a name="51" href="#51">51</a> <em> * PROP.keyName entry in the Property hashtable String</em> +<a name="52" href="#52">52</a> <em> * mapped to the key [keyName]</em> +<a name="53" href="#53">53</a> +<a name="54" href="#54">54</a> <em> * NOTE: the values for the 'keyName' portion of the MDC and PROP mappings must</em> +<a name="55" href="#55">55</a> <em> * be an exact match to the key in the hashTable (case sensitive).</em> +<a name="56" href="#56">56</a> <em> *</em> +<a name="57" href="#57">57</a> <em> * If the passed-in field is null or doesn't match an entry</em> +<a name="58" href="#58">58</a> <em> * in the above-described mapping, an exception is thrown.</em> +<a name="59" href="#59">59</a> <em> *</em> +<a name="60" href="#60">60</a> <em> * @author Scott Deboy ([EMAIL PROTECTED])</em> +<a name="61" href="#61">61</a> <em> * @author Paul Smith ([EMAIL PROTECTED])</em> +<a name="62" href="#62">62</a> <em> *</em> +<a name="63" href="#63">63</a> <em> */</em> +<a name="64" href="#64">64</a> <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> { +<a name="65" href="#65">65</a> <em>/**<em>*</em></em> +<a name="66" href="#66">66</a> <em> * Keyword list.</em> +<a name="67" href="#67">67</a> <em> */</em> +<a name="68" href="#68">68</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> List KEYWORD_LIST = <strong>new</strong> ArrayList(); +<a name="69" href="#69">69</a> <em>/**<em>*</em></em> +<a name="70" href="#70">70</a> <em> * LOGGER string literal.</em> +<a name="71" href="#71">71</a> <em> */</em> +<a name="72" href="#72">72</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LOGGER_FIELD = <span class="string">"LOGGER"</span>; +<a name="73" href="#73">73</a> <em>/**<em>*</em></em> +<a name="74" href="#74">74</a> <em> * LEVEL string literal.</em> +<a name="75" href="#75">75</a> <em> */</em> +<a name="76" href="#76">76</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LEVEL_FIELD = <span class="string">"LEVEL"</span>; +<a name="77" href="#77">77</a> <em>/**<em>*</em></em> +<a name="78" href="#78">78</a> <em> * CLASS string literal.</em> +<a name="79" href="#79">79</a> <em> */</em> +<a name="80" href="#80">80</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String CLASS_FIELD = <span class="string">"CLASS"</span>; +<a name="81" href="#81">81</a> <em>/**<em>*</em></em> +<a name="82" href="#82">82</a> <em> * FILE string literal.</em> +<a name="83" href="#83">83</a> <em> */</em> +<a name="84" href="#84">84</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String FILE_FIELD = <span class="string">"FILE"</span>; +<a name="85" href="#85">85</a> <em>/**<em>*</em></em> +<a name="86" href="#86">86</a> <em> * LINE string literal.</em> +<a name="87" href="#87">87</a> <em> */</em> +<a name="88" href="#88">88</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String LINE_FIELD = <span class="string">"LINE"</span>; +<a name="89" href="#89">89</a> <em>/**<em>*</em></em> +<a name="90" href="#90">90</a> <em> * METHOD string literal.</em> +<a name="91" href="#91">91</a> <em> */</em> +<a name="92" href="#92">92</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String METHOD_FIELD = <span class="string">"METHOD"</span>; +<a name="93" href="#93">93</a> <em>/**<em>*</em></em> +<a name="94" href="#94">94</a> <em> * MSG string literal.</em> +<a name="95" href="#95">95</a> <em> */</em> +<a name="96" href="#96">96</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String MSG_FIELD = <span class="string">"MSG"</span>; +<a name="97" href="#97">97</a> <em>/**<em>*</em></em> +<a name="98" href="#98">98</a> <em> * NDC string literal.</em> +<a name="99" href="#99">99</a> <em> */</em> +<a name="100" href="#100">100</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NDC_FIELD = <span class="string">"NDC"</span>; +<a name="101" href="#101">101</a> <em>/**<em>*</em></em> +<a name="102" href="#102">102</a> <em> * EXCEPTION string literal.</em> +<a name="103" href="#103">103</a> <em> */</em> +<a name="104" href="#104">104</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String EXCEPTION_FIELD = <span class="string">"EXCEPTION"</span>; +<a name="105" href="#105">105</a> <em>/**<em>*</em></em> +<a name="106" href="#106">106</a> <em> * TIMESTAMP string literal.</em> +<a name="107" href="#107">107</a> <em> */</em> +<a name="108" href="#108">108</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String TIMESTAMP_FIELD = <span class="string">"TIMESTAMP"</span>; +<a name="109" href="#109">109</a> <em>/**<em>*</em></em> +<a name="110" href="#110">110</a> <em> * THREAD string literal.</em> +<a name="111" href="#111">111</a> <em> */</em> +<a name="112" href="#112">112</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String THREAD_FIELD = <span class="string">"THREAD"</span>; +<a name="113" href="#113">113</a> <em>/**<em>*</em></em> +<a name="114" href="#114">114</a> <em> * PROP. string literal.</em> +<a name="115" href="#115">115</a> <em> */</em> +<a name="116" href="#116">116</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PROP_FIELD = <span class="string">"PROP."</span>; +<a name="117" href="#117">117</a> <em>/**<em>*</em></em> +<a name="118" href="#118">118</a> <em> * empty string literal.</em> +<a name="119" href="#119">119</a> <em> */</em> +<a name="120" href="#120">120</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String EMPTY_STRING = <span class="string">""</span>; +<a name="121" href="#121">121</a> <em>/**<em>*</em></em> +<a name="122" href="#122">122</a> <em> * LOGGER string literal.</em> +<a name="123" href="#123">123</a> <em> */</em> +<a name="124" href="#124">124</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> RESOLVER = +<a name="125" href="#125">125</a> <strong>new</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a>(); +<a name="126" href="#126">126</a> +<a name="127" href="#127">127</a> <em>/**<em>*</em></em> +<a name="128" href="#128">128</a> <em> * Create new instance.</em> +<a name="129" href="#129">129</a> <em> */</em> +<a name="130" href="#130">130</a> <strong>private</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a>() { +<a name="131" href="#131">131</a> <strong>super</strong>(); +<a name="132" href="#132">132</a> KEYWORD_LIST.add(LOGGER_FIELD); +<a name="133" href="#133">133</a> KEYWORD_LIST.add(LEVEL_FIELD); +<a name="134" href="#134">134</a> KEYWORD_LIST.add(CLASS_FIELD); +<a name="135" href="#135">135</a> KEYWORD_LIST.add(FILE_FIELD); +<a name="136" href="#136">136</a> KEYWORD_LIST.add(LINE_FIELD); +<a name="137" href="#137">137</a> KEYWORD_LIST.add(METHOD_FIELD); +<a name="138" href="#138">138</a> KEYWORD_LIST.add(MSG_FIELD); +<a name="139" href="#139">139</a> KEYWORD_LIST.add(NDC_FIELD); +<a name="140" href="#140">140</a> KEYWORD_LIST.add(EXCEPTION_FIELD); +<a name="141" href="#141">141</a> KEYWORD_LIST.add(TIMESTAMP_FIELD); +<a name="142" href="#142">142</a> KEYWORD_LIST.add(THREAD_FIELD); +<a name="143" href="#143">143</a> KEYWORD_LIST.add(PROP_FIELD); +<a name="144" href="#144">144</a> } +<a name="145" href="#145">145</a> +<a name="146" href="#146">146</a> <em>/**<em>*</em></em> +<a name="147" href="#147">147</a> <em> * Apply fields.</em> +<a name="148" href="#148">148</a> <em> * @param replaceText replacement text.</em> +<a name="149" href="#149">149</a> <em> * @param event logging event.</em> +<a name="150" href="#150">150</a> <em> * @return evaluted expression</em> +<a name="151" href="#151">151</a> <em> */</em> +<a name="152" href="#152">152</a> <strong>public</strong> String applyFields(<strong>final</strong> String replaceText, +<a name="153" href="#153">153</a> <strong>final</strong> LoggingEvent event) { +<a name="154" href="#154">154</a> <strong>if</strong> (replaceText == <strong>null</strong>) { +<a name="155" href="#155">155</a> <strong>return</strong> <strong>null</strong>; +<a name="156" href="#156">156</a> } +<a name="157" href="#157">157</a> StringTokenizer tokenizer = <strong>new</strong> StringTokenizer(replaceText); +<a name="158" href="#158">158</a> StringBuffer result = <strong>new</strong> StringBuffer(); +<a name="159" href="#159">159</a> <strong>boolean</strong> found = false; +<a name="160" href="#160">160</a> +<a name="161" href="#161">161</a> <strong>while</strong> (tokenizer.hasMoreTokens()) { +<a name="162" href="#162">162</a> String token = tokenizer.nextToken(); +<a name="163" href="#163">163</a> <strong>if</strong> (isField(token) || token.toUpperCase(Locale.US).startsWith(PROP_FIELD)) { +<a name="164" href="#164">164</a> result.append(getValue(token, event).toString()); +<a name="165" href="#165">165</a> found = <strong>true</strong>; +<a name="166" href="#166">166</a> } <strong>else</strong> { +<a name="167" href="#167">167</a> result.append(token); +<a name="168" href="#168">168</a> } +<a name="169" href="#169">169</a> } +<a name="170" href="#170">170</a> <strong>if</strong> (found) { +<a name="171" href="#171">171</a> <strong>return</strong> result.toString(); +<a name="172" href="#172">172</a> } +<a name="173" href="#173">173</a> <strong>return</strong> <strong>null</strong>; +<a name="174" href="#174">174</a> } +<a name="175" href="#175">175</a> +<a name="176" href="#176">176</a> <em>/**<em>*</em></em> +<a name="177" href="#177">177</a> <em> * Get singleton instance.</em> +<a name="178" href="#178">178</a> <em> * @return singleton instance</em> +<a name="179" href="#179">179</a> <em> */</em> +<a name="180" href="#180">180</a> <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/log4j/spi/LoggingEventFieldResolver.html">LoggingEventFieldResolver</a> getInstance() { +<a name="181" href="#181">181</a> <strong>return</strong> RESOLVER; +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</a> +<a name="184" href="#184">184</a> <em>/**<em>*</em></em> +<a name="185" href="#185">185</a> <em> * Determines if specified string is a recognized field.</em> +<a name="186" href="#186">186</a> <em> * @param fieldName field name</em> +<a name="187" href="#187">187</a> <em> * @return true if recognized field.</em> +<a name="188" href="#188">188</a> <em> */</em> +<a name="189" href="#189">189</a> <strong>public</strong> <strong>boolean</strong> isField(<strong>final</strong> String fieldName) { +<a name="190" href="#190">190</a> <strong>if</strong> (fieldName != <strong>null</strong>) { +<a name="191" href="#191">191</a> <strong>return</strong> (KEYWORD_LIST.contains( +<a name="192" href="#192">192</a> fieldName.toUpperCase(Locale.US)) +<a name="193" href="#193">193</a> || fieldName.toUpperCase().startsWith(PROP_FIELD)); +<a name="194" href="#194">194</a> } +<a name="195" href="#195">195</a> <strong>return</strong> false; +<a name="196" href="#196">196</a> } +<a name="197" href="#197">197</a> +<a name="198" href="#198">198</a> <em>/**<em>*</em></em> +<a name="199" href="#199">199</a> <em> * Get value of field.</em> +<a name="200" href="#200">200</a> <em> * @param fieldName field</em> +<a name="201" href="#201">201</a> <em> * @param event event</em> +<a name="202" href="#202">202</a> <em> * @return value of field</em> +<a name="203" href="#203">203</a> <em> */</em> +<a name="204" href="#204">204</a> <strong>public</strong> Object getValue(<strong>final</strong> String fieldName, +<a name="205" href="#205">205</a> <strong>final</strong> LoggingEvent event) { +<a name="206" href="#206">206</a> String upperField = fieldName.toUpperCase(Locale.US); +<a name="207" href="#207">207</a> <strong>if</strong> (LOGGER_FIELD.equals(upperField)) { +<a name="208" href="#208">208</a> <strong>return</strong> event.getLoggerName(); +<a name="209" href="#209">209</a> } <strong>else</strong> <strong>if</strong> (LEVEL_FIELD.equals(upperField)) { +<a name="210" href="#210">210</a> <strong>return</strong> event.getLevel(); +<a name="211" href="#211">211</a> } <strong>else</strong> <strong>if</strong> (MSG_FIELD.equals(upperField)) { +<a name="212" href="#212">212</a> <strong>return</strong> event.getMessage(); +<a name="213" href="#213">213</a> } <strong>else</strong> <strong>if</strong> (NDC_FIELD.equals(upperField)) { +<a name="214" href="#214">214</a> String ndcValue = event.getNDC(); +<a name="215" href="#215">215</a> <strong>return</strong> ((ndcValue == <strong>null</strong>) ? EMPTY_STRING : ndcValue); +<a name="216" href="#216">216</a> } <strong>else</strong> <strong>if</strong> (EXCEPTION_FIELD.equals(upperField)) { +<a name="217" href="#217">217</a> String[] throwableRep = event.getThrowableStrRep(); +<a name="218" href="#218">218</a> <strong>if</strong> (throwableRep == <strong>null</strong>) { +<a name="219" href="#219">219</a> <strong>return</strong> EMPTY_STRING; +<a name="220" href="#220">220</a> } <strong>else</strong> { +<a name="221" href="#221">221</a> <strong>return</strong> getExceptionMessage(throwableRep); +<a name="222" href="#222">222</a> } +<a name="223" href="#223">223</a> } <strong>else</strong> <strong>if</strong> (TIMESTAMP_FIELD.equals(upperField)) { +<a name="224" href="#224">224</a> <strong>return</strong> <strong>new</strong> Long(event.timeStamp); +<a name="225" href="#225">225</a> } <strong>else</strong> <strong>if</strong> (THREAD_FIELD.equals(upperField)) { +<a name="226" href="#226">226</a> <strong>return</strong> event.getThreadName(); +<a name="227" href="#227">227</a> } <strong>else</strong> <strong>if</strong> (upperField.startsWith(PROP_FIELD)) { +<a name="228" href="#228">228</a> <em class="comment">//note: need to use actual fieldname since case matters</em> +<a name="229" href="#229">229</a> Object propValue = event.getMDC(fieldName.substring(5)); +<a name="230" href="#230">230</a> <strong>return</strong> ((propValue == <strong>null</strong>) ? EMPTY_STRING : propValue.toString()); +<a name="231" href="#231">231</a> } <strong>else</strong> { +<a name="232" href="#232">232</a> LocationInfo info = event.getLocationInformation(); +<a name="233" href="#233">233</a> <strong>if</strong> (CLASS_FIELD.equals(upperField)) { +<a name="234" href="#234">234</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getClassName()); +<a name="235" href="#235">235</a> } <strong>else</strong> <strong>if</strong> (FILE_FIELD.equals(upperField)) { +<a name="236" href="#236">236</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getFileName()); +<a name="237" href="#237">237</a> } <strong>else</strong> <strong>if</strong> (LINE_FIELD.equals(upperField)) { +<a name="238" href="#238">238</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getLineNumber()); +<a name="239" href="#239">239</a> } <strong>else</strong> <strong>if</strong> (METHOD_FIELD.equals(upperField)) { +<a name="240" href="#240">240</a> <strong>return</strong> ((info == <strong>null</strong>) ? EMPTY_STRING : info.getMethodName()); +<a name="241" href="#241">241</a> } +<a name="242" href="#242">242</a> } +<a name="243" href="#243">243</a> +<a name="244" href="#244">244</a> <em class="comment">//there wasn't a match, so throw a runtime exception</em> +<a name="245" href="#245">245</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Unsupported field name: "</span> + fieldName); +<a name="246" href="#246">246</a> } +<a name="247" href="#247">247</a> +<a name="248" href="#248">248</a> <em>/**<em>*</em></em> +<a name="249" href="#249">249</a> <em> * Get message from throwable representation.</em> +<a name="250" href="#250">250</a> <em> * @param exception exception</em> +<a name="251" href="#251">251</a> <em> * @return message</em> +<a name="252" href="#252">252</a> <em> */</em> +<a name="253" href="#253">253</a> <strong>private</strong> <strong>static</strong> String getExceptionMessage(<strong>final</strong> String[] exception) { +<a name="254" href="#254">254</a> StringBuffer buff = <strong>new</strong> StringBuffer(); +<a name="255" href="#255">255</a> <strong>for</strong> (<strong>int</strong> i = 0; i < exception.length; i++) { +<a name="256" href="#256">256</a> buff.append(exception[i]); +<a name="257" href="#257">257</a> } +<a name="258" href="#258">258</a> <strong>return</strong> buff.toString(); +<a name="259" href="#259">259</a> } +<a name="260" href="#260">260</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
Modified: logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-frame.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-frame.html?rev=569263&r1=569262&r2=569263&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-frame.html (original) +++ logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-frame.html Thu Aug 23 23:01:46 2007 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>Apache Extras Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package org.apache.log4j.spi</title> + <title>Apache Extras Companion for log4j 1.2. 1.0 Reference Package org.apache.log4j.spi</title> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" /> </head> <body> Modified: logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-summary.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-summary.html?rev=569263&r1=569262&r2=569263&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-summary.html (original) +++ logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/spi/package-summary.html Thu Aug 23 23:01:46 2007 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>Apache Extras Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package $name</title> + <title>Apache Extras Companion for log4j 1.2. 1.0 Reference Package $name</title> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" /> </head> <body> Modified: logging/site/trunk/docs/log4j/companions/extras/xref/overview-frame.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/overview-frame.html?rev=569263&r1=569262&r2=569263&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/extras/xref/overview-frame.html (original) +++ logging/site/trunk/docs/log4j/companions/extras/xref/overview-frame.html Thu Aug 23 23:01:46 2007 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>Apache Extras Companion for log4j 1.2. 1.0-SNAPSHOT Reference</title> + <title>Apache Extras Companion for log4j 1.2. 1.0 Reference</title> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" /> </head> <body> @@ -17,6 +17,9 @@ <ul> <li> <a href="org/apache/log4j/package-frame.html" target="packageFrame">org.apache.log4j</a> + </li> + <li> + <a href="org/apache/log4j/extras/package-frame.html" target="packageFrame">org.apache.log4j.extras</a> </li> <li> <a href="org/apache/log4j/filter/package-frame.html" target="packageFrame">org.apache.log4j.filter</a> Modified: logging/site/trunk/docs/log4j/companions/extras/xref/overview-summary.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/overview-summary.html?rev=569263&r1=569262&r2=569263&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/extras/xref/overview-summary.html (original) +++ logging/site/trunk/docs/log4j/companions/extras/xref/overview-summary.html Thu Aug 23 23:01:46 2007 @@ -3,7 +3,7 @@ <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> - <title>Apache Extras Companion for log4j 1.2. 1.0-SNAPSHOT Reference</title> + <title>Apache Extras Companion for log4j 1.2. 1.0 Reference</title> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" /> </head> <body> @@ -24,7 +24,7 @@ </ul> </div> - <h2>Apache Extras Companion for log4j 1.2. 1.0-SNAPSHOT Reference</h2> + <h2>Apache Extras Companion for log4j 1.2. 1.0 Reference</h2> <table class="summary"> <thead> @@ -36,6 +36,11 @@ <tr> <td> <a href="org/apache/log4j/package-summary.html">org.apache.log4j</a> + </td> + </tr> + <tr> + <td> + <a href="org/apache/log4j/extras/package-summary.html">org.apache.log4j.extras</a> </td> </tr> <tr>
