Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.11.2 / src-html / org / apache / felix / ipojo / task / IPojoc.html
blob: 9bf4af2283ec6e728fd0d02872033d0b3f2142ea [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.task;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import static java.lang.String.format;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.commons.cli.*;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.manipulator.Pojoization;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.felix.ipojo.manipulator.util.Constants;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.File;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * A command line tools to manipulate iPOJO bundles.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * It can be used as follow:<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;code&gt;java -jar this-jar.jar --input the-jar-to-manipulate&lt;/code&gt;&lt;br/&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;code&gt;java -jar this-jar.jar --input the-jar-to-manipulate --output the-output-jar&lt;/code&gt;&lt;br/&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;code&gt;java -jar this-jar.jar --input the-jar-to-manipulate --metadata the-xml-metadata&lt;/code&gt;&lt;br/&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class IPojoc {<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Input file to be manipulated.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> private File m_input;<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> * Output file (temporary or not).<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private File m_output;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Metadata file (may be null).<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> private File m_metadata;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Manipulator.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> private Pojoization m_pojoization;<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> * The main entry point<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param args the arguments<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public static void main(String[] args) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> Options options = buildOptions();<a name="line.65"></a>
<span class="sourceLineNo">066</span> CommandLine cmd = null;<a name="line.66"></a>
<span class="sourceLineNo">067</span> try {<a name="line.67"></a>
<span class="sourceLineNo">068</span> cmd = buildCommandLine(args, options);<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (cmd.hasOption('h')) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> printHelp(options);<a name="line.70"></a>
<span class="sourceLineNo">071</span> } else {<a name="line.71"></a>
<span class="sourceLineNo">072</span> IPojoc compiler = new IPojoc();<a name="line.72"></a>
<span class="sourceLineNo">073</span> compiler.execute(cmd);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> } catch (MissingOptionException e) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> for (String opt : (List&lt;String&gt;) e.getMissingOptions()) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> System.err.println("The '" + opt + "' option is missing");<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> printHelp(options);<a name="line.79"></a>
<span class="sourceLineNo">080</span> } catch (MissingArgumentException e) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> System.err.println("The option '" + e.getOption() + "' requires an argument");<a name="line.81"></a>
<span class="sourceLineNo">082</span> printHelp(options);<a name="line.82"></a>
<span class="sourceLineNo">083</span> } catch (Exception e) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> System.out.printf("Manipulation failed: %s%n", e.getMessage());<a name="line.84"></a>
<span class="sourceLineNo">085</span> if ((cmd != null) &amp;&amp; cmd.hasOption('X')) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> e.printStackTrace(System.out);<a name="line.86"></a>
<span class="sourceLineNo">087</span> } else {<a name="line.87"></a>
<span class="sourceLineNo">088</span> System.out.printf("Use -X option to print the full stack trace%n");<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<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> private static CommandLine buildCommandLine(final String[] args, final Options options) throws ParseException {<a name="line.93"></a>
<span class="sourceLineNo">094</span> CommandLineParser parser = new GnuParser();<a name="line.94"></a>
<span class="sourceLineNo">095</span> return parser.parse(options, args);<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> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * The command line is valid, to processing the command line.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param cmd the command line<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @throws ParseException<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> private void execute(CommandLine cmd) throws Exception {<a name="line.103"></a>
<span class="sourceLineNo">104</span> System.out.printf("iPOJO Manipulation (%s)%n", Constants.getVersion());<a name="line.104"></a>
<span class="sourceLineNo">105</span> System.out.println("-----------------------------------------------");<a name="line.105"></a>
<span class="sourceLineNo">106</span> readInputOption(cmd);<a name="line.106"></a>
<span class="sourceLineNo">107</span> readOutputOption(cmd);<a name="line.107"></a>
<span class="sourceLineNo">108</span> readMetadataOption(cmd);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> manipulate();<a name="line.110"></a>
<span class="sourceLineNo">111</span> printStatus();<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>
<span class="sourceLineNo">114</span> private void readMetadataOption(final CommandLine cmd) throws Exception {<a name="line.114"></a>
<span class="sourceLineNo">115</span> // Retrieve the metadata file<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (cmd.hasOption("m")) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> m_metadata = (File) cmd.getParsedOptionValue("m");<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (m_metadata != null &amp;&amp; !m_metadata.isFile()) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> throw new Exception(<a name="line.119"></a>
<span class="sourceLineNo">120</span> format("The metadata option must be an existing file, '%s' does not exist", cmd.getOptionValue('m'))<a name="line.120"></a>
<span class="sourceLineNo">121</span> );<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> System.out.println("metadata file =&gt; " + m_metadata.getAbsolutePath());<a name="line.123"></a>
<span class="sourceLineNo">124</span> } else {<a name="line.124"></a>
<span class="sourceLineNo">125</span> System.out.println("metadata file =&gt; no metadata file");<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> private void readOutputOption(final CommandLine cmd) throws Exception {<a name="line.129"></a>
<span class="sourceLineNo">130</span> // Retrieve output file<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (cmd.hasOption("o")) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> try {<a name="line.132"></a>
<span class="sourceLineNo">133</span> m_output = (File) cmd.getParsedOptionValue("o");<a name="line.133"></a>
<span class="sourceLineNo">134</span> } catch (ParseException pe) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> throw new Exception(<a name="line.135"></a>
<span class="sourceLineNo">136</span> format("The output option must be an existing file, '%s' does not exist", cmd.getOptionValue('o'))<a name="line.136"></a>
<span class="sourceLineNo">137</span> );<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> System.out.println("output file =&gt; " + m_output.getAbsolutePath());<a name="line.139"></a>
<span class="sourceLineNo">140</span> } else {<a name="line.140"></a>
<span class="sourceLineNo">141</span> // Inline replacement<a name="line.141"></a>
<span class="sourceLineNo">142</span> // We create a temporary file marked by a __ prefix<a name="line.142"></a>
<span class="sourceLineNo">143</span> // It will be substituted upon success.<a name="line.143"></a>
<span class="sourceLineNo">144</span> m_output = new File("__" + m_input.getName());<a name="line.144"></a>
<span class="sourceLineNo">145</span> System.out.println("output file =&gt; " + m_input.getAbsolutePath());<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><a name="line.148"></a>
<span class="sourceLineNo">149</span> private void readInputOption(final CommandLine cmd) throws Exception {<a name="line.149"></a>
<span class="sourceLineNo">150</span> // Check that the input file exist<a name="line.150"></a>
<span class="sourceLineNo">151</span> m_input = (File) cmd.getParsedOptionValue("i");<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (m_input == null || !m_input.isFile()) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> throw new Exception(<a name="line.153"></a>
<span class="sourceLineNo">154</span> format("The input option must be an existing file, '%s' does not exist", cmd.getOptionValue('i'))<a name="line.154"></a>
<span class="sourceLineNo">155</span> );<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> System.out.println("input file =&gt; " + m_input.getAbsolutePath());<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>
<span class="sourceLineNo">160</span> private void manipulate() {<a name="line.160"></a>
<span class="sourceLineNo">161</span> m_pojoization = new Pojoization();<a name="line.161"></a>
<span class="sourceLineNo">162</span> m_pojoization.pojoization(m_input, m_output, m_metadata);<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> private void printStatus() {<a name="line.165"></a>
<span class="sourceLineNo">166</span> if (m_pojoization.getErrors().size() != 0) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> System.err.println("iPOJO Manipulation failed :");<a name="line.167"></a>
<span class="sourceLineNo">168</span> for (String error : m_pojoization.getErrors()) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> System.err.println("\t" + error);<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span> System.exit(-1);<a name="line.171"></a>
<span class="sourceLineNo">172</span> } else {<a name="line.172"></a>
<span class="sourceLineNo">173</span> System.err.println("iPOJO Manipulation successfully completed.");<a name="line.173"></a>
<span class="sourceLineNo">174</span> for (String warning : m_pojoization.getWarnings()) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> System.err.println(warning);<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> cleanup();<a name="line.177"></a>
<span class="sourceLineNo">178</span> System.exit(0);<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
<span class="sourceLineNo">183</span> * Upon success, cleanup temporary files.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> private void cleanup() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (m_output.getName().startsWith("__")) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> m_input.delete();<a name="line.187"></a>
<span class="sourceLineNo">188</span> m_output.renameTo(m_input);<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Print help.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param options<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> private static void printHelp(final Options options) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> HelpFormatter formatter = new HelpFormatter();<a name="line.197"></a>
<span class="sourceLineNo">198</span> formatter.printHelp("java -jar org.apache.felix.ipojo.ant-" + Constants.getVersion() + ".jar", options);<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
<span class="sourceLineNo">202</span> * Builds the option list<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @return the options<a name="line.203"></a>
<span class="sourceLineNo">204</span> */<a name="line.204"></a>
<span class="sourceLineNo">205</span> public static Options buildOptions() {<a name="line.205"></a>
<span class="sourceLineNo">206</span> Option input =<a name="line.206"></a>
<span class="sourceLineNo">207</span> OptionBuilder.withArgName("input file")<a name="line.207"></a>
<span class="sourceLineNo">208</span> .withLongOpt("input")<a name="line.208"></a>
<span class="sourceLineNo">209</span> .hasArg()<a name="line.209"></a>
<span class="sourceLineNo">210</span> .withDescription("the input jar file")<a name="line.210"></a>
<span class="sourceLineNo">211</span> .isRequired(true)<a name="line.211"></a>
<span class="sourceLineNo">212</span> .withType(File.class)<a name="line.212"></a>
<span class="sourceLineNo">213</span> .create('i');<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> Option output =<a name="line.215"></a>
<span class="sourceLineNo">216</span> OptionBuilder<a name="line.216"></a>
<span class="sourceLineNo">217</span> .withLongOpt("output")<a name="line.217"></a>
<span class="sourceLineNo">218</span> .withArgName("output file")<a name="line.218"></a>
<span class="sourceLineNo">219</span> .hasArg()<a name="line.219"></a>
<span class="sourceLineNo">220</span> .withDescription("the output jar file, if not set the manipulation replaces the input file")<a name="line.220"></a>
<span class="sourceLineNo">221</span> .isRequired(false)<a name="line.221"></a>
<span class="sourceLineNo">222</span> .withType(File.class)<a name="line.222"></a>
<span class="sourceLineNo">223</span> .create('o');<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> Option metadata =<a name="line.225"></a>
<span class="sourceLineNo">226</span> OptionBuilder<a name="line.226"></a>
<span class="sourceLineNo">227</span> .withLongOpt("metadata")<a name="line.227"></a>
<span class="sourceLineNo">228</span> .withArgName("metadata file")<a name="line.228"></a>
<span class="sourceLineNo">229</span> .hasArg()<a name="line.229"></a>
<span class="sourceLineNo">230</span> .withDescription("the XML metadata file")<a name="line.230"></a>
<span class="sourceLineNo">231</span> .isRequired(false)<a name="line.231"></a>
<span class="sourceLineNo">232</span> .withType(File.class)<a name="line.232"></a>
<span class="sourceLineNo">233</span> .create('m');<a name="line.233"></a>
<span class="sourceLineNo">234</span><a name="line.234"></a>
<span class="sourceLineNo">235</span> Option verbose = new Option("X", "exception", false, "print exception stack trace in case of error");<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span> Option help =<a name="line.237"></a>
<span class="sourceLineNo">238</span> OptionBuilder.withLongOpt("help").withDescription("print this message").create('h');<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> return new Options()<a name="line.240"></a>
<span class="sourceLineNo">241</span> .addOption(input)<a name="line.241"></a>
<span class="sourceLineNo">242</span> .addOption(output)<a name="line.242"></a>
<span class="sourceLineNo">243</span> .addOption(metadata)<a name="line.243"></a>
<span class="sourceLineNo">244</span> .addOption(verbose)<a name="line.244"></a>
<span class="sourceLineNo">245</span> .addOption(help);<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span>}<a name="line.247"></a>
</pre>
</div>
</body>
</html>