Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xpath / jaxp / JAXPExtensionsProvider.html
blob: ce17a096e69ece1e94361d9c1630475dac310d28 [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: JAXPExtensionsProvider.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xpath.jaxp;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.transform.TransformerException;<a name="line.23"></a>
<FONT color="green">024</FONT> import javax.xml.xpath.XPathFunctionResolver;<a name="line.24"></a>
<FONT color="green">025</FONT> import javax.xml.xpath.XPathFunction;<a name="line.25"></a>
<FONT color="green">026</FONT> import javax.xml.xpath.XPathFunctionException;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xpath.ExtensionsProvider;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xpath.XPathContext;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xpath.objects.XObject;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xpath.objects.XNodeSet;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xpath.res.XPATHErrorResources;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.xpath.functions.FuncExtFunction;<a name="line.35"></a>
<FONT color="green">036</FONT> import java.util.Vector;<a name="line.36"></a>
<FONT color="green">037</FONT> import java.util.ArrayList;<a name="line.37"></a>
<FONT color="green">038</FONT> import javax.xml.namespace.QName;<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * <a name="line.41"></a>
<FONT color="green">042</FONT> * @author Ramesh Mandava ( ramesh.mandava@sun.com )<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> public class JAXPExtensionsProvider implements ExtensionsProvider {<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> private final XPathFunctionResolver resolver;<a name="line.46"></a>
<FONT color="green">047</FONT> private boolean extensionInvocationDisabled = false;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> public JAXPExtensionsProvider(XPathFunctionResolver resolver) {<a name="line.49"></a>
<FONT color="green">050</FONT> this.resolver = resolver;<a name="line.50"></a>
<FONT color="green">051</FONT> this.extensionInvocationDisabled = false;<a name="line.51"></a>
<FONT color="green">052</FONT> }<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> public JAXPExtensionsProvider(XPathFunctionResolver resolver, <a name="line.54"></a>
<FONT color="green">055</FONT> boolean featureSecureProcessing ) {<a name="line.55"></a>
<FONT color="green">056</FONT> this.resolver = resolver;<a name="line.56"></a>
<FONT color="green">057</FONT> this.extensionInvocationDisabled = featureSecureProcessing;<a name="line.57"></a>
<FONT color="green">058</FONT> }<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * Is the extension function available?<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> public boolean functionAvailable(String ns, String funcName)<a name="line.64"></a>
<FONT color="green">065</FONT> throws javax.xml.transform.TransformerException {<a name="line.65"></a>
<FONT color="green">066</FONT> try {<a name="line.66"></a>
<FONT color="green">067</FONT> if ( funcName == null ) {<a name="line.67"></a>
<FONT color="green">068</FONT> String fmsg = XSLMessages.createXPATHMessage( <a name="line.68"></a>
<FONT color="green">069</FONT> XPATHErrorResources.ER_ARG_CANNOT_BE_NULL,<a name="line.69"></a>
<FONT color="green">070</FONT> new Object[] {"Function Name"} );<a name="line.70"></a>
<FONT color="green">071</FONT> throw new NullPointerException ( fmsg ); <a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> //Find the XPathFunction corresponding to namespace and funcName<a name="line.73"></a>
<FONT color="green">074</FONT> javax.xml.namespace.QName myQName = new QName( ns, funcName );<a name="line.74"></a>
<FONT color="green">075</FONT> javax.xml.xpath.XPathFunction xpathFunction = <a name="line.75"></a>
<FONT color="green">076</FONT> resolver.resolveFunction ( myQName, 0 );<a name="line.76"></a>
<FONT color="green">077</FONT> if ( xpathFunction == null ) {<a name="line.77"></a>
<FONT color="green">078</FONT> return false;<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> return true;<a name="line.80"></a>
<FONT color="green">081</FONT> } catch ( Exception e ) {<a name="line.81"></a>
<FONT color="green">082</FONT> return false;<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> /**<a name="line.89"></a>
<FONT color="green">090</FONT> * Is the extension element available?<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> public boolean elementAvailable(String ns, String elemName)<a name="line.92"></a>
<FONT color="green">093</FONT> throws javax.xml.transform.TransformerException {<a name="line.93"></a>
<FONT color="green">094</FONT> return false;<a name="line.94"></a>
<FONT color="green">095</FONT> }<a name="line.95"></a>
<FONT color="green">096</FONT> <a name="line.96"></a>
<FONT color="green">097</FONT> /**<a name="line.97"></a>
<FONT color="green">098</FONT> * Execute the extension function.<a name="line.98"></a>
<FONT color="green">099</FONT> */<a name="line.99"></a>
<FONT color="green">100</FONT> public Object extFunction(String ns, String funcName, Vector argVec,<a name="line.100"></a>
<FONT color="green">101</FONT> Object methodKey) throws javax.xml.transform.TransformerException {<a name="line.101"></a>
<FONT color="green">102</FONT> try {<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> if ( funcName == null ) {<a name="line.104"></a>
<FONT color="green">105</FONT> String fmsg = XSLMessages.createXPATHMessage(<a name="line.105"></a>
<FONT color="green">106</FONT> XPATHErrorResources.ER_ARG_CANNOT_BE_NULL,<a name="line.106"></a>
<FONT color="green">107</FONT> new Object[] {"Function Name"} );<a name="line.107"></a>
<FONT color="green">108</FONT> throw new NullPointerException ( fmsg ); <a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> //Find the XPathFunction corresponding to namespace and funcName<a name="line.110"></a>
<FONT color="green">111</FONT> javax.xml.namespace.QName myQName = new QName( ns, funcName );<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> // JAXP 1.3 spec says When XMLConstants.FEATURE_SECURE_PROCESSING <a name="line.113"></a>
<FONT color="green">114</FONT> // feature is set then invocation of extension functions need to<a name="line.114"></a>
<FONT color="green">115</FONT> // throw XPathFunctionException<a name="line.115"></a>
<FONT color="green">116</FONT> if ( extensionInvocationDisabled ) {<a name="line.116"></a>
<FONT color="green">117</FONT> String fmsg = XSLMessages.createXPATHMessage(<a name="line.117"></a>
<FONT color="green">118</FONT> XPATHErrorResources.ER_EXTENSION_FUNCTION_CANNOT_BE_INVOKED,<a name="line.118"></a>
<FONT color="green">119</FONT> new Object[] { myQName.toString() } );<a name="line.119"></a>
<FONT color="green">120</FONT> throw new XPathFunctionException ( fmsg );<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> // Assuming user is passing all the needed parameters ( including<a name="line.123"></a>
<FONT color="green">124</FONT> // default values )<a name="line.124"></a>
<FONT color="green">125</FONT> int arity = argVec.size();<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> javax.xml.xpath.XPathFunction xpathFunction = <a name="line.127"></a>
<FONT color="green">128</FONT> resolver.resolveFunction ( myQName, arity );<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> // not using methodKey<a name="line.130"></a>
<FONT color="green">131</FONT> ArrayList argList = new ArrayList( arity);<a name="line.131"></a>
<FONT color="green">132</FONT> for ( int i=0; i&lt;arity; i++ ) {<a name="line.132"></a>
<FONT color="green">133</FONT> Object argument = argVec.elementAt( i );<a name="line.133"></a>
<FONT color="green">134</FONT> // XNodeSet object() returns NodeVector and not NodeList<a name="line.134"></a>
<FONT color="green">135</FONT> // Explicitly getting NodeList by using nodelist()<a name="line.135"></a>
<FONT color="green">136</FONT> if ( argument instanceof XNodeSet ) {<a name="line.136"></a>
<FONT color="green">137</FONT> argList.add ( i, ((XNodeSet)argument).nodelist() );<a name="line.137"></a>
<FONT color="green">138</FONT> } else if ( argument instanceof XObject ) {<a name="line.138"></a>
<FONT color="green">139</FONT> Object passedArgument = ((XObject)argument).object();<a name="line.139"></a>
<FONT color="green">140</FONT> argList.add ( i, passedArgument );<a name="line.140"></a>
<FONT color="green">141</FONT> } else {<a name="line.141"></a>
<FONT color="green">142</FONT> argList.add ( i, argument );<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> return ( xpathFunction.evaluate ( argList ));<a name="line.146"></a>
<FONT color="green">147</FONT> } catch ( XPathFunctionException xfe ) {<a name="line.147"></a>
<FONT color="green">148</FONT> // If we get XPathFunctionException then we want to terminate<a name="line.148"></a>
<FONT color="green">149</FONT> // further execution by throwing WrappedRuntimeException <a name="line.149"></a>
<FONT color="green">150</FONT> throw new org.apache.xml.utils.WrappedRuntimeException ( xfe );<a name="line.150"></a>
<FONT color="green">151</FONT> } catch ( Exception e ) {<a name="line.151"></a>
<FONT color="green">152</FONT> throw new javax.xml.transform.TransformerException ( e );<a name="line.152"></a>
<FONT color="green">153</FONT> }<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> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * Execute the extension function.<a name="line.158"></a>
<FONT color="green">159</FONT> */<a name="line.159"></a>
<FONT color="green">160</FONT> public Object extFunction(FuncExtFunction extFunction,<a name="line.160"></a>
<FONT color="green">161</FONT> Vector argVec)<a name="line.161"></a>
<FONT color="green">162</FONT> throws javax.xml.transform.TransformerException {<a name="line.162"></a>
<FONT color="green">163</FONT> try {<a name="line.163"></a>
<FONT color="green">164</FONT> String namespace = extFunction.getNamespace();<a name="line.164"></a>
<FONT color="green">165</FONT> String functionName = extFunction.getFunctionName();<a name="line.165"></a>
<FONT color="green">166</FONT> int arity = extFunction.getArgCount();<a name="line.166"></a>
<FONT color="green">167</FONT> javax.xml.namespace.QName myQName = <a name="line.167"></a>
<FONT color="green">168</FONT> new javax.xml.namespace.QName( namespace, functionName );<a name="line.168"></a>
<FONT color="green">169</FONT> <a name="line.169"></a>
<FONT color="green">170</FONT> // JAXP 1.3 spec says When XMLConstants.FEATURE_SECURE_PROCESSING<a name="line.170"></a>
<FONT color="green">171</FONT> // feature is set then invocation of extension functions need to<a name="line.171"></a>
<FONT color="green">172</FONT> // throw XPathFunctionException<a name="line.172"></a>
<FONT color="green">173</FONT> if ( extensionInvocationDisabled ) {<a name="line.173"></a>
<FONT color="green">174</FONT> String fmsg = XSLMessages.createXPATHMessage(<a name="line.174"></a>
<FONT color="green">175</FONT> XPATHErrorResources.ER_EXTENSION_FUNCTION_CANNOT_BE_INVOKED, new Object[] { myQName.toString() } );<a name="line.175"></a>
<FONT color="green">176</FONT> throw new XPathFunctionException ( fmsg );<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> XPathFunction xpathFunction = <a name="line.179"></a>
<FONT color="green">180</FONT> resolver.resolveFunction( myQName, arity );<a name="line.180"></a>
<FONT color="green">181</FONT> <a name="line.181"></a>
<FONT color="green">182</FONT> ArrayList argList = new ArrayList( arity);<a name="line.182"></a>
<FONT color="green">183</FONT> for ( int i=0; i&lt;arity; i++ ) {<a name="line.183"></a>
<FONT color="green">184</FONT> Object argument = argVec.elementAt( i );<a name="line.184"></a>
<FONT color="green">185</FONT> // XNodeSet object() returns NodeVector and not NodeList<a name="line.185"></a>
<FONT color="green">186</FONT> // Explicitly getting NodeList by using nodelist()<a name="line.186"></a>
<FONT color="green">187</FONT> if ( argument instanceof XNodeSet ) {<a name="line.187"></a>
<FONT color="green">188</FONT> argList.add ( i, ((XNodeSet)argument).nodelist() );<a name="line.188"></a>
<FONT color="green">189</FONT> } else if ( argument instanceof XObject ) {<a name="line.189"></a>
<FONT color="green">190</FONT> Object passedArgument = ((XObject)argument).object();<a name="line.190"></a>
<FONT color="green">191</FONT> argList.add ( i, passedArgument );<a name="line.191"></a>
<FONT color="green">192</FONT> } else {<a name="line.192"></a>
<FONT color="green">193</FONT> argList.add ( i, argument );<a name="line.193"></a>
<FONT color="green">194</FONT> }<a name="line.194"></a>
<FONT color="green">195</FONT> }<a name="line.195"></a>
<FONT color="green">196</FONT> <a name="line.196"></a>
<FONT color="green">197</FONT> return ( xpathFunction.evaluate ( argList ));<a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> } catch ( XPathFunctionException xfe ) {<a name="line.199"></a>
<FONT color="green">200</FONT> // If we get XPathFunctionException then we want to terminate <a name="line.200"></a>
<FONT color="green">201</FONT> // further execution by throwing WrappedRuntimeException<a name="line.201"></a>
<FONT color="green">202</FONT> throw new org.apache.xml.utils.WrappedRuntimeException ( xfe );<a name="line.202"></a>
<FONT color="green">203</FONT> } catch ( Exception e ) {<a name="line.203"></a>
<FONT color="green">204</FONT> throw new javax.xml.transform.TransformerException ( e );<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> }<a name="line.206"></a>
<FONT color="green">207</FONT> <a name="line.207"></a>
<FONT color="green">208</FONT> }<a name="line.208"></a>
</PRE>
</BODY>
</HTML>