blob: f48e33a02ccb0631f665046398ba9bac80dc4d69 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: OutputPropertiesFactory.java 468654 2006-10-28 07:09:23Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.serializer;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.BufferedInputStream;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.IOException;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.io.InputStream;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.security.AccessController;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.security.PrivilegedAction;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.Enumeration;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.Properties;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> import javax.xml.transform.OutputKeys;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xml.serializer.utils.MsgKey;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xml.serializer.utils.Utils;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xml.serializer.utils.WrappedRuntimeException;<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> /**<a name="line.37"></a>
<FONT color="green">038</FONT> * This class is a factory to generate a set of default properties<a name="line.38"></a>
<FONT color="green">039</FONT> * of key/value pairs that are used to create a serializer through the<a name="line.39"></a>
<FONT color="green">040</FONT> * factory {@link SerializerFactory SerilizerFactory}. <a name="line.40"></a>
<FONT color="green">041</FONT> * The properties generated by this factory<a name="line.41"></a>
<FONT color="green">042</FONT> * may be modified to non-default values before the SerializerFactory is used to<a name="line.42"></a>
<FONT color="green">043</FONT> * create a Serializer.<a name="line.43"></a>
<FONT color="green">044</FONT> * &lt;p&gt;<a name="line.44"></a>
<FONT color="green">045</FONT> * The given output types supported are "xml", "text", and "html". <a name="line.45"></a>
<FONT color="green">046</FONT> * These type strings can be obtained from the <a name="line.46"></a>
<FONT color="green">047</FONT> * {@link Method Method} class in this package.<a name="line.47"></a>
<FONT color="green">048</FONT> * &lt;p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT> * Other constants defined in this class are the non-standard property keys<a name="line.49"></a>
<FONT color="green">050</FONT> * that can be used to set non-standard property values on a java.util.Properties object<a name="line.50"></a>
<FONT color="green">051</FONT> * that is used to create or configure a serializer. Here are the non-standard keys:<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;ul&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;li&gt; &lt;b&gt;S_KEY_INDENT_AMOUNT &lt;/b&gt; -<a name="line.53"></a>
<FONT color="green">054</FONT> * The non-standard property key to use to set the indentation amount.<a name="line.54"></a>
<FONT color="green">055</FONT> * The "indent" key needs to have a value of "yes", and this<a name="line.55"></a>
<FONT color="green">056</FONT> * properties value is a the number of whitespaces to indent by per<a name="line.56"></a>
<FONT color="green">057</FONT> * indentation level.<a name="line.57"></a>
<FONT color="green">058</FONT> * <a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;li&gt; &lt;b&gt;S_KEY_CONTENT_HANDLER &lt;/b&gt; -<a name="line.59"></a>
<FONT color="green">060</FONT> * This non-standard property key is used to set the name of the fully qualified <a name="line.60"></a>
<FONT color="green">061</FONT> * Java class that implements the ContentHandler interface. <a name="line.61"></a>
<FONT color="green">062</FONT> * The output of the serializer will be SAX events sent to this an<a name="line.62"></a>
<FONT color="green">063</FONT> * object of this class.<a name="line.63"></a>
<FONT color="green">064</FONT> * <a name="line.64"></a>
<FONT color="green">065</FONT> * &lt;li&gt; &lt;b&gt;S_KEY_ENTITIES &lt;/b&gt; -<a name="line.65"></a>
<FONT color="green">066</FONT> * This non-standard property key is used to specify the name of the property file<a name="line.66"></a>
<FONT color="green">067</FONT> * that specifies character to entity reference mappings. A line in such a<a name="line.67"></a>
<FONT color="green">068</FONT> * file is has the name of the entity and the numeric (base 10) value<a name="line.68"></a>
<FONT color="green">069</FONT> * of the corresponding character, like this one: &lt;br&gt; quot=34 &lt;br&gt;<a name="line.69"></a>
<FONT color="green">070</FONT> * <a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;li&gt; &lt;b&gt;S_USE_URL_ESCAPING &lt;/b&gt; -<a name="line.71"></a>
<FONT color="green">072</FONT> * This non-standard property key is used to set a value of "yes" if the href values for HTML serialization should<a name="line.72"></a>
<FONT color="green">073</FONT> * use %xx escaping.<a name="line.73"></a>
<FONT color="green">074</FONT> * <a name="line.74"></a>
<FONT color="green">075</FONT> * &lt;li&gt; &lt;b&gt;S_OMIT_META_TAG &lt;/b&gt; -<a name="line.75"></a>
<FONT color="green">076</FONT> * This non-standard property key is used to set a value of "yes" if the META tag should be omitted where it would<a name="line.76"></a>
<FONT color="green">077</FONT> * otherwise be supplied.<a name="line.77"></a>
<FONT color="green">078</FONT> * &lt;/ul&gt;<a name="line.78"></a>
<FONT color="green">079</FONT> * <a name="line.79"></a>
<FONT color="green">080</FONT> * @see SerializerFactory<a name="line.80"></a>
<FONT color="green">081</FONT> * @see Method<a name="line.81"></a>
<FONT color="green">082</FONT> * @see Serializer<a name="line.82"></a>
<FONT color="green">083</FONT> */<a name="line.83"></a>
<FONT color="green">084</FONT> public final class OutputPropertiesFactory<a name="line.84"></a>
<FONT color="green">085</FONT> {<a name="line.85"></a>
<FONT color="green">086</FONT> /** S_BUILTIN_EXTENSIONS_URL is a mnemonic for the XML Namespace <a name="line.86"></a>
<FONT color="green">087</FONT> *(http://xml.apache.org/xalan) predefined to signify Xalan's<a name="line.87"></a>
<FONT color="green">088</FONT> * built-in XSLT Extensions. When used in stylesheets, this is often <a name="line.88"></a>
<FONT color="green">089</FONT> * bound to the "xalan:" prefix.<a name="line.89"></a>
<FONT color="green">090</FONT> */<a name="line.90"></a>
<FONT color="green">091</FONT> private static final String <a name="line.91"></a>
<FONT color="green">092</FONT> S_BUILTIN_EXTENSIONS_URL = "http://xml.apache.org/xalan"; <a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * The old built-in extension url. It is still supported for<a name="line.95"></a>
<FONT color="green">096</FONT> * backward compatibility.<a name="line.96"></a>
<FONT color="green">097</FONT> */<a name="line.97"></a>
<FONT color="green">098</FONT> private static final String <a name="line.98"></a>
<FONT color="green">099</FONT> S_BUILTIN_OLD_EXTENSIONS_URL = "http://xml.apache.org/xslt"; <a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> //************************************************************<a name="line.101"></a>
<FONT color="green">102</FONT> //* PUBLIC CONSTANTS<a name="line.102"></a>
<FONT color="green">103</FONT> //************************************************************<a name="line.103"></a>
<FONT color="green">104</FONT> /** <a name="line.104"></a>
<FONT color="green">105</FONT> * This is not a public API.<a name="line.105"></a>
<FONT color="green">106</FONT> * This is the built-in extensions namespace, <a name="line.106"></a>
<FONT color="green">107</FONT> * reexpressed in {namespaceURI} syntax<a name="line.107"></a>
<FONT color="green">108</FONT> * suitable for prepending to a localname to produce a "universal<a name="line.108"></a>
<FONT color="green">109</FONT> * name".<a name="line.109"></a>
<FONT color="green">110</FONT> */<a name="line.110"></a>
<FONT color="green">111</FONT> public static final String S_BUILTIN_EXTENSIONS_UNIVERSAL =<a name="line.111"></a>
<FONT color="green">112</FONT> "{" + S_BUILTIN_EXTENSIONS_URL + "}";<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> // Some special Xalan keys.<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> /** <a name="line.116"></a>
<FONT color="green">117</FONT> * The non-standard property key to use to set the<a name="line.117"></a>
<FONT color="green">118</FONT> * number of whitepaces to indent by, per indentation level,<a name="line.118"></a>
<FONT color="green">119</FONT> * if indent="yes".<a name="line.119"></a>
<FONT color="green">120</FONT> */<a name="line.120"></a>
<FONT color="green">121</FONT> public static final String S_KEY_INDENT_AMOUNT =<a name="line.121"></a>
<FONT color="green">122</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "indent-amount";<a name="line.122"></a>
<FONT color="green">123</FONT> <a name="line.123"></a>
<FONT color="green">124</FONT> /** <a name="line.124"></a>
<FONT color="green">125</FONT> * The non-standard property key to use to set the<a name="line.125"></a>
<FONT color="green">126</FONT> * characters to write out as at the end of a line,<a name="line.126"></a>
<FONT color="green">127</FONT> * rather than the default ones from the runtime.<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> public static final String S_KEY_LINE_SEPARATOR =<a name="line.129"></a>
<FONT color="green">130</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "line-separator"; <a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> /** This non-standard property key is used to set the name of the fully qualified <a name="line.132"></a>
<FONT color="green">133</FONT> * Java class that implements the ContentHandler interface. <a name="line.133"></a>
<FONT color="green">134</FONT> * Fully qualified name of class with a default constructor that<a name="line.134"></a>
<FONT color="green">135</FONT> * implements the ContentHandler interface, where the result tree events<a name="line.135"></a>
<FONT color="green">136</FONT> * will be sent to.<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> public static final String S_KEY_CONTENT_HANDLER =<a name="line.139"></a>
<FONT color="green">140</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "content-handler";<a name="line.140"></a>
<FONT color="green">141</FONT> <a name="line.141"></a>
<FONT color="green">142</FONT> /**<a name="line.142"></a>
<FONT color="green">143</FONT> * This non-standard property key is used to specify the name of the property file<a name="line.143"></a>
<FONT color="green">144</FONT> * that specifies character to entity reference mappings.<a name="line.144"></a>
<FONT color="green">145</FONT> */<a name="line.145"></a>
<FONT color="green">146</FONT> public static final String S_KEY_ENTITIES =<a name="line.146"></a>
<FONT color="green">147</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "entities";<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /** <a name="line.149"></a>
<FONT color="green">150</FONT> * This non-standard property key is used to set a value of "yes" if the href values for HTML serialization should<a name="line.150"></a>
<FONT color="green">151</FONT> * use %xx escaping. */<a name="line.151"></a>
<FONT color="green">152</FONT> public static final String S_USE_URL_ESCAPING =<a name="line.152"></a>
<FONT color="green">153</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "use-url-escaping";<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> /** <a name="line.155"></a>
<FONT color="green">156</FONT> * This non-standard property key is used to set a value of "yes" if the META tag should be omitted where it would<a name="line.156"></a>
<FONT color="green">157</FONT> * otherwise be supplied.<a name="line.157"></a>
<FONT color="green">158</FONT> */<a name="line.158"></a>
<FONT color="green">159</FONT> public static final String S_OMIT_META_TAG =<a name="line.159"></a>
<FONT color="green">160</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL + "omit-meta-tag";<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> /**<a name="line.162"></a>
<FONT color="green">163</FONT> * The old built-in extension namespace, this is not a public API.<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> public static final String S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL =<a name="line.165"></a>
<FONT color="green">166</FONT> "{" + S_BUILTIN_OLD_EXTENSIONS_URL + "}";<a name="line.166"></a>
<FONT color="green">167</FONT> <a name="line.167"></a>
<FONT color="green">168</FONT> /**<a name="line.168"></a>
<FONT color="green">169</FONT> * This is not a public API, it is only public because it is used<a name="line.169"></a>
<FONT color="green">170</FONT> * by outside of this package,<a name="line.170"></a>
<FONT color="green">171</FONT> * it is the length of the old built-in extension namespace.<a name="line.171"></a>
<FONT color="green">172</FONT> */<a name="line.172"></a>
<FONT color="green">173</FONT> public static final int S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL_LEN =<a name="line.173"></a>
<FONT color="green">174</FONT> S_BUILTIN_OLD_EXTENSIONS_UNIVERSAL.length();<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> //************************************************************<a name="line.176"></a>
<FONT color="green">177</FONT> //* PRIVATE CONSTANTS<a name="line.177"></a>
<FONT color="green">178</FONT> //************************************************************<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> private static final String S_XSLT_PREFIX = "xslt.output.";<a name="line.180"></a>
<FONT color="green">181</FONT> private static final int S_XSLT_PREFIX_LEN = S_XSLT_PREFIX.length();<a name="line.181"></a>
<FONT color="green">182</FONT> private static final String S_XALAN_PREFIX = "org.apache.xslt.";<a name="line.182"></a>
<FONT color="green">183</FONT> private static final int S_XALAN_PREFIX_LEN = S_XALAN_PREFIX.length();<a name="line.183"></a>
<FONT color="green">184</FONT> <a name="line.184"></a>
<FONT color="green">185</FONT> /** Synchronization object for lazy initialization of the above tables. */<a name="line.185"></a>
<FONT color="green">186</FONT> private static Integer m_synch_object = new Integer(1);<a name="line.186"></a>
<FONT color="green">187</FONT> <a name="line.187"></a>
<FONT color="green">188</FONT> /** the directory in which the various method property files are located */<a name="line.188"></a>
<FONT color="green">189</FONT> private static final String PROP_DIR = SerializerBase.PKG_PATH+'/';<a name="line.189"></a>
<FONT color="green">190</FONT> /** property file for default XML properties */<a name="line.190"></a>
<FONT color="green">191</FONT> private static final String PROP_FILE_XML = "output_xml.properties";<a name="line.191"></a>
<FONT color="green">192</FONT> /** property file for default TEXT properties */<a name="line.192"></a>
<FONT color="green">193</FONT> private static final String PROP_FILE_TEXT = "output_text.properties";<a name="line.193"></a>
<FONT color="green">194</FONT> /** property file for default HTML properties */<a name="line.194"></a>
<FONT color="green">195</FONT> private static final String PROP_FILE_HTML = "output_html.properties";<a name="line.195"></a>
<FONT color="green">196</FONT> /** property file for default UNKNOWN (Either XML or HTML, to be determined later) properties */<a name="line.196"></a>
<FONT color="green">197</FONT> private static final String PROP_FILE_UNKNOWN = "output_unknown.properties";<a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> //************************************************************<a name="line.199"></a>
<FONT color="green">200</FONT> //* PRIVATE STATIC FIELDS<a name="line.200"></a>
<FONT color="green">201</FONT> //************************************************************<a name="line.201"></a>
<FONT color="green">202</FONT> <a name="line.202"></a>
<FONT color="green">203</FONT> /** The default properties of all output files. */<a name="line.203"></a>
<FONT color="green">204</FONT> private static Properties m_xml_properties = null;<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> /** The default properties when method="html". */<a name="line.206"></a>
<FONT color="green">207</FONT> private static Properties m_html_properties = null;<a name="line.207"></a>
<FONT color="green">208</FONT> <a name="line.208"></a>
<FONT color="green">209</FONT> /** The default properties when method="text". */<a name="line.209"></a>
<FONT color="green">210</FONT> private static Properties m_text_properties = null;<a name="line.210"></a>
<FONT color="green">211</FONT> <a name="line.211"></a>
<FONT color="green">212</FONT> /** The properties when method="" for the "unknown" wrapper */<a name="line.212"></a>
<FONT color="green">213</FONT> private static Properties m_unknown_properties = null;<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> private static final Class<a name="line.215"></a>
<FONT color="green">216</FONT> ACCESS_CONTROLLER_CLASS = findAccessControllerClass();<a name="line.216"></a>
<FONT color="green">217</FONT> <a name="line.217"></a>
<FONT color="green">218</FONT> private static Class findAccessControllerClass() {<a name="line.218"></a>
<FONT color="green">219</FONT> try<a name="line.219"></a>
<FONT color="green">220</FONT> {<a name="line.220"></a>
<FONT color="green">221</FONT> // This Class was introduced in JDK 1.2. With the re-architecture of<a name="line.221"></a>
<FONT color="green">222</FONT> // security mechanism ( starting in JDK 1.2 ), we have option of<a name="line.222"></a>
<FONT color="green">223</FONT> // giving privileges to certain part of code using doPrivileged block.<a name="line.223"></a>
<FONT color="green">224</FONT> // In JDK1.1.X applications won't be having security manager and if<a name="line.224"></a>
<FONT color="green">225</FONT> // there is security manager ( in applets ), code need to be signed<a name="line.225"></a>
<FONT color="green">226</FONT> // and trusted for having access to resources.<a name="line.226"></a>
<FONT color="green">227</FONT> <a name="line.227"></a>
<FONT color="green">228</FONT> return Class.forName("java.security.AccessController");<a name="line.228"></a>
<FONT color="green">229</FONT> }<a name="line.229"></a>
<FONT color="green">230</FONT> catch (Exception e)<a name="line.230"></a>
<FONT color="green">231</FONT> {<a name="line.231"></a>
<FONT color="green">232</FONT> //User may be using older JDK ( JDK &lt;1.2 ). Allow him/her to use it.<a name="line.232"></a>
<FONT color="green">233</FONT> // But don't try to use doPrivileged<a name="line.233"></a>
<FONT color="green">234</FONT> }<a name="line.234"></a>
<FONT color="green">235</FONT> <a name="line.235"></a>
<FONT color="green">236</FONT> return null;<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> <a name="line.238"></a>
<FONT color="green">239</FONT> /**<a name="line.239"></a>
<FONT color="green">240</FONT> * Creates an empty OutputProperties with the property key/value defaults specified by<a name="line.240"></a>
<FONT color="green">241</FONT> * a property file. The method argument is used to construct a string of<a name="line.241"></a>
<FONT color="green">242</FONT> * the form output_[method].properties (for instance, output_html.properties).<a name="line.242"></a>
<FONT color="green">243</FONT> * The output_xml.properties file is always used as the base.<a name="line.243"></a>
<FONT color="green">244</FONT> * <a name="line.244"></a>
<FONT color="green">245</FONT> * &lt;p&gt;Anything other than 'text', 'xml', and 'html', will<a name="line.245"></a>
<FONT color="green">246</FONT> * use the output_xml.properties file.&lt;/p&gt;<a name="line.246"></a>
<FONT color="green">247</FONT> *<a name="line.247"></a>
<FONT color="green">248</FONT> * @param method non-null reference to method name.<a name="line.248"></a>
<FONT color="green">249</FONT> *<a name="line.249"></a>
<FONT color="green">250</FONT> * @return Properties object that holds the defaults for the given method.<a name="line.250"></a>
<FONT color="green">251</FONT> */<a name="line.251"></a>
<FONT color="green">252</FONT> static public final Properties getDefaultMethodProperties(String method)<a name="line.252"></a>
<FONT color="green">253</FONT> {<a name="line.253"></a>
<FONT color="green">254</FONT> String fileName = null;<a name="line.254"></a>
<FONT color="green">255</FONT> Properties defaultProperties = null;<a name="line.255"></a>
<FONT color="green">256</FONT> // According to this article : Double-check locking does not work<a name="line.256"></a>
<FONT color="green">257</FONT> // http://www.javaworld.com/javaworld/jw-02-2001/jw-0209-toolbox.html<a name="line.257"></a>
<FONT color="green">258</FONT> try<a name="line.258"></a>
<FONT color="green">259</FONT> {<a name="line.259"></a>
<FONT color="green">260</FONT> synchronized (m_synch_object)<a name="line.260"></a>
<FONT color="green">261</FONT> {<a name="line.261"></a>
<FONT color="green">262</FONT> if (null == m_xml_properties) // double check<a name="line.262"></a>
<FONT color="green">263</FONT> {<a name="line.263"></a>
<FONT color="green">264</FONT> fileName = PROP_FILE_XML;<a name="line.264"></a>
<FONT color="green">265</FONT> m_xml_properties = loadPropertiesFile(fileName, null);<a name="line.265"></a>
<FONT color="green">266</FONT> }<a name="line.266"></a>
<FONT color="green">267</FONT> }<a name="line.267"></a>
<FONT color="green">268</FONT> <a name="line.268"></a>
<FONT color="green">269</FONT> if (method.equals(Method.XML))<a name="line.269"></a>
<FONT color="green">270</FONT> {<a name="line.270"></a>
<FONT color="green">271</FONT> defaultProperties = m_xml_properties;<a name="line.271"></a>
<FONT color="green">272</FONT> }<a name="line.272"></a>
<FONT color="green">273</FONT> else if (method.equals(Method.HTML))<a name="line.273"></a>
<FONT color="green">274</FONT> {<a name="line.274"></a>
<FONT color="green">275</FONT> if (null == m_html_properties) // double check<a name="line.275"></a>
<FONT color="green">276</FONT> {<a name="line.276"></a>
<FONT color="green">277</FONT> fileName = PROP_FILE_HTML;<a name="line.277"></a>
<FONT color="green">278</FONT> m_html_properties =<a name="line.278"></a>
<FONT color="green">279</FONT> loadPropertiesFile(fileName, m_xml_properties);<a name="line.279"></a>
<FONT color="green">280</FONT> }<a name="line.280"></a>
<FONT color="green">281</FONT> <a name="line.281"></a>
<FONT color="green">282</FONT> defaultProperties = m_html_properties;<a name="line.282"></a>
<FONT color="green">283</FONT> }<a name="line.283"></a>
<FONT color="green">284</FONT> else if (method.equals(Method.TEXT))<a name="line.284"></a>
<FONT color="green">285</FONT> {<a name="line.285"></a>
<FONT color="green">286</FONT> if (null == m_text_properties) // double check<a name="line.286"></a>
<FONT color="green">287</FONT> {<a name="line.287"></a>
<FONT color="green">288</FONT> fileName = PROP_FILE_TEXT;<a name="line.288"></a>
<FONT color="green">289</FONT> m_text_properties =<a name="line.289"></a>
<FONT color="green">290</FONT> loadPropertiesFile(fileName, m_xml_properties);<a name="line.290"></a>
<FONT color="green">291</FONT> if (null<a name="line.291"></a>
<FONT color="green">292</FONT> == m_text_properties.getProperty(OutputKeys.ENCODING))<a name="line.292"></a>
<FONT color="green">293</FONT> {<a name="line.293"></a>
<FONT color="green">294</FONT> String mimeEncoding = Encodings.getMimeEncoding(null);<a name="line.294"></a>
<FONT color="green">295</FONT> m_text_properties.put(<a name="line.295"></a>
<FONT color="green">296</FONT> OutputKeys.ENCODING,<a name="line.296"></a>
<FONT color="green">297</FONT> mimeEncoding);<a name="line.297"></a>
<FONT color="green">298</FONT> }<a name="line.298"></a>
<FONT color="green">299</FONT> }<a name="line.299"></a>
<FONT color="green">300</FONT> <a name="line.300"></a>
<FONT color="green">301</FONT> defaultProperties = m_text_properties;<a name="line.301"></a>
<FONT color="green">302</FONT> }<a name="line.302"></a>
<FONT color="green">303</FONT> else if (method.equals(Method.UNKNOWN))<a name="line.303"></a>
<FONT color="green">304</FONT> {<a name="line.304"></a>
<FONT color="green">305</FONT> if (null == m_unknown_properties) // double check<a name="line.305"></a>
<FONT color="green">306</FONT> {<a name="line.306"></a>
<FONT color="green">307</FONT> fileName = PROP_FILE_UNKNOWN;<a name="line.307"></a>
<FONT color="green">308</FONT> m_unknown_properties =<a name="line.308"></a>
<FONT color="green">309</FONT> loadPropertiesFile(fileName, m_xml_properties);<a name="line.309"></a>
<FONT color="green">310</FONT> }<a name="line.310"></a>
<FONT color="green">311</FONT> <a name="line.311"></a>
<FONT color="green">312</FONT> defaultProperties = m_unknown_properties;<a name="line.312"></a>
<FONT color="green">313</FONT> }<a name="line.313"></a>
<FONT color="green">314</FONT> else<a name="line.314"></a>
<FONT color="green">315</FONT> {<a name="line.315"></a>
<FONT color="green">316</FONT> // TODO: Calculate res file from name.<a name="line.316"></a>
<FONT color="green">317</FONT> defaultProperties = m_xml_properties;<a name="line.317"></a>
<FONT color="green">318</FONT> }<a name="line.318"></a>
<FONT color="green">319</FONT> }<a name="line.319"></a>
<FONT color="green">320</FONT> catch (IOException ioe)<a name="line.320"></a>
<FONT color="green">321</FONT> {<a name="line.321"></a>
<FONT color="green">322</FONT> throw new WrappedRuntimeException(<a name="line.322"></a>
<FONT color="green">323</FONT> Utils.messages.createMessage(<a name="line.323"></a>
<FONT color="green">324</FONT> MsgKey.ER_COULD_NOT_LOAD_METHOD_PROPERTY,<a name="line.324"></a>
<FONT color="green">325</FONT> new Object[] { fileName, method }),<a name="line.325"></a>
<FONT color="green">326</FONT> ioe);<a name="line.326"></a>
<FONT color="green">327</FONT> }<a name="line.327"></a>
<FONT color="green">328</FONT> // wrap these cached defaultProperties in a new Property object just so<a name="line.328"></a>
<FONT color="green">329</FONT> // that the caller of this method can't modify the default values<a name="line.329"></a>
<FONT color="green">330</FONT> return new Properties(defaultProperties);<a name="line.330"></a>
<FONT color="green">331</FONT> }<a name="line.331"></a>
<FONT color="green">332</FONT> <a name="line.332"></a>
<FONT color="green">333</FONT> /**<a name="line.333"></a>
<FONT color="green">334</FONT> * Load the properties file from a resource stream. If a<a name="line.334"></a>
<FONT color="green">335</FONT> * key name such as "org.apache.xslt.xxx", fix up the start of<a name="line.335"></a>
<FONT color="green">336</FONT> * string to be a curly namespace. If a key name starts with<a name="line.336"></a>
<FONT color="green">337</FONT> * "xslt.output.xxx", clip off "xslt.output.". If a key name *or* a<a name="line.337"></a>
<FONT color="green">338</FONT> * key value is discovered, check for \u003a in the text, and<a name="line.338"></a>
<FONT color="green">339</FONT> * fix it up to be ":", since earlier versions of the JDK do not<a name="line.339"></a>
<FONT color="green">340</FONT> * handle the escape sequence (at least in key names).<a name="line.340"></a>
<FONT color="green">341</FONT> *<a name="line.341"></a>
<FONT color="green">342</FONT> * @param resourceName non-null reference to resource name.<a name="line.342"></a>
<FONT color="green">343</FONT> * @param defaults Default properties, which may be null.<a name="line.343"></a>
<FONT color="green">344</FONT> */<a name="line.344"></a>
<FONT color="green">345</FONT> static private Properties loadPropertiesFile(<a name="line.345"></a>
<FONT color="green">346</FONT> final String resourceName,<a name="line.346"></a>
<FONT color="green">347</FONT> Properties defaults)<a name="line.347"></a>
<FONT color="green">348</FONT> throws IOException<a name="line.348"></a>
<FONT color="green">349</FONT> {<a name="line.349"></a>
<FONT color="green">350</FONT> <a name="line.350"></a>
<FONT color="green">351</FONT> // This static method should eventually be moved to a thread-specific class<a name="line.351"></a>
<FONT color="green">352</FONT> // so that we can cache the ContextClassLoader and bottleneck all properties file<a name="line.352"></a>
<FONT color="green">353</FONT> // loading throughout Xalan.<a name="line.353"></a>
<FONT color="green">354</FONT> <a name="line.354"></a>
<FONT color="green">355</FONT> Properties props = new Properties(defaults);<a name="line.355"></a>
<FONT color="green">356</FONT> <a name="line.356"></a>
<FONT color="green">357</FONT> InputStream is = null;<a name="line.357"></a>
<FONT color="green">358</FONT> BufferedInputStream bis = null;<a name="line.358"></a>
<FONT color="green">359</FONT> <a name="line.359"></a>
<FONT color="green">360</FONT> try<a name="line.360"></a>
<FONT color="green">361</FONT> {<a name="line.361"></a>
<FONT color="green">362</FONT> if (ACCESS_CONTROLLER_CLASS != null)<a name="line.362"></a>
<FONT color="green">363</FONT> {<a name="line.363"></a>
<FONT color="green">364</FONT> is = (InputStream) AccessController<a name="line.364"></a>
<FONT color="green">365</FONT> .doPrivileged(new PrivilegedAction() {<a name="line.365"></a>
<FONT color="green">366</FONT> public Object run()<a name="line.366"></a>
<FONT color="green">367</FONT> {<a name="line.367"></a>
<FONT color="green">368</FONT> return OutputPropertiesFactory.class<a name="line.368"></a>
<FONT color="green">369</FONT> .getResourceAsStream(resourceName);<a name="line.369"></a>
<FONT color="green">370</FONT> }<a name="line.370"></a>
<FONT color="green">371</FONT> });<a name="line.371"></a>
<FONT color="green">372</FONT> }<a name="line.372"></a>
<FONT color="green">373</FONT> else<a name="line.373"></a>
<FONT color="green">374</FONT> {<a name="line.374"></a>
<FONT color="green">375</FONT> // User may be using older JDK ( JDK &lt; 1.2 )<a name="line.375"></a>
<FONT color="green">376</FONT> is = OutputPropertiesFactory.class<a name="line.376"></a>
<FONT color="green">377</FONT> .getResourceAsStream(resourceName);<a name="line.377"></a>
<FONT color="green">378</FONT> }<a name="line.378"></a>
<FONT color="green">379</FONT> <a name="line.379"></a>
<FONT color="green">380</FONT> bis = new BufferedInputStream(is);<a name="line.380"></a>
<FONT color="green">381</FONT> props.load(bis);<a name="line.381"></a>
<FONT color="green">382</FONT> }<a name="line.382"></a>
<FONT color="green">383</FONT> catch (IOException ioe)<a name="line.383"></a>
<FONT color="green">384</FONT> {<a name="line.384"></a>
<FONT color="green">385</FONT> if (defaults == null)<a name="line.385"></a>
<FONT color="green">386</FONT> {<a name="line.386"></a>
<FONT color="green">387</FONT> throw ioe;<a name="line.387"></a>
<FONT color="green">388</FONT> }<a name="line.388"></a>
<FONT color="green">389</FONT> else<a name="line.389"></a>
<FONT color="green">390</FONT> {<a name="line.390"></a>
<FONT color="green">391</FONT> throw new WrappedRuntimeException(<a name="line.391"></a>
<FONT color="green">392</FONT> Utils.messages.createMessage(<a name="line.392"></a>
<FONT color="green">393</FONT> MsgKey.ER_COULD_NOT_LOAD_RESOURCE,<a name="line.393"></a>
<FONT color="green">394</FONT> new Object[] { resourceName }),<a name="line.394"></a>
<FONT color="green">395</FONT> ioe);<a name="line.395"></a>
<FONT color="green">396</FONT> //"Could not load '"+resourceName+"' (check CLASSPATH), now using just the defaults ", ioe);<a name="line.396"></a>
<FONT color="green">397</FONT> }<a name="line.397"></a>
<FONT color="green">398</FONT> }<a name="line.398"></a>
<FONT color="green">399</FONT> catch (SecurityException se)<a name="line.399"></a>
<FONT color="green">400</FONT> {<a name="line.400"></a>
<FONT color="green">401</FONT> // Repeat IOException handling for sandbox/applet case -sc<a name="line.401"></a>
<FONT color="green">402</FONT> if (defaults == null)<a name="line.402"></a>
<FONT color="green">403</FONT> {<a name="line.403"></a>
<FONT color="green">404</FONT> throw se;<a name="line.404"></a>
<FONT color="green">405</FONT> }<a name="line.405"></a>
<FONT color="green">406</FONT> else<a name="line.406"></a>
<FONT color="green">407</FONT> {<a name="line.407"></a>
<FONT color="green">408</FONT> throw new WrappedRuntimeException(<a name="line.408"></a>
<FONT color="green">409</FONT> Utils.messages.createMessage(<a name="line.409"></a>
<FONT color="green">410</FONT> MsgKey.ER_COULD_NOT_LOAD_RESOURCE,<a name="line.410"></a>
<FONT color="green">411</FONT> new Object[] { resourceName }),<a name="line.411"></a>
<FONT color="green">412</FONT> se);<a name="line.412"></a>
<FONT color="green">413</FONT> //"Could not load '"+resourceName+"' (check CLASSPATH, applet security), now using just the defaults ", se);<a name="line.413"></a>
<FONT color="green">414</FONT> }<a name="line.414"></a>
<FONT color="green">415</FONT> }<a name="line.415"></a>
<FONT color="green">416</FONT> finally<a name="line.416"></a>
<FONT color="green">417</FONT> {<a name="line.417"></a>
<FONT color="green">418</FONT> if (bis != null)<a name="line.418"></a>
<FONT color="green">419</FONT> {<a name="line.419"></a>
<FONT color="green">420</FONT> bis.close();<a name="line.420"></a>
<FONT color="green">421</FONT> }<a name="line.421"></a>
<FONT color="green">422</FONT> if (is != null)<a name="line.422"></a>
<FONT color="green">423</FONT> {<a name="line.423"></a>
<FONT color="green">424</FONT> is.close();<a name="line.424"></a>
<FONT color="green">425</FONT> }<a name="line.425"></a>
<FONT color="green">426</FONT> }<a name="line.426"></a>
<FONT color="green">427</FONT> <a name="line.427"></a>
<FONT color="green">428</FONT> // Note that we're working at the HashTable level here,<a name="line.428"></a>
<FONT color="green">429</FONT> // and not at the Properties level! This is important<a name="line.429"></a>
<FONT color="green">430</FONT> // because we don't want to modify the default properties.<a name="line.430"></a>
<FONT color="green">431</FONT> // NB: If fixupPropertyString ends up changing the property<a name="line.431"></a>
<FONT color="green">432</FONT> // name or value, we need to remove the old key and re-add<a name="line.432"></a>
<FONT color="green">433</FONT> // with the new key and value. However, then our Enumeration<a name="line.433"></a>
<FONT color="green">434</FONT> // could lose its place in the HashTable. So, we first<a name="line.434"></a>
<FONT color="green">435</FONT> // clone the HashTable and enumerate over that since the<a name="line.435"></a>
<FONT color="green">436</FONT> // clone will not change. When we migrate to Collections,<a name="line.436"></a>
<FONT color="green">437</FONT> // this code should be revisited and cleaned up to use<a name="line.437"></a>
<FONT color="green">438</FONT> // an Iterator which may (or may not) alleviate the need for<a name="line.438"></a>
<FONT color="green">439</FONT> // the clone. Many thanks to Padraig O'hIceadha<a name="line.439"></a>
<FONT color="green">440</FONT> // &lt;padraig@gradient.ie&gt; for finding this problem. Bugzilla 2000.<a name="line.440"></a>
<FONT color="green">441</FONT> <a name="line.441"></a>
<FONT color="green">442</FONT> Enumeration keys = ((Properties) props.clone()).keys();<a name="line.442"></a>
<FONT color="green">443</FONT> while (keys.hasMoreElements())<a name="line.443"></a>
<FONT color="green">444</FONT> {<a name="line.444"></a>
<FONT color="green">445</FONT> String key = (String) keys.nextElement();<a name="line.445"></a>
<FONT color="green">446</FONT> // Now check if the given key was specified as a<a name="line.446"></a>
<FONT color="green">447</FONT> // System property. If so, the system property<a name="line.447"></a>
<FONT color="green">448</FONT> // overides the default value in the propery file.<a name="line.448"></a>
<FONT color="green">449</FONT> String value = null;<a name="line.449"></a>
<FONT color="green">450</FONT> try<a name="line.450"></a>
<FONT color="green">451</FONT> {<a name="line.451"></a>
<FONT color="green">452</FONT> value = System.getProperty(key);<a name="line.452"></a>
<FONT color="green">453</FONT> }<a name="line.453"></a>
<FONT color="green">454</FONT> catch (SecurityException se)<a name="line.454"></a>
<FONT color="green">455</FONT> {<a name="line.455"></a>
<FONT color="green">456</FONT> // No-op for sandbox/applet case, leave null -sc<a name="line.456"></a>
<FONT color="green">457</FONT> }<a name="line.457"></a>
<FONT color="green">458</FONT> if (value == null)<a name="line.458"></a>
<FONT color="green">459</FONT> value = (String) props.get(key);<a name="line.459"></a>
<FONT color="green">460</FONT> <a name="line.460"></a>
<FONT color="green">461</FONT> String newKey = fixupPropertyString(key, true);<a name="line.461"></a>
<FONT color="green">462</FONT> String newValue = null;<a name="line.462"></a>
<FONT color="green">463</FONT> try<a name="line.463"></a>
<FONT color="green">464</FONT> {<a name="line.464"></a>
<FONT color="green">465</FONT> newValue = System.getProperty(newKey);<a name="line.465"></a>
<FONT color="green">466</FONT> }<a name="line.466"></a>
<FONT color="green">467</FONT> catch (SecurityException se)<a name="line.467"></a>
<FONT color="green">468</FONT> {<a name="line.468"></a>
<FONT color="green">469</FONT> // No-op for sandbox/applet case, leave null -sc<a name="line.469"></a>
<FONT color="green">470</FONT> }<a name="line.470"></a>
<FONT color="green">471</FONT> if (newValue == null)<a name="line.471"></a>
<FONT color="green">472</FONT> newValue = fixupPropertyString(value, false);<a name="line.472"></a>
<FONT color="green">473</FONT> else<a name="line.473"></a>
<FONT color="green">474</FONT> newValue = fixupPropertyString(newValue, false);<a name="line.474"></a>
<FONT color="green">475</FONT> <a name="line.475"></a>
<FONT color="green">476</FONT> if (key != newKey || value != newValue)<a name="line.476"></a>
<FONT color="green">477</FONT> {<a name="line.477"></a>
<FONT color="green">478</FONT> props.remove(key);<a name="line.478"></a>
<FONT color="green">479</FONT> props.put(newKey, newValue);<a name="line.479"></a>
<FONT color="green">480</FONT> }<a name="line.480"></a>
<FONT color="green">481</FONT> <a name="line.481"></a>
<FONT color="green">482</FONT> }<a name="line.482"></a>
<FONT color="green">483</FONT> <a name="line.483"></a>
<FONT color="green">484</FONT> return props;<a name="line.484"></a>
<FONT color="green">485</FONT> }<a name="line.485"></a>
<FONT color="green">486</FONT> <a name="line.486"></a>
<FONT color="green">487</FONT> /**<a name="line.487"></a>
<FONT color="green">488</FONT> * Fix up a string in an output properties file according to<a name="line.488"></a>
<FONT color="green">489</FONT> * the rules of {@link #loadPropertiesFile}.<a name="line.489"></a>
<FONT color="green">490</FONT> *<a name="line.490"></a>
<FONT color="green">491</FONT> * @param s non-null reference to string that may need to be fixed up.<a name="line.491"></a>
<FONT color="green">492</FONT> * @return A new string if fixup occured, otherwise the s argument.<a name="line.492"></a>
<FONT color="green">493</FONT> */<a name="line.493"></a>
<FONT color="green">494</FONT> static private String fixupPropertyString(String s, boolean doClipping)<a name="line.494"></a>
<FONT color="green">495</FONT> {<a name="line.495"></a>
<FONT color="green">496</FONT> int index;<a name="line.496"></a>
<FONT color="green">497</FONT> if (doClipping &amp;&amp; s.startsWith(S_XSLT_PREFIX))<a name="line.497"></a>
<FONT color="green">498</FONT> {<a name="line.498"></a>
<FONT color="green">499</FONT> s = s.substring(S_XSLT_PREFIX_LEN);<a name="line.499"></a>
<FONT color="green">500</FONT> }<a name="line.500"></a>
<FONT color="green">501</FONT> if (s.startsWith(S_XALAN_PREFIX))<a name="line.501"></a>
<FONT color="green">502</FONT> {<a name="line.502"></a>
<FONT color="green">503</FONT> s =<a name="line.503"></a>
<FONT color="green">504</FONT> S_BUILTIN_EXTENSIONS_UNIVERSAL<a name="line.504"></a>
<FONT color="green">505</FONT> + s.substring(S_XALAN_PREFIX_LEN);<a name="line.505"></a>
<FONT color="green">506</FONT> }<a name="line.506"></a>
<FONT color="green">507</FONT> if ((index = s.indexOf("\\u003a")) &gt; 0)<a name="line.507"></a>
<FONT color="green">508</FONT> {<a name="line.508"></a>
<FONT color="green">509</FONT> String temp = s.substring(index + 6);<a name="line.509"></a>
<FONT color="green">510</FONT> s = s.substring(0, index) + ":" + temp;<a name="line.510"></a>
<FONT color="green">511</FONT> <a name="line.511"></a>
<FONT color="green">512</FONT> }<a name="line.512"></a>
<FONT color="green">513</FONT> return s;<a name="line.513"></a>
<FONT color="green">514</FONT> }<a name="line.514"></a>
<FONT color="green">515</FONT> <a name="line.515"></a>
<FONT color="green">516</FONT> }<a name="line.516"></a>
</PRE>
</BODY>
</HTML>