blob: 173e24721221401867330927115d6d0211049cad [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;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.InputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Arrays;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.manipulator.MetadataProvider;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.manipulator.Reporter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.manipulator.util.Streams;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.felix.ipojo.xml.parser.ParseException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.felix.ipojo.xml.parser.SchemaResolver;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.felix.ipojo.xml.parser.XMLMetadataParser;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.xml.sax.InputSource;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.xml.sax.SAXException;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.xml.sax.SAXParseException;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.xml.sax.XMLReader;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.xml.sax.helpers.XMLReaderFactory;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * A {@code StreamManifestProvider} knows how to load metadata from an InputStream.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class StreamMetadataProvider implements MetadataProvider {<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private InputStream m_stream;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private Reporter m_reporter;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private boolean m_validateUsingLocalSchemas = false;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> public StreamMetadataProvider(InputStream stream, Reporter reporter) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> m_stream = stream;<a name="line.55"></a>
<span class="sourceLineNo">056</span> m_reporter = reporter;<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Force XML schemas resolution to be performed locally<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public void setValidateUsingLocalSchemas(boolean validateUsingLocalSchemas) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> m_validateUsingLocalSchemas = validateUsingLocalSchemas;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> public List&lt;Element&gt; getMetadatas() throws IOException {<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> // First time we've been called: parse the XML Stream<a name="line.68"></a>
<span class="sourceLineNo">069</span> List&lt;Element&gt; metadata = new ArrayList&lt;Element&gt;();<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> try {<a name="line.71"></a>
<span class="sourceLineNo">072</span> XMLMetadataParser handler = new XMLMetadataParser();<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> XMLReader parser = XMLReaderFactory.createXMLReader();<a name="line.74"></a>
<span class="sourceLineNo">075</span> parser.setContentHandler(handler);<a name="line.75"></a>
<span class="sourceLineNo">076</span> parser.setFeature("http://xml.org/sax/features/validation", true);<a name="line.76"></a>
<span class="sourceLineNo">077</span> parser.setFeature("http://apache.org/xml/features/validation/schema", true);<a name="line.77"></a>
<span class="sourceLineNo">078</span> parser.setErrorHandler(handler);<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (m_validateUsingLocalSchemas) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> parser.setEntityResolver(new SchemaResolver());<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> // Parse the XML<a name="line.83"></a>
<span class="sourceLineNo">084</span> InputSource is = new InputSource(m_stream);<a name="line.84"></a>
<span class="sourceLineNo">085</span> parser.parse(is);<a name="line.85"></a>
<span class="sourceLineNo">086</span> Element[] meta = handler.getMetadata();<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> // Add parsed metadata<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (meta != null) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> metadata.addAll(Arrays.asList(meta));<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> // Output a warning message if no metadata was found<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (meta == null || meta.length == 0) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> m_reporter.warn("Neither component types, nor instances in the XML metadata");<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> } catch (IOException e) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> m_reporter.error("Cannot open the metadata input stream: " + e.getMessage());<a name="line.99"></a>
<span class="sourceLineNo">100</span> } catch (ParseException e) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> m_reporter.error("Parsing error when parsing the XML file: " + e.getMessage());<a name="line.101"></a>
<span class="sourceLineNo">102</span> } catch (SAXParseException e) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> m_reporter.error("Error during metadata parsing at line " + e.getLineNumber() + " : " + e.getMessage());<a name="line.103"></a>
<span class="sourceLineNo">104</span> } catch (SAXException e) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> m_reporter.error("Parsing error when parsing (Sax Error) the XML file: " + e.getMessage());<a name="line.105"></a>
<span class="sourceLineNo">106</span> } finally {<a name="line.106"></a>
<span class="sourceLineNo">107</span> Streams.close(m_stream);<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> return metadata;<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span>}<a name="line.113"></a>
</pre>
</div>
</body>
</html>