Added:
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/XSLTLayout.html
URL:
http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/XSLTLayout.html?rev=569257&view=auto
==============================================================================
---
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/XSLTLayout.html
(added)
+++
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/XSLTLayout.html
Thu Aug 23 22:43:39 2007
@@ -0,0 +1,501 @@
+<!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>XSLTLayout xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a
href="../../../../../../../../../../apidocs/org/apache/log4j/xml/XSLTLayout.html">View
Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="comment">/*</em>
+<a name="2" href="#2">2</a> <em class="comment"> * Licensed to the Apache
Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="comment"> * contributor license
agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="comment"> * this work for additional
information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="comment"> * The ASF licenses this
file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a> <em class="comment"> * (the "License"); you may
not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="comment"> * the License. You may
obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="comment"> *</em>
+<a name="9" href="#9">9</a> <em class="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="10" href="#10">10</a> <em class="comment"> *</em>
+<a name="11" href="#11">11</a> <em class="comment"> * Unless required by
applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="comment"> * distributed under the
License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="comment"> * WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="comment"> * See the License for the
specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="comment"> * limitations under the
License.</em>
+<a name="16" href="#16">16</a> <em class="comment"> */</em>
+<a name="17" href="#17">17</a> <strong>package</strong> org.apache.log4j.xml;
+<a name="18" href="#18">18</a> <strong>import</strong>
org.apache.log4j.Layout;
+<a name="19" href="#19">19</a> <strong>import</strong>
org.apache.log4j.helpers.LogLog;
+<a name="20" href="#20">20</a> <strong>import</strong>
org.apache.log4j.helpers.MDCKeySetExtractor;
+<a name="21" href="#21">21</a> <strong>import</strong>
org.apache.log4j.spi.LoggingEvent;
+<a name="22" href="#22">22</a> <strong>import</strong>
org.apache.log4j.spi.LocationInfo;
+<a name="23" href="#23">23</a> <strong>import</strong> org.w3c.dom.Element;
+<a name="24" href="#24">24</a> <strong>import</strong> org.w3c.dom.NodeList;
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <strong>import</strong>
javax.xml.transform.TransformerFactory;
+<a name="27" href="#27">27</a> <strong>import</strong>
javax.xml.transform.TransformerConfigurationException;
+<a name="28" href="#28">28</a> <strong>import</strong>
javax.xml.transform.Templates;
+<a name="29" href="#29">29</a> <strong>import</strong>
javax.xml.transform.Transformer;
+<a name="30" href="#30">30</a> <strong>import</strong>
javax.xml.transform.sax.TransformerHandler;
+<a name="31" href="#31">31</a> <strong>import</strong>
javax.xml.transform.sax.SAXTransformerFactory;
+<a name="32" href="#32">32</a> <strong>import</strong>
javax.xml.transform.stream.StreamSource;
+<a name="33" href="#33">33</a> <strong>import</strong>
javax.xml.transform.stream.StreamResult;
+<a name="34" href="#34">34</a> <strong>import</strong>
javax.xml.transform.dom.DOMSource;
+<a name="35" href="#35">35</a> <strong>import</strong>
javax.xml.parsers.DocumentBuilderFactory;
+<a name="36" href="#36">36</a> <strong>import</strong> java.io.InputStream;
+<a name="37" href="#37">37</a> <strong>import</strong>
java.io.ByteArrayOutputStream;
+<a name="38" href="#38">38</a> <strong>import</strong>
java.io.ByteArrayInputStream;
+<a name="39" href="#39">39</a> <strong>import</strong> java.util.Set;
+<a name="40" href="#40">40</a> <strong>import</strong> java.util.Properties;
+<a name="41" href="#41">41</a> <strong>import</strong> java.util.Arrays;
+<a name="42" href="#42">42</a> <strong>import</strong> java.util.TimeZone;
+<a name="43" href="#43">43</a> <strong>import</strong>
java.nio.charset.Charset;
+<a name="44" href="#44">44</a> <strong>import</strong> java.nio.ByteBuffer;
+<a name="45" href="#45">45</a> <strong>import</strong>
org.apache.log4j.pattern.CachedDateFormat;
+<a name="46" href="#46">46</a> <strong>import</strong>
java.text.SimpleDateFormat;
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <strong>import</strong> org.w3c.dom.Document;
+<a name="49" href="#49">49</a>
+<a name="50" href="#50">50</a> <strong>import</strong>
org.xml.sax.helpers.AttributesImpl;
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a>
+<a name="53" href="#53">53</a> <em>/**<em>*</em></em>
+<a name="54" href="#54">54</a> <em> * XSLTLayout transforms each event as a
document using</em>
+<a name="55" href="#55">55</a> <em> * a specified or default XSLT transform.
The default</em>
+<a name="56" href="#56">56</a> <em> * XSLT transform produces a result
similar to XMLLayout.</em>
+<a name="57" href="#57">57</a> <em> *</em>
+<a name="58" href="#58">58</a> <em> * When used with a FileAppender or
similar, the transformation of</em>
+<a name="59" href="#59">59</a> <em> * an event will be appended to the
results for previous</em>
+<a name="60" href="#60">60</a> <em> * transforms. If each transform results
in an XML element, then</em>
+<a name="61" href="#61">61</a> <em> * resulting file will only be an XML
entity</em>
+<a name="62" href="#62">62</a> <em> * since an XML document requires one and
only one top-level element.</em>
+<a name="63" href="#63">63</a> <em> * To process the entity, reference it in
a XML document like so:</em>
+<a name="64" href="#64">64</a> <em> *</em>
+<a name="65" href="#65">65</a> <em> * <pre></em>
+<a name="66" href="#66">66</a> <em> * &lt;!DOCTYPE log4j:eventSet
[&lt;!ENTITY data SYSTEM &quot;data.xml&quot;&gt;]&gt;</em>
+<a name="67" href="#67">67</a> <em> *</em>
+<a name="68" href="#68">68</a> <em> * &lt;log4j:eventSet
xmlns:log4j=&quot;<a
href="http://jakarta.apache.org/log4j/&quot;&gt;";
target="alexandria_uri">http://jakarta.apache.org/log4j/&quot;&gt;</a></em>
+<a name="69" href="#69">69</a> <em> * &amp;data</em>
+<a name="70" href="#70">70</a> <em> * &lt;/log4j:eventSet&gt;</em>
+<a name="71" href="#71">71</a> <em> *</em>
+<a name="72" href="#72">72</a> <em> * </pre></em>
+<a name="73" href="#73">73</a> <em> *</em>
+<a name="74" href="#74">74</a> <em> * The layout will detect the encoding and
media-type specified in</em>
+<a name="75" href="#75">75</a> <em> * the transform. If no encoding is
specified in the transform,</em>
+<a name="76" href="#76">76</a> <em> * an xsl:output element specifying the
US-ASCII encoding will be inserted</em>
+<a name="77" href="#77">77</a> <em> * before processing the transform. If an
encoding is specified in the transform,</em>
+<a name="78" href="#78">78</a> <em> * the same encoding should be explicitly
specified for the appender.</em>
+<a name="79" href="#79">79</a> <em> *</em>
+<a name="80" href="#80">80</a> <em> * Extracting MDC values can be expensive
when used with log4j releases</em>
+<a name="81" href="#81">81</a> <em> * prior to 1.2.15. Output of MDC values
is enabled by default</em>
+<a name="82" href="#82">82</a> <em> * but be suppressed by setting properties
to false.</em>
+<a name="83" href="#83">83</a> <em> *</em>
+<a name="84" href="#84">84</a> <em> * Extracting location info can be
expensive regardless of log4j version. </em>
+<a name="85" href="#85">85</a> <em> * Output of location info is disabled by
default but can be enabled</em>
+<a name="86" href="#86">86</a> <em> * by setting locationInfo to true.</em>
+<a name="87" href="#87">87</a> <em> *</em>
+<a name="88" href="#88">88</a> <em> * Embedded transforms in XML
configuration should not</em>
+<a name="89" href="#89">89</a> <em> * depend on namespace prefixes defined
earlier in the document</em>
+<a name="90" href="#90">90</a> <em> * as namespace aware parsing in not
generally performed when</em>
+<a name="91" href="#91">91</a> <em> * using DOMConfigurator. The transform
will serialize</em>
+<a name="92" href="#92">92</a> <em> * and reparse to get the namespace aware
document needed.</em>
+<a name="93" href="#93">93</a> <em> *</em>
+<a name="94" href="#94">94</a> <em> */</em>
+<a name="95" href="#95">95</a> <strong>public</strong> <strong>final</strong>
<strong>class</strong> <a
href="../../../../org/apache/log4j/xml/XSLTLayout.html">XSLTLayout</a>
<strong>extends</strong> Layout
+<a name="96" href="#96">96</a> implements <a
href="../../../../org/apache/log4j/xml/UnrecognizedElementHandler.html">UnrecognizedElementHandler</a>
{
+<a name="97" href="#97">97</a> <em>/**<em>*</em></em>
+<a name="98" href="#98">98</a> <em> * Namespace for XSLT.</em>
+<a name="99" href="#99">99</a> <em> */</em>
+<a name="100" href="#100">100</a> <strong>private</strong>
<strong>static</strong> <strong>final</strong> String XSLT_NS = <span
class="string">"http://www.w3.org/1999/XSL/Transform";</span>;
+<a name="101" href="#101">101</a> <em>/**<em>*</em></em>
+<a name="102" href="#102">102</a> <em> * Namespace for log4j events.</em>
+<a name="103" href="#103">103</a> <em> */</em>
+<a name="104" href="#104">104</a> <strong>private</strong>
<strong>static</strong> <strong>final</strong> String LOG4J_NS = <span
class="string">"http://jakarta.apache.org/log4j/";</span>;
+<a name="105" href="#105">105</a> <em>/**<em>*</em></em>
+<a name="106" href="#106">106</a> <em> * Whether location information
should be written.</em>
+<a name="107" href="#107">107</a> <em> */</em>
+<a name="108" href="#108">108</a> <strong>private</strong>
<strong>boolean</strong> locationInfo = false;
+<a name="109" href="#109">109</a> <em>/**<em>*</em></em>
+<a name="110" href="#110">110</a> <em> * media-type (mime type) extracted
from XSLT transform.</em>
+<a name="111" href="#111">111</a> <em> */</em>
+<a name="112" href="#112">112</a> <strong>private</strong> String
mediaType = <span class="string">"text/plain"</span>;
+<a name="113" href="#113">113</a> <em>/**<em>*</em></em>
+<a name="114" href="#114">114</a> <em> * Encoding extracted from XSLT
transform.</em>
+<a name="115" href="#115">115</a> <em> */</em>
+<a name="116" href="#116">116</a> <strong>private</strong> Charset
encoding;
+<a name="117" href="#117">117</a> <em>/**<em>*</em></em>
+<a name="118" href="#118">118</a> <em> * Transformer factory.</em>
+<a name="119" href="#119">119</a> <em> */</em>
+<a name="120" href="#120">120</a> <strong>private</strong>
SAXTransformerFactory transformerFactory;
+<a name="121" href="#121">121</a> <em>/**<em>*</em></em>
+<a name="122" href="#122">122</a> <em> * XSLT templates.</em>
+<a name="123" href="#123">123</a> <em> */</em>
+<a name="124" href="#124">124</a> <strong>private</strong> Templates
templates;
+<a name="125" href="#125">125</a> <em>/**<em>*</em></em>
+<a name="126" href="#126">126</a> <em> * Output stream.</em>
+<a name="127" href="#127">127</a> <em> */</em>
+<a name="128" href="#128">128</a> <strong>private</strong>
<strong>final</strong> ByteArrayOutputStream outputStream;
+<a name="129" href="#129">129</a> <em>/**<em>*</em></em>
+<a name="130" href="#130">130</a> <em> * Whether throwable information
should be ignored.</em>
+<a name="131" href="#131">131</a> <em> */</em>
+<a name="132" href="#132">132</a> <strong>private</strong>
<strong>boolean</strong> ignoresThrowable = false;
+<a name="133" href="#133">133</a> <em>/**<em>*</em></em>
+<a name="134" href="#134">134</a> <em> * Whether properties should be
extracted.</em>
+<a name="135" href="#135">135</a> <em> */</em>
+<a name="136" href="#136">136</a> <strong>private</strong>
<strong>boolean</strong> properties = <strong>true</strong>;
+<a name="137" href="#137">137</a> <em>/**<em>*</em></em>
+<a name="138" href="#138">138</a> <em> * Whether activateOptions has been
called.</em>
+<a name="139" href="#139">139</a> <em> */</em>
+<a name="140" href="#140">140</a> <strong>private</strong>
<strong>boolean</strong> activated = false;
+<a name="141" href="#141">141</a>
+<a name="142" href="#142">142</a> <em>/**<em>*</em></em>
+<a name="143" href="#143">143</a> <em> * DateFormat for UTC time.</em>
+<a name="144" href="#144">144</a> <em> */</em>
+<a name="145" href="#145">145</a> <strong>private</strong>
<strong>final</strong> <a
href="../../../../org/apache/log4j/pattern/CachedDateFormat.html">CachedDateFormat</a>
utcDateFormat;
+<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> * Default constructor.</em>
+<a name="149" href="#149">149</a> <em> *</em>
+<a name="150" href="#150">150</a> <em> */</em>
+<a name="151" href="#151">151</a> <strong>public</strong> <a
href="../../../../org/apache/log4j/xml/XSLTLayout.html">XSLTLayout</a>() {
+<a name="152" href="#152">152</a> outputStream = <strong>new</strong>
ByteArrayOutputStream();
+<a name="153" href="#153">153</a> transformerFactory =
(SAXTransformerFactory)
+<a name="154" href="#154">154</a>
TransformerFactory.newInstance();
+<a name="155" href="#155">155</a>
+<a name="156" href="#156">156</a> SimpleDateFormat zdf =
<strong>new</strong> SimpleDateFormat(<span
class="string">"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"</span>);
+<a name="157" href="#157">157</a>
zdf.setTimeZone(TimeZone.getTimeZone(<span class="string">"UTC"</span>));
+<a name="158" href="#158">158</a> utcDateFormat = <strong>new</strong>
<a
href="../../../../org/apache/log4j/pattern/CachedDateFormat.html">CachedDateFormat</a>(zdf,
1000);
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a>
+<a name="161" href="#161">161</a> <em>/**<em>*</em></em>
+<a name="162" href="#162">162</a> <em> * [EMAIL PROTECTED]</em>
+<a name="163" href="#163">163</a> <em> */</em>
+<a name="164" href="#164">164</a> <strong>public</strong>
<strong>synchronized</strong> String getContentType() {
+<a name="165" href="#165">165</a> <strong>return</strong> mediaType;
+<a name="166" href="#166">166</a> }
+<a name="167" href="#167">167</a>
+<a name="168" href="#168">168</a> <em>/**<em>*</em></em>
+<a name="169" href="#169">169</a> <em> * The <b>LocationInfo </b>
option takes a boolean value. By default, it is</em>
+<a name="170" href="#170">170</a> <em> * set to false which means there
will be no location information output by</em>
+<a name="171" href="#171">171</a> <em> * this layout. If the the option is
set to true, then the file name and line</em>
+<a name="172" href="#172">172</a> <em> * number of the statement at the
origin of the log statement will be output.</em>
+<a name="173" href="#173">173</a> <em> *</em>
+<a name="174" href="#174">174</a> <em> * <p></em>
+<a name="175" href="#175">175</a> <em> * If you are embedding this layout
within an [EMAIL PROTECTED]</em>
+<a name="176" href="#176">176</a> <em> *
org.apache.log4j.net.SMTPAppender} then make sure to set the</em>
+<a name="177" href="#177">177</a> <em> * <b>LocationInfo </b> option
of that appender as well.</em>
+<a name="178" href="#178">178</a> <em> *</em>
+<a name="179" href="#179">179</a> <em> * @param flag new value.</em>
+<a name="180" href="#180">180</a> <em> */</em>
+<a name="181" href="#181">181</a> <strong>public</strong>
<strong>synchronized</strong> <strong>void</strong>
setLocationInfo(<strong>final</strong> <strong>boolean</strong> flag) {
+<a name="182" href="#182">182</a> locationInfo = flag;
+<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> * Gets whether location info should
be output.</em>
+<a name="187" href="#187">187</a> <em> * @return if location is
output.</em>
+<a name="188" href="#188">188</a> <em> */</em>
+<a name="189" href="#189">189</a> <strong>public</strong>
<strong>synchronized</strong> <strong>boolean</strong> getLocationInfo() {
+<a name="190" href="#190">190</a> <strong>return</strong> locationInfo;
+<a name="191" href="#191">191</a> }
+<a name="192" href="#192">192</a>
+<a name="193" href="#193">193</a> <em>/**<em>*</em></em>
+<a name="194" href="#194">194</a> <em> * Sets whether MDC key-value pairs
should be output, default false.</em>
+<a name="195" href="#195">195</a> <em> * @param flag new value.</em>
+<a name="196" href="#196">196</a> <em> */</em>
+<a name="197" href="#197">197</a> <strong>public</strong>
<strong>synchronized</strong> <strong>void</strong>
setProperties(<strong>final</strong> <strong>boolean</strong> flag) {
+<a name="198" href="#198">198</a> properties = flag;
+<a name="199" href="#199">199</a> }
+<a name="200" href="#200">200</a>
+<a name="201" href="#201">201</a> <em>/**<em>*</em></em>
+<a name="202" href="#202">202</a> <em> * Gets whether MDC key-value pairs
should be output.</em>
+<a name="203" href="#203">203</a> <em> * @return true if MDC key-value
pairs are output.</em>
+<a name="204" href="#204">204</a> <em> */</em>
+<a name="205" href="#205">205</a> <strong>public</strong>
<strong>synchronized</strong> <strong>boolean</strong> getProperties() {
+<a name="206" href="#206">206</a> <strong>return</strong> properties;
+<a name="207" href="#207">207</a> }
+<a name="208" href="#208">208</a>
+<a name="209" href="#209">209</a>
+<a name="210" href="#210">210</a> <em>/**<em>* [EMAIL PROTECTED]
*/</em></em>
+<a name="211" href="#211">211</a> <strong>public</strong>
<strong>synchronized</strong> <strong>void</strong> activateOptions() {
+<a name="212" href="#212">212</a> <strong>if</strong> (templates ==
<strong>null</strong>) {
+<a name="213" href="#213">213</a> <strong>try</strong> {
+<a name="214" href="#214">214</a> InputStream is =
XSLTLayout.<strong>class</strong>.getResourceAsStream(<span
class="string">"default.xslt"</span>);
+<a name="215" href="#215">215</a> StreamSource ss =
<strong>new</strong> StreamSource(is);
+<a name="216" href="#216">216</a> templates =
transformerFactory.newTemplates(ss);
+<a name="217" href="#217">217</a> encoding =
Charset.forName(<span class="string">"US-ASCII"</span>);
+<a name="218" href="#218">218</a> mediaType = <span
class="string">"text/plain"</span>;
+<a name="219" href="#219">219</a> } <strong>catch</strong>
(Exception ex) {
+<a name="220" href="#220">220</a> LogLog.error(<span
class="string">"Error loading default.xslt"</span>, ex);
+<a name="221" href="#221">221</a> }
+<a name="222" href="#222">222</a> }
+<a name="223" href="#223">223</a> activated = <strong>true</strong>;
+<a name="224" href="#224">224</a> }
+<a name="225" href="#225">225</a>
+<a name="226" href="#226">226</a> <em>/**<em>*</em></em>
+<a name="227" href="#227">227</a> <em> * Gets whether throwables should
not be output.</em>
+<a name="228" href="#228">228</a> <em> * @return true if throwables should
not be output.</em>
+<a name="229" href="#229">229</a> <em> */</em>
+<a name="230" href="#230">230</a> <strong>public</strong>
<strong>synchronized</strong> <strong>boolean</strong> ignoresThrowable() {
+<a name="231" href="#231">231</a> <strong>return</strong>
ignoresThrowable;
+<a name="232" href="#232">232</a> }
+<a name="233" href="#233">233</a>
+<a name="234" href="#234">234</a> <em>/**<em>*</em></em>
+<a name="235" href="#235">235</a> <em> * Sets whether throwables should
not be output.</em>
+<a name="236" href="#236">236</a> <em> * @param ignoresThrowable if true,
throwables should not be output.</em>
+<a name="237" href="#237">237</a> <em> */</em>
+<a name="238" href="#238">238</a> <strong>public</strong>
<strong>synchronized</strong> <strong>void</strong>
setIgnoresThrowable(<strong>boolean</strong> ignoresThrowable) {
+<a name="239" href="#239">239</a> <strong>this</strong>.ignoresThrowable
= ignoresThrowable;
+<a name="240" href="#240">240</a> }
+<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>/**<em>*</em></em>
+<a name="245" href="#245">245</a> <em> * [EMAIL PROTECTED]</em>
+<a name="246" href="#246">246</a> <em> */</em>
+<a name="247" href="#247">247</a> <strong>public</strong>
<strong>synchronized</strong> String format(<strong>final</strong> LoggingEvent
event) {
+<a name="248" href="#248">248</a> <strong>if</strong> (!activated) {
+<a name="249" href="#249">249</a> activateOptions();
+<a name="250" href="#250">250</a> }
+<a name="251" href="#251">251</a> <strong>if</strong> (templates !=
<strong>null</strong> && encoding != <strong>null</strong>) {
+<a name="252" href="#252">252</a> outputStream.reset();
+<a name="253" href="#253">253</a>
+<a name="254" href="#254">254</a> <strong>try</strong> {
+<a name="255" href="#255">255</a> TransformerHandler transformer =
+<a name="256" href="#256">256</a>
transformerFactory.newTransformerHandler(templates);
+<a name="257" href="#257">257</a>
+<a name="258" href="#258">258</a>
transformer.setResult(<strong>new</strong> StreamResult(outputStream));
+<a name="259" href="#259">259</a> transformer.startDocument();
+<a name="260" href="#260">260</a>
+<a name="261" href="#261">261</a> <em class="comment">//</em>
+<a name="262" href="#262">262</a> <em class="comment">// event
element</em>
+<a name="263" href="#263">263</a> <em class="comment">//</em>
+<a name="264" href="#264">264</a> AttributesImpl attrs =
<strong>new</strong> AttributesImpl();
+<a name="265" href="#265">265</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"logger"</span>,
<span class="string">"logger"</span>,
+<a name="266" href="#266">266</a> <span
class="string">"CDATA"</span>, event.getLoggerName());
+<a name="267" href="#267">267</a>
attrs.addAttribute(<strong>null</strong>, <span
class="string">"timestamp"</span>, <span class="string">"timestamp"</span>,
+<a name="268" href="#268">268</a> <span
class="string">"CDATA"</span>, Long.toString(event.timeStamp));
+<a name="269" href="#269">269</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"level"</span>,
<span class="string">"level"</span>,
+<a name="270" href="#270">270</a> <span
class="string">"CDATA"</span>, event.getLevel().toString());
+<a name="271" href="#271">271</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"thread"</span>,
<span class="string">"thread"</span>,
+<a name="272" href="#272">272</a> <span
class="string">"CDATA"</span>, event.getThreadName());
+<a name="273" href="#273">273</a> StringBuffer buf =
<strong>new</strong> StringBuffer();
+<a name="274" href="#274">274</a>
utcDateFormat.format(event.timeStamp, buf);
+<a name="275" href="#275">275</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"time"</span>,
<span class="string">"time"</span>, <span class="string">"CDATA"</span>,
buf.toString());
+<a name="276" href="#276">276</a>
+<a name="277" href="#277">277</a>
+<a name="278" href="#278">278</a>
transformer.startElement(LOG4J_NS, <span class="string">"event"</span>, <span
class="string">"event"</span>, attrs);
+<a name="279" href="#279">279</a> attrs.clear();
+<a name="280" href="#280">280</a>
+<a name="281" href="#281">281</a> <em class="comment">//</em>
+<a name="282" href="#282">282</a> <em class="comment">// message
element</em>
+<a name="283" href="#283">283</a> <em class="comment">//</em>
+<a name="284" href="#284">284</a>
transformer.startElement(LOG4J_NS, <span class="string">"message"</span>, <span
class="string">"message"</span>, attrs);
+<a name="285" href="#285">285</a> String msg =
event.getRenderedMessage();
+<a name="286" href="#286">286</a> <strong>if</strong> (msg !=
<strong>null</strong> && msg.length() > 0) {
+<a name="287" href="#287">287</a>
transformer.characters(msg.toCharArray(), 0, msg.length());
+<a name="288" href="#288">288</a> }
+<a name="289" href="#289">289</a> transformer.endElement(LOG4J_NS,
<span class="string">"message"</span>, <span class="string">"message"</span>);
+<a name="290" href="#290">290</a>
+<a name="291" href="#291">291</a> <em class="comment">//</em>
+<a name="292" href="#292">292</a> <em class="comment">// NDC
element</em>
+<a name="293" href="#293">293</a> <em class="comment">//</em>
+<a name="294" href="#294">294</a> String ndc = event.getNDC();
+<a name="295" href="#295">295</a> <strong>if</strong> (ndc !=
<strong>null</strong>) {
+<a name="296" href="#296">296</a>
transformer.startElement(LOG4J_NS, <span class="string">"NDC"</span>, <span
class="string">"NDC"</span>, attrs);
+<a name="297" href="#297">297</a> <strong>char</strong>[]
ndcChars = ndc.toCharArray();
+<a name="298" href="#298">298</a>
transformer.characters(ndcChars, 0, ndcChars.length);
+<a name="299" href="#299">299</a>
transformer.endElement(LOG4J_NS, <span class="string">"NDC"</span>, <span
class="string">"NDC"</span>);
+<a name="300" href="#300">300</a> }
+<a name="301" href="#301">301</a>
+<a name="302" href="#302">302</a> <em class="comment">//</em>
+<a name="303" href="#303">303</a> <em class="comment">//
throwable element unless suppressed</em>
+<a name="304" href="#304">304</a> <em class="comment">//</em>
+<a name="305" href="#305">305</a> <strong>if</strong>
(!ignoresThrowable) {
+<a name="306" href="#306">306</a> String[] s =
event.getThrowableStrRep();
+<a name="307" href="#307">307</a> <strong>if</strong> (s !=
<strong>null</strong>) {
+<a name="308" href="#308">308</a>
transformer.startElement(LOG4J_NS, <span class="string">"throwable"</span>,
+<a name="309" href="#309">309</a> <span
class="string">"throwable"</span>, attrs);
+<a name="310" href="#310">310</a> <strong>char</strong>[]
nl = <strong>new</strong> <strong>char</strong>[] { '\n' };
+<a name="311" href="#311">311</a> <strong>for</strong>
(<strong>int</strong> i = 0; i < s.length; i++) {
+<a name="312" href="#312">312</a>
<strong>char</strong>[] line = s[i].toCharArray();
+<a name="313" href="#313">313</a>
transformer.characters(line, 0, line.length);
+<a name="314" href="#314">314</a>
transformer.characters(nl, 0, nl.length);
+<a name="315" href="#315">315</a> }
+<a name="316" href="#316">316</a>
transformer.endElement(LOG4J_NS, <span class="string">"throwable"</span>, <span
class="string">"throwable"</span>);
+<a name="317" href="#317">317</a> }
+<a name="318" href="#318">318</a> }
+<a name="319" href="#319">319</a>
+<a name="320" href="#320">320</a> <em class="comment">//</em>
+<a name="321" href="#321">321</a> <em class="comment">//
location info unless suppressed</em>
+<a name="322" href="#322">322</a> <em class="comment">//</em>
+<a name="323" href="#323">323</a> <em class="comment">//</em>
+<a name="324" href="#324">324</a> <strong>if</strong>
(locationInfo) {
+<a name="325" href="#325">325</a> LocationInfo locationInfo =
event.getLocationInformation();
+<a name="326" href="#326">326</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"class"</span>,
<span class="string">"class"</span>, <span class="string">"CDATA"</span>,
+<a name="327" href="#327">327</a>
locationInfo.getClassName());
+<a name="328" href="#328">328</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"method"</span>,
<span class="string">"method"</span>, <span class="string">"CDATA"</span>,
+<a name="329" href="#329">329</a>
locationInfo.getMethodName());
+<a name="330" href="#330">330</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"file"</span>,
<span class="string">"file"</span>, <span class="string">"CDATA"</span>,
+<a name="331" href="#331">331</a>
locationInfo.getFileName());
+<a name="332" href="#332">332</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"line"</span>,
<span class="string">"line"</span>, <span class="string">"CDATA"</span>,
+<a name="333" href="#333">333</a>
locationInfo.getLineNumber());
+<a name="334" href="#334">334</a>
transformer.startElement(LOG4J_NS, <span class="string">"locationInfo"</span>,
+<a name="335" href="#335">335</a> <span
class="string">"locationInfo"</span>, attrs);
+<a name="336" href="#336">336</a>
transformer.endElement(LOG4J_NS, <span class="string">"locationInfo"</span>,
+<a name="337" href="#337">337</a> <span
class="string">"locationInfo"</span>);
+<a name="338" href="#338">338</a> }
+<a name="339" href="#339">339</a>
+<a name="340" href="#340">340</a> <strong>if</strong>
(properties) {
+<a name="341" href="#341">341</a> <em class="comment">//</em>
+<a name="342" href="#342">342</a> <em class="comment">//
write MDC contents out as properties element</em>
+<a name="343" href="#343">343</a> <em class="comment">//</em>
+<a name="344" href="#344">344</a> Set mdcKeySet =
MDCKeySetExtractor.INSTANCE.getPropertyKeySet(event);
+<a name="345" href="#345">345</a>
+<a name="346" href="#346">346</a> <strong>if</strong>
((mdcKeySet != <strong>null</strong>) && (mdcKeySet.size() > 0)) {
+<a name="347" href="#347">347</a> attrs.clear();
+<a name="348" href="#348">348</a>
transformer.startElement(LOG4J_NS,
+<a name="349" href="#349">349</a> <span
class="string">"properties"</span>, <span class="string">"properties"</span>,
attrs);
+<a name="350" href="#350">350</a> Object[] keys =
mdcKeySet.toArray();
+<a name="351" href="#351">351</a> Arrays.sort(keys);
+<a name="352" href="#352">352</a> <strong>for</strong>
(<strong>int</strong> i = 0; i < keys.length; i++) {
+<a name="353" href="#353">353</a> String key =
keys[i].toString();
+<a name="354" href="#354">354</a> Object val =
event.getMDC(key);
+<a name="355" href="#355">355</a> attrs.clear();
+<a name="356" href="#356">356</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"name"</span>,
<span class="string">"name"</span>, <span class="string">"CDATA"</span>, key);
+<a name="357" href="#357">357</a>
attrs.addAttribute(<strong>null</strong>, <span class="string">"value"</span>,
<span class="string">"value"</span>,
+<a name="358" href="#358">358</a> <span
class="string">"CDATA"</span>, val.toString());
+<a name="359" href="#359">359</a>
transformer.startElement(LOG4J_NS,
+<a name="360" href="#360">360</a> <span
class="string">"data"</span>, <span class="string">"data"</span>, attrs);
+<a name="361" href="#361">361</a>
transformer.endElement(LOG4J_NS, <span class="string">"data"</span>, <span
class="string">"data"</span>);
+<a name="362" href="#362">362</a> }
+<a name="363" href="#363">363</a> }
+<a name="364" href="#364">364</a> }
+<a name="365" href="#365">365</a>
+<a name="366" href="#366">366</a>
+<a name="367" href="#367">367</a> transformer.endElement(LOG4J_NS,
<span class="string">"event"</span>, <span class="string">"event"</span>);
+<a name="368" href="#368">368</a> transformer.endDocument();
+<a name="369" href="#369">369</a>
+<a name="370" href="#370">370</a> String body = encoding.decode(
+<a name="371" href="#371">371</a>
ByteBuffer.wrap(outputStream.toByteArray())).toString();
+<a name="372" href="#372">372</a> outputStream.reset();
+<a name="373" href="#373">373</a> <em class="comment">//</em>
+<a name="374" href="#374">374</a> <em class="comment">// must
remove XML declaration since it may</em>
+<a name="375" href="#375">375</a> <em class="comment">//
result in erroneous encoding info</em>
+<a name="376" href="#376">376</a> <em class="comment">// if
written by FileAppender in a different encoding</em>
+<a name="377" href="#377">377</a> <strong>if</strong>
(body.startsWith(<span class="string">"<?xml "</span>)) {
+<a name="378" href="#378">378</a> <strong>int</strong> endDecl
= body.indexOf(<span class="string">"?>"</span>);
+<a name="379" href="#379">379</a> <strong>if</strong> (endDecl
!= -1) {
+<a name="380" href="#380">380</a> endDecl += 2;
+<a name="381" href="#381">381</a> <strong>if</strong>
(endDecl < body.length() && body.charAt(endDecl) == '\n') {
+<a name="382" href="#382">382</a> endDecl++;
+<a name="383" href="#383">383</a> }
+<a name="384" href="#384">384</a> <strong>return</strong>
body.substring(endDecl);
+<a name="385" href="#385">385</a> }
+<a name="386" href="#386">386</a> }
+<a name="387" href="#387">387</a> <strong>return</strong> body;
+<a name="388" href="#388">388</a> } <strong>catch</strong>
(Exception ex) {
+<a name="389" href="#389">389</a> LogLog.error(<span
class="string">"Error during transformation"</span>, ex);
+<a name="390" href="#390">390</a> <strong>return</strong>
ex.toString();
+<a name="391" href="#391">391</a> }
+<a name="392" href="#392">392</a> }
+<a name="393" href="#393">393</a> <strong>return</strong> <span
class="string">"No valid transform or encoding specified."</span>;
+<a name="394" href="#394">394</a> }
+<a name="395" href="#395">395</a>
+<a name="396" href="#396">396</a> <em>/**<em>*</em></em>
+<a name="397" href="#397">397</a> <em> * Sets XSLT transform.</em>
+<a name="398" href="#398">398</a> <em> * @param xsltdoc DOM document
containing XSLT transform source,</em>
+<a name="399" href="#399">399</a> <em> * may be modified.</em>
+<a name="400" href="#400">400</a> <em> * @throws
TransformerConfigurationException if transformer can not be</em>
+<a name="401" href="#401">401</a> <em> * created.</em>
+<a name="402" href="#402">402</a> <em> */</em>
+<a name="403" href="#403">403</a> <strong>public</strong>
<strong>void</strong> setTransform(<strong>final</strong> Document xsltdoc)
+<a name="404" href="#404">404</a> throws
TransformerConfigurationException {
+<a name="405" href="#405">405</a> <em class="comment">//</em>
+<a name="406" href="#406">406</a> <em class="comment">// scan
transform source for xsl:output elements</em>
+<a name="407" href="#407">407</a> <em class="comment">// and
extract encoding, media (mime) type and output method</em>
+<a name="408" href="#408">408</a> <em class="comment">//</em>
+<a name="409" href="#409">409</a> String encodingName =
<strong>null</strong>;
+<a name="410" href="#410">410</a> mediaType = <strong>null</strong>;
+<a name="411" href="#411">411</a> String method =
<strong>null</strong>;
+<a name="412" href="#412">412</a> NodeList nodes =
xsltdoc.getElementsByTagNameNS(
+<a name="413" href="#413">413</a> XSLT_NS,
+<a name="414" href="#414">414</a> <span
class="string">"output"</span>);
+<a name="415" href="#415">415</a>
<strong>for</strong>(<strong>int</strong> i = 0; i < nodes.getLength(); i++)
{
+<a name="416" href="#416">416</a> Element outputElement =
(Element) nodes.item(i);
+<a name="417" href="#417">417</a> <strong>if</strong> (method ==
<strong>null</strong> || method.length() == 0) {
+<a name="418" href="#418">418</a> method =
outputElement.getAttributeNS(<strong>null</strong>, <span
class="string">"method"</span>);
+<a name="419" href="#419">419</a> }
+<a name="420" href="#420">420</a> <strong>if</strong>
(encodingName == <strong>null</strong> || encodingName.length() == 0) {
+<a name="421" href="#421">421</a> encodingName =
outputElement.getAttributeNS(<strong>null</strong>, <span
class="string">"encoding"</span>);
+<a name="422" href="#422">422</a> }
+<a name="423" href="#423">423</a> <strong>if</strong> (mediaType
== <strong>null</strong> || mediaType.length() == 0) {
+<a name="424" href="#424">424</a> mediaType =
outputElement.getAttributeNS(<strong>null</strong>, <span
class="string">"media-type"</span>);
+<a name="425" href="#425">425</a> }
+<a name="426" href="#426">426</a> }
+<a name="427" href="#427">427</a>
+<a name="428" href="#428">428</a> <strong>if</strong> (mediaType ==
<strong>null</strong> || mediaType.length() == 0) {
+<a name="429" href="#429">429</a> <strong>if</strong> (<span
class="string">"html"</span>.equals(method)) {
+<a name="430" href="#430">430</a> mediaType = <span
class="string">"text/html"</span>;
+<a name="431" href="#431">431</a> } <strong>else</strong>
<strong>if</strong> (<span class="string">"xml"</span>.equals(method)) {
+<a name="432" href="#432">432</a> mediaType = <span
class="string">"text/xml"</span>;
+<a name="433" href="#433">433</a> } <strong>else</strong> {
+<a name="434" href="#434">434</a> mediaType = <span
class="string">"text/plain"</span>;
+<a name="435" href="#435">435</a> }
+<a name="436" href="#436">436</a> }
+<a name="437" href="#437">437</a>
+<a name="438" href="#438">438</a> <em class="comment">//</em>
+<a name="439" href="#439">439</a> <em class="comment">// if encoding
was not specified,</em>
+<a name="440" href="#440">440</a> <em class="comment">// add
xsl:output encoding=US-ASCII to XSLT source</em>
+<a name="441" href="#441">441</a> <em class="comment">//</em>
+<a name="442" href="#442">442</a> <strong>if</strong> (encodingName ==
<strong>null</strong> || encodingName.length() == 0) {
+<a name="443" href="#443">443</a> Element transformElement =
xsltdoc.getDocumentElement();
+<a name="444" href="#444">444</a> Element outputElement = xsltdoc.
+<a name="445" href="#445">445</a> createElementNS(XSLT_NS,
<span class="string">"output"</span>);
+<a name="446" href="#446">446</a>
outputElement.setAttributeNS(<strong>null</strong>, <span
class="string">"encoding"</span>, <span class="string">"US-ASCII"</span>);
+<a name="447" href="#447">447</a>
transformElement.insertBefore(outputElement, transformElement.getFirstChild());
+<a name="448" href="#448">448</a> encoding = Charset.forName(<span
class="string">"US-ASCII"</span>);
+<a name="449" href="#449">449</a> } <strong>else</strong> {
+<a name="450" href="#450">450</a> encoding =
Charset.forName(encodingName);
+<a name="451" href="#451">451</a> }
+<a name="452" href="#452">452</a>
+<a name="453" href="#453">453</a> DOMSource transformSource =
<strong>new</strong> DOMSource(xsltdoc);
+<a name="454" href="#454">454</a>
+<a name="455" href="#455">455</a> templates =
transformerFactory.newTemplates(transformSource);
+<a name="456" href="#456">456</a>
+<a name="457" href="#457">457</a> }
+<a name="458" href="#458">458</a>
+<a name="459" href="#459">459</a> <em>/**<em>*</em></em>
+<a name="460" href="#460">460</a> <em> * [EMAIL PROTECTED]</em>
+<a name="461" href="#461">461</a> <em> */</em>
+<a name="462" href="#462">462</a> <strong>public</strong>
<strong>boolean</strong> parseUnrecognizedElement(<strong>final</strong>
Element element,
+<a name="463" href="#463">463</a>
<strong>final</strong> Properties props)
+<a name="464" href="#464">464</a> throws Exception {
+<a name="465" href="#465">465</a> <strong>if</strong>
(XSLT_NS.equals(element.getNamespaceURI()) ||
+<a name="466" href="#466">466</a>
element.getNodeName().indexOf(<span class="string">"transform"</span>) != -1 ||
+<a name="467" href="#467">467</a>
element.getNodeName().indexOf(<span class="string">"stylesheet"</span>) != -1) {
+<a name="468" href="#468">468</a> <em class="comment">//</em>
+<a name="469" href="#469">469</a> <em class="comment">//
DOMConfigurator typically not namespace aware</em>
+<a name="470" href="#470">470</a> <em class="comment">//
serialize tree and reparse.</em>
+<a name="471" href="#471">471</a> ByteArrayOutputStream os =
<strong>new</strong> ByteArrayOutputStream();
+<a name="472" href="#472">472</a> DOMSource source =
<strong>new</strong> DOMSource(element);
+<a name="473" href="#473">473</a> TransformerFactory
transformerFactory = TransformerFactory.newInstance();
+<a name="474" href="#474">474</a> Transformer transformer =
transformerFactory.newTransformer();
+<a name="475" href="#475">475</a> transformer.transform(source,
<strong>new</strong> StreamResult(os));
+<a name="476" href="#476">476</a>
+<a name="477" href="#477">477</a> ByteArrayInputStream is =
<strong>new</strong> ByteArrayInputStream(os.toByteArray());
+<a name="478" href="#478">478</a> DocumentBuilderFactory
domFactory = DocumentBuilderFactory.newInstance();
+<a name="479" href="#479">479</a>
domFactory.setNamespaceAware(<strong>true</strong>);
+<a name="480" href="#480">480</a> Document xsltdoc =
domFactory.newDocumentBuilder().parse(is);
+<a name="481" href="#481">481</a> setTransform(xsltdoc);
+<a name="482" href="#482">482</a> <strong>return</strong>
<strong>true</strong>;
+<a name="483" href="#483">483</a> }
+<a name="484" href="#484">484</a> <strong>return</strong> false;
+<a name="485" href="#485">485</a> }
+<a name="486" href="#486">486</a>
+<a name="487" href="#487">487</a>
+<a name="488" href="#488">488</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a
href="http://maven.apache.org/";>Maven</a></div></body>
+</html>
+
Propchange:
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/XSLTLayout.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Modified:
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-frame.html
URL:
http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-frame.html?rev=569257&r1=569256&r2=569257&view=diff
==============================================================================
---
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-frame.html
(original)
+++
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-frame.html
Thu Aug 23 22:43:39 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.xml</title>
+ <title>Apache Extras Companion for log4j 1.2. 1.0 Reference
Package org.apache.log4j.xml</title>
<link rel="stylesheet" type="text/css"
href="../../../../stylesheet.css" title="style" />
</head>
<body>
@@ -17,6 +17,9 @@
<ul>
<li>
<a href="UnrecognizedElementHandler.html"
target="classFrame">UnrecognizedElementHandler</a>
+ </li>
+ <li>
+ <a href="XSLTLayout.html" target="classFrame">XSLTLayout</a>
</li>
</ul>
Modified:
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-summary.html
URL:
http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-summary.html?rev=569257&r1=569256&r2=569257&view=diff
==============================================================================
---
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-summary.html
(original)
+++
logging/site/trunk/docs/log4j/companions/extras/xref/org/apache/log4j/xml/package-summary.html
Thu Aug 23 22:43:39 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>
@@ -38,6 +38,11 @@
<tr>
<td>
<a href="UnrecognizedElementHandler.html"
target="classFrame">UnrecognizedElementHandler</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="XSLTLayout.html"
target="classFrame">XSLTLayout</a>
</td>
</tr>
</tbody>
