Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.11.0 / src-html / org / apache / felix / ipojo / manipulator / metadata / annotation / visitor / HandlerDeclarationVisitor.html
blob: e48bf84e603f8d0fcec41036d8c1731aa2483703 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.felix.ipojo.manipulator.metadata.annotation.visitor;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.manipulator.Reporter;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.ComponentWorkbench;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.objectweb.asm.AnnotationVisitor;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.objectweb.asm.commons.EmptyVisitor;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.w3c.dom.Attr;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.w3c.dom.Document;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.w3c.dom.NamedNodeMap;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.w3c.dom.NodeList;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>import javax.xml.parsers.DocumentBuilder;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.io.ByteArrayInputStream;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.io.IOException;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.io.InputStream;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Parse the @HandlerDeclaration annotation.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @see org.apache.felix.ipojo.annotations.HandlerDeclaration<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class HandlerDeclarationVisitor extends EmptyVisitor implements AnnotationVisitor {<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * XML accepted by the handler.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private String m_value;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private DocumentBuilder builder;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private ComponentWorkbench workbench;<a name="line.52"></a>
<span class="sourceLineNo">053</span> private Reporter reporter;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> public HandlerDeclarationVisitor(ComponentWorkbench workbench, DocumentBuilder builder, Reporter reporter) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> this.workbench = workbench;<a name="line.56"></a>
<span class="sourceLineNo">057</span> this.builder = builder;<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.reporter = reporter;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Parses the value attribute.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param name 'value'<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param value the value<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @see org.objectweb.asm.commons.EmptyVisitor#visit(java.lang.String, java.lang.Object)<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public void visit(String name, Object value) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> // there is only a 'value' attribute<a name="line.68"></a>
<span class="sourceLineNo">069</span> this.m_value = (String) value;<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * End of the visit.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Builds the XML document.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @see org.objectweb.asm.commons.EmptyVisitor#visitEnd()<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public void visitEnd() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> // The value is an XML document<a name="line.78"></a>
<span class="sourceLineNo">079</span> InputStream is = new ByteArrayInputStream(m_value.getBytes());<a name="line.79"></a>
<span class="sourceLineNo">080</span> Document document = null;<a name="line.80"></a>
<span class="sourceLineNo">081</span> try {<a name="line.81"></a>
<span class="sourceLineNo">082</span> document = builder.parse(is);<a name="line.82"></a>
<span class="sourceLineNo">083</span> Element e = convertDOMElements(document.getDocumentElement());<a name="line.83"></a>
<span class="sourceLineNo">084</span> workbench.getElements().put(e, null);<a name="line.84"></a>
<span class="sourceLineNo">085</span> } catch (Exception e) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> reporter.warn("Cannot convert {} to iPOJO Elements.", m_value, e);<a name="line.86"></a>
<span class="sourceLineNo">087</span> } finally {<a name="line.87"></a>
<span class="sourceLineNo">088</span> try {<a name="line.88"></a>
<span class="sourceLineNo">089</span> is.close();<a name="line.89"></a>
<span class="sourceLineNo">090</span> } catch (IOException e) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> reporter.trace("Cannot close correctly the value input stream ({}).", m_value, e);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Converts recursively the given XML Element into an iPOJO Element.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param xmlElement DOM Element to be converted<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> private static Element convertDOMElements(final org.w3c.dom.Element xmlElement) {<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> // Create an equivalent iPOJO element<a name="line.102"></a>
<span class="sourceLineNo">103</span> Element converted = transformElement(xmlElement);<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> convertDOMElements(converted, xmlElement);<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> return converted;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
<span class="sourceLineNo">111</span> * Converts recursively the given XML Element into an iPOJO Element.<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param root iPOJO root Element<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param xmlElement DOM Element to be converted<a name="line.113"></a>
<span class="sourceLineNo">114</span> */<a name="line.114"></a>
<span class="sourceLineNo">115</span> private static void convertDOMElements(final Element root,<a name="line.115"></a>
<span class="sourceLineNo">116</span> final org.w3c.dom.Element xmlElement) {<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> // Convert attributes if any<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (xmlElement.hasAttributes()) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> NamedNodeMap attributes = xmlElement.getAttributes();<a name="line.120"></a>
<span class="sourceLineNo">121</span> for (int i = 0; i &lt; attributes.getLength(); i++) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> Attr attr = (Attr) attributes.item(i);<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (!"xmlns".equals(attr.getPrefix())) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> root.addAttribute(transformAttribute(attr));<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> // Convert child elements if any<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (xmlElement.hasChildNodes()) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> NodeList children = xmlElement.getChildNodes();<a name="line.131"></a>
<span class="sourceLineNo">132</span> for (int i = 0; i &lt; children.getLength(); i++) {<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> // Create an equivalent iPOJO element<a name="line.134"></a>
<span class="sourceLineNo">135</span> org.w3c.dom.Element child = (org.w3c.dom.Element) children.item(i);<a name="line.135"></a>
<span class="sourceLineNo">136</span> Element converted = transformElement(child);<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> // Add converted element as a root's child<a name="line.138"></a>
<span class="sourceLineNo">139</span> root.addElement(converted);<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> // Recursive call<a name="line.141"></a>
<span class="sourceLineNo">142</span> convertDOMElements(converted, child);<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> private static Attribute transformAttribute(Attr attr) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return new Attribute(attr.getLocalName(),<a name="line.149"></a>
<span class="sourceLineNo">150</span> attr.getNamespaceURI(),<a name="line.150"></a>
<span class="sourceLineNo">151</span> attr.getValue());<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> private static Element transformElement(org.w3c.dom.Element xmlElement) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return new Element(xmlElement.getLocalName(), xmlElement.getNamespaceURI());<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span>}<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
</pre>
</div>
</body>
</html>