Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xpath / functions / FuncSystemProperty.html
blob: edf80f16c9d108f35275d0c996e41d672bbf87eb [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: FuncSystemProperty.java 1225414 2011-12-29 02:38:30Z mrglavas $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xpath.functions;<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.InputStream;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.Properties;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xpath.XPathContext;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xpath.objects.XObject;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xpath.objects.XString;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xpath.res.XPATHErrorResources;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * Execute the SystemProperty() function.<a name="line.33"></a>
<FONT color="green">034</FONT> * @xsl.usage advanced<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> public class FuncSystemProperty extends FunctionOneArg<a name="line.36"></a>
<FONT color="green">037</FONT> {<a name="line.37"></a>
<FONT color="green">038</FONT> static final long serialVersionUID = 3694874980992204867L;<a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * The path/filename of the property file: XSLTInfo.properties<a name="line.40"></a>
<FONT color="green">041</FONT> * Maintenance note: see also<a name="line.41"></a>
<FONT color="green">042</FONT> * org.apache.xalan.processor.TransformerFactoryImpl.XSLT_PROPERTIES<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> static final String XSLT_PROPERTIES = <a name="line.44"></a>
<FONT color="green">045</FONT> "org/apache/xalan/res/XSLTInfo.properties";<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * Execute the function. The function must return<a name="line.48"></a>
<FONT color="green">049</FONT> * a valid object.<a name="line.49"></a>
<FONT color="green">050</FONT> * @param xctxt The current execution context.<a name="line.50"></a>
<FONT color="green">051</FONT> * @return A valid XObject.<a name="line.51"></a>
<FONT color="green">052</FONT> *<a name="line.52"></a>
<FONT color="green">053</FONT> * @throws javax.xml.transform.TransformerException<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> public XObject execute(XPathContext xctxt) throws javax.xml.transform.TransformerException<a name="line.55"></a>
<FONT color="green">056</FONT> {<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> String fullName = m_arg0.execute(xctxt).str();<a name="line.58"></a>
<FONT color="green">059</FONT> int indexOfNSSep = fullName.indexOf(':');<a name="line.59"></a>
<FONT color="green">060</FONT> String result;<a name="line.60"></a>
<FONT color="green">061</FONT> String propName = "";<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> // List of properties where the name of the<a name="line.63"></a>
<FONT color="green">064</FONT> // property argument is to be looked for.<a name="line.64"></a>
<FONT color="green">065</FONT> Properties xsltInfo = new Properties();<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> loadPropertyFile(XSLT_PROPERTIES, xsltInfo);<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> if (indexOfNSSep &gt; 0)<a name="line.69"></a>
<FONT color="green">070</FONT> {<a name="line.70"></a>
<FONT color="green">071</FONT> String prefix = (indexOfNSSep &gt;= 0)<a name="line.71"></a>
<FONT color="green">072</FONT> ? fullName.substring(0, indexOfNSSep) : "";<a name="line.72"></a>
<FONT color="green">073</FONT> String namespace;<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> namespace = xctxt.getNamespaceContext().getNamespaceForPrefix(prefix);<a name="line.75"></a>
<FONT color="green">076</FONT> propName = (indexOfNSSep &lt; 0)<a name="line.76"></a>
<FONT color="green">077</FONT> ? fullName : fullName.substring(indexOfNSSep + 1);<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> if (namespace.startsWith("http://www.w3.org/XSL/Transform")<a name="line.79"></a>
<FONT color="green">080</FONT> || namespace.equals("http://www.w3.org/1999/XSL/Transform"))<a name="line.80"></a>
<FONT color="green">081</FONT> {<a name="line.81"></a>
<FONT color="green">082</FONT> result = xsltInfo.getProperty(propName);<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> if (null == result)<a name="line.84"></a>
<FONT color="green">085</FONT> {<a name="line.85"></a>
<FONT color="green">086</FONT> warn(xctxt, XPATHErrorResources.WG_PROPERTY_NOT_SUPPORTED,<a name="line.86"></a>
<FONT color="green">087</FONT> new Object[]{ fullName }); //"XSL Property not supported: "+fullName);<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> return XString.EMPTYSTRING;<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> else<a name="line.92"></a>
<FONT color="green">093</FONT> {<a name="line.93"></a>
<FONT color="green">094</FONT> warn(xctxt, XPATHErrorResources.WG_DONT_DO_ANYTHING_WITH_NS,<a name="line.94"></a>
<FONT color="green">095</FONT> new Object[]{ namespace,<a name="line.95"></a>
<FONT color="green">096</FONT> fullName }); //"Don't currently do anything with namespace "+namespace+" in property: "+fullName);<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> try<a name="line.98"></a>
<FONT color="green">099</FONT> {<a name="line.99"></a>
<FONT color="green">100</FONT> result = System.getProperty(propName);<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> if (null == result)<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> // result = System.getenv(propName);<a name="line.105"></a>
<FONT color="green">106</FONT> return XString.EMPTYSTRING;<a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> catch (SecurityException se)<a name="line.109"></a>
<FONT color="green">110</FONT> {<a name="line.110"></a>
<FONT color="green">111</FONT> warn(xctxt, XPATHErrorResources.WG_SECURITY_EXCEPTION,<a name="line.111"></a>
<FONT color="green">112</FONT> new Object[]{ fullName }); //"SecurityException when trying to access XSL system property: "+fullName);<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> return XString.EMPTYSTRING;<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> }<a name="line.117"></a>
<FONT color="green">118</FONT> else<a name="line.118"></a>
<FONT color="green">119</FONT> {<a name="line.119"></a>
<FONT color="green">120</FONT> try<a name="line.120"></a>
<FONT color="green">121</FONT> {<a name="line.121"></a>
<FONT color="green">122</FONT> result = System.getProperty(fullName);<a name="line.122"></a>
<FONT color="green">123</FONT> <a name="line.123"></a>
<FONT color="green">124</FONT> if (null == result)<a name="line.124"></a>
<FONT color="green">125</FONT> {<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> // result = System.getenv(fullName);<a name="line.127"></a>
<FONT color="green">128</FONT> return XString.EMPTYSTRING;<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> catch (SecurityException se)<a name="line.131"></a>
<FONT color="green">132</FONT> {<a name="line.132"></a>
<FONT color="green">133</FONT> warn(xctxt, XPATHErrorResources.WG_SECURITY_EXCEPTION,<a name="line.133"></a>
<FONT color="green">134</FONT> new Object[]{ fullName }); //"SecurityException when trying to access XSL system property: "+fullName);<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> return XString.EMPTYSTRING;<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> <a name="line.139"></a>
<FONT color="green">140</FONT> if (propName.equals("version") &amp;&amp; result.length() &gt; 0)<a name="line.140"></a>
<FONT color="green">141</FONT> {<a name="line.141"></a>
<FONT color="green">142</FONT> try<a name="line.142"></a>
<FONT color="green">143</FONT> {<a name="line.143"></a>
<FONT color="green">144</FONT> // Needs to return the version number of the spec we conform to.<a name="line.144"></a>
<FONT color="green">145</FONT> return new XString("1.0");<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> catch (Exception ex)<a name="line.147"></a>
<FONT color="green">148</FONT> {<a name="line.148"></a>
<FONT color="green">149</FONT> return new XString(result);<a name="line.149"></a>
<FONT color="green">150</FONT> }<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> else<a name="line.152"></a>
<FONT color="green">153</FONT> return new XString(result);<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> /**<a name="line.156"></a>
<FONT color="green">157</FONT> * Retrieve a propery bundle from a specified file<a name="line.157"></a>
<FONT color="green">158</FONT> * <a name="line.158"></a>
<FONT color="green">159</FONT> * @param file The string name of the property file. The name <a name="line.159"></a>
<FONT color="green">160</FONT> * should already be fully qualified as path/filename<a name="line.160"></a>
<FONT color="green">161</FONT> * @param target The target property bag the file will be placed into.<a name="line.161"></a>
<FONT color="green">162</FONT> */<a name="line.162"></a>
<FONT color="green">163</FONT> public void loadPropertyFile(String file, Properties target)<a name="line.163"></a>
<FONT color="green">164</FONT> {<a name="line.164"></a>
<FONT color="green">165</FONT> try<a name="line.165"></a>
<FONT color="green">166</FONT> {<a name="line.166"></a>
<FONT color="green">167</FONT> // Use SecuritySupport class to provide privileged access to property file<a name="line.167"></a>
<FONT color="green">168</FONT> InputStream is = SecuritySupport.getResourceAsStream(ObjectFactory.findClassLoader(),<a name="line.168"></a>
<FONT color="green">169</FONT> file);<a name="line.169"></a>
<FONT color="green">170</FONT> <a name="line.170"></a>
<FONT color="green">171</FONT> // get a buffered version<a name="line.171"></a>
<FONT color="green">172</FONT> BufferedInputStream bis = new BufferedInputStream(is);<a name="line.172"></a>
<FONT color="green">173</FONT> <a name="line.173"></a>
<FONT color="green">174</FONT> target.load(bis); // and load up the property bag from this<a name="line.174"></a>
<FONT color="green">175</FONT> bis.close(); // close out after reading<a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
<FONT color="green">177</FONT> catch (Exception ex)<a name="line.177"></a>
<FONT color="green">178</FONT> {<a name="line.178"></a>
<FONT color="green">179</FONT> // ex.printStackTrace();<a name="line.179"></a>
<FONT color="green">180</FONT> throw new org.apache.xml.utils.WrappedRuntimeException(ex);<a name="line.180"></a>
<FONT color="green">181</FONT> }<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
</PRE>
</BODY>
</HTML>