Blame - ipojo/ant/doc/ipojo-ant-task.html - onos-felix

blob: 0798f4adc786b1a1146f168e722dc6d304fae9ff [file] [log] [blame]

Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	2	<html><head>
				3
				4
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	5
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	6	<title>Apache Felix - iPOJO Ant Task</title>
				7	<link rel="stylesheet" href="ipojo-ant-task_files/site.css" type="text/css" media="all">
				8	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
				9	</head><body>
				10	<div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="ipojo-ant-task_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="ipojo-ant-task_files/apache.png" border="0"></a></div></div>
				11	<div class="menu">
				12	<ul>
				13	<li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li>
				14	<li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li>
				15	<li><span class="nobr"><a href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
				16	<li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li>
				17	<li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li>
				18	<li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li>
				19	<li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
				20	<li><span class="nobr"><a href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
				21	<li><span class="nobr"><a href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	22	<!-- ApacheCon Ad -->
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	23	<iframe src="ipojo-ant-task_files/button.html" style="border-width: 0pt; float: left;" scrolling="no" width="135" frameborder="0" height="135"></iframe>
				24	<p style="height: 100px;">
				25	<!-- ApacheCon Ad -->
				26	</p></li></ul> </div>
				27	<div class="main">
				28	<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
				29	<td class="confluenceTd" valign="top" width="80%">
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	30
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	31	<h1><a name="iPOJOAntTask-iPOJOAntTask"></a>iPOJO Ant Task</h1>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	32
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	33	<p>iPOJO Ant Task allows automating the iPOJO manipulation process.
				34	This page explains how to use the iPOJO Ant Task and how to combine
				35	them with the BND Tasks.</p>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	36
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	37	<h2><a name="iPOJOAntTask-DownloadingtheiPOJOAntTask"></a>Downloading the iPOJO Ant Task</h2>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	38
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	39	<p>The iPOJO Ant Task can ben downloaded from <a href="http://felix.apache.org/site/download.html" title="Download">here</a>.</p>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	40
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	41	<h2><a name="iPOJOAntTask-HowtousetheAntTask"></a>How to use the Ant Task</h2>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	42
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	43	<p>The iPOJO Ant task take an input bundle and a metadata file and create the final (i.e. manipulated) bundle.<br>
				44	To use the task declare a target in your build.xml as:</p>
				45	<div class="panel"><div class="panelContent">
				46	<p><target name="main"><br>
				47	<font color="red"><!-- Change the path to point on the iPOJO Ant task jar--></font><br>
				48	<taskdef name="ipojo"<br>
				49	classname="org.apache.felix.ipojo.task.IPojoTask"<br>
				50	<font color="red">classpath="org.apache.felix.ipojo.ant-1.0.0.jar"</font>/></p>
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	51
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	52	<p>    <ipojo<br>
				53	input="foo.jar"<br>
				54	metadata = "meta.xml"<br>
				55	/><br>
				56	</target></p>
				57	</div></div>
				58	<p>First, define the new task. Then simply use it. The input argument
				59	describe the input bundle (must exists) and the metadata argument
				60	describes the metadata file (must exist too). The input bundle must be
				61	a well-formed bundle.</p>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	62
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	63	<h2><a name="iPOJOAntTask-AntTaskArguments"></a>Ant Task Arguments</h2>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	64
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	65	<p>The iPOJO Ant Task as three different arguments:</p>
				66	<ul>
				67	<li>Input: describes the input bundle. This argument is mandatory.</li>
				68	<li>Output: describes the output bundle. This argument is optional. If not present, the output file will be input file.</li>
				69	<li>Metadata:
				70	describes the metadata file. This argument is optional. By default, it
				71	tries with a metadata.xml file (in the same directory as the build.xml
				72	file). If the default file is not present, it tries to use only iPOJO
				73	annotations.</li>
				74	<li>IgnoreAnnotations: if set to <tt>true</tt>, the manipulator skips annotations processing.</li>
				75	<li>IgnoreEmbeddedSchemas: if set to <tt>true</tt>, the manipulator doesn't use embedded XML-Schemas [1.1.0-SNAPSHOT]</li>
				76	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	77
				78
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	79	<h2><a name="iPOJOAntTask-CombiningtheiPOJOAntTaskandBND"></a>Combining the iPOJO Ant Task and BND</h2>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	80
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	81	<p>The iPOJO Ant Task requires an input bundle. BND is a tools
				82	simplifying bundle creation. So, it is possible to combine the two
				83	tools to create your bundle automatically. The following build.xml
				84	shows you an example of combination.</p>
				85	<div class="panel"><div class="panelContent">
				86	<p><project default="main" basedir="."><br>
				87	<target name="bnd"><br>
				88	<font color="red"><!-- Change to use the latest BND version –</font><font color="red">></font><br>
				89	<taskdef resource="aQute/bnd/ant/taskdef.properties"<br>
				90	<font color="red">classpath="bnd-0.0.178.jar"</font>/><br>
				91	<bnd<br>
				92	classpath="src"<br>
				93	eclipse="true"<br>
				94	failok="false"<br>
				95	exceptions="true"<br>
				96	<font color="red">files="foo.bnd"</font>/><br>
				97	</target></p>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	98
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	99	<p>    <target name="main" depends="bnd"><br>
				100	<echo message="Call main"/><br>
				101	<font color="red"><!-- Change the path to point on the iPOJO Ant task jar --></font><br>
				102	<taskdef name="ipojo"<br>
				103	classname="org.apache.felix.ipojo.task.PojoTask"<br>
				104	<font color="red">classpath="org.apache.felix.ipojo.ant-1.0.0.jar"</font> /><br>
				105	<ipojo<br>
				106	<font color="red">input="foo.jar"</font><br>
				107	metadata = "meta.xml"<br>
				108	/><br>
				109	</target><br>
				110	</project></p>
				111	</div></div>
				112	<p>The first target creates the bundle with BND. More details on the
				113	BND Ant Task are available here. To combine the BND output and the
				114	iPOJO input, the iPOJO input need to be the same as the BND file but
				115	with the ".jar" extension. For instance, the BND file is foo.bnd, so
				116	the input jar must be foo.jar.<br>
				117	To be sure that the BND bundle is already created, you can add the "<em>depends</em>" clause in the target using the iPOJO task to the target creating the bundle.</p>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	118
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	119	<p>However, it is possible to create only one target doing the two operations as:</p>
				120	<div class="panel"><div class="panelContent">
				121	<p><target name="main"><br>
				122	<font color="red"><!-- Change to use the latest BND version --></font><br>
				123	<taskdef<br>
				124	resource="aQute/bnd/ant/taskdef.properties"<br>
				125	<font color="red">classpath="bnd-0.0.178.jar"/></font></p>
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	126
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	127	<p>      <font color="red"><!-- Change the path to point on the iPOJO Ant task jar --></font><br>
				128	<taskdef name="ipojo"<br>
				129	classname="org.apache.felix.ipojo.task.IPojoTask"<br>
				130	<font color="red">classpath="org.apache.felix.ipojo.ant-1.0.0.jar"</font>/></p>
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	131
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	132	<p>    <bnd<br>
				133	classpath="src"<br>
				134	eclipse="true"<br>
				135	failok="false"<br>
				136	exceptions="true"<br>
				137	files="<font color="red">foo.bnd</font>"/></p>
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	138
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	139	<p>    <ipojo<br>
				140	input="<font color="red">foo.jar</font>"<br>
				141	metadata = "meta.xml"/><br>
				142	</target></p>
				143	</div></div>
Clement Escoffier	8350751	2008-10-13 07:33:03 +0000	[diff] [blame]	144
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	145	<h2><a name="iPOJOAntTask-Conclusion"></a>Conclusion</h2>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	146
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	147	<p>Subscribe to the Felix users mailing list by sending a message to <span class="nobr"><a href="mailto:users-subscribe@felix.apache.org" title="Send mail to users-subscribe@felix.apache.org" rel="nofollow">users-subscribe@felix.apache.org<sup><img class="rendericon" src="ipojo-ant-task_files/mail_small.gif" alt="" align="absmiddle" border="0" width="13" height="12"></sup></a></span>; after subscribing, email questions or feedback to <span class="nobr"><a href="mailto:users@felix.apache.org" title="Send mail to users@felix.apache.org" rel="nofollow">users@felix.apache.org<sup><img class="rendericon" src="ipojo-ant-task_files/mail_small.gif" alt="" align="absmiddle" border="0" width="13" height="12"></sup></a></span></p></td>
				148	<td class="confluenceTd" valign="top" width="20%">
				149	<h6><a name="iPOJOAntTask-Overview"></a><b>Overview</b></h6>
				150	<ul>
				151	<li><a href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</a></li>
				152	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</a></li>
				153	<li><a href="http://felix.apache.org/site/download.html" title="Download">Download & Install </a></li>
				154	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	155
				156
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	157	<h6><a name="iPOJOAntTask-GettingStarted"></a><b>Getting Started</b></h6>
				158	<ul>
				159	<li><a href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</a></li>
				160	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</a></li>
				161	<li><a href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</a></li>
				162	<li><a href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</a></li>
				163	<li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li>
				164	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	165
				166
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	167	<h6><a name="iPOJOAntTask-UserGuide"></a><b>User Guide</b></h6>
				168	<ul>
				169	<li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li>
				170	<li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li>
				171	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li>
				172	<li><a href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</a></li>
				173	<li><a href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</a></li>
				174	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	175
				176
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	177	<h6><a name="iPOJOAntTask-Tools"></a><b>Tools</b></h6>
				178	<ul>
				179	<li><a href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</a></li>
				180	<li><a href="" title="iPOJO Ant Task">iPOJO Ant Task</a></li>
				181	<li><a href="http://felix.apache.org/site/ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li>
				182	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li>
				183	<li><a href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</a></li>
				184	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	185
				186
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	187	<h6><a name="iPOJOAntTask-DeveloperGuide"></a><b>Developer Guide</b></h6>
				188	<ul>
				189	<li>API: <span class="nobr"><a href="http://people.apache.org/%7Eclement/ipojo/api/1.0/" title="Visit page outside Confluence" rel="nofollow">1.0<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
				190	<li><a href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</a></li>
				191	<li><a href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</a></li>
				192	<li><a href="http://felix.apache.org/site/dive-into-the-ipojo-manipulation-depths.html" title="Dive into the iPOJO Manipulation depths">Dive into the iPOJO Manipulation depths</a></li>
				193	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	194
				195
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	196	<h6><a name="iPOJOAntTask-Misc&Contact"></a><b>Misc & Contact</b></h6>
				197	<ul>
				198	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</a></li>
				199	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li>
				200	<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li>
				201	<li><span class="nobr"><a href="http://ipojo-dark-side.blogspot.com/" title="Visit page outside Confluence" rel="nofollow">iPOJO's Dark Side Blog<sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>
				202	<li><a href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</a></li>
				203	<li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li>
				204	<li><a href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</a></li>
				205	<li><a href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</a></li>
				206	</ul>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	207
				208
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	209	<hr>
				210	<div class="" align="center">
				211	<p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&statuses=created&statuses=modified&spaces=FELIX&labelString=iPOJO&rssType=atom&maxResults=10&timeSpan=5&publicFeed=true&title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="ipojo-ant-task_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="ipojo-ant-task_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></div>
Clement Escoffier	6b928e9	2008-05-16 20:33:54 +0000	[diff] [blame]	212
Clement Escoffier	8251f60	2009-01-15 15:35:17 +0000	[diff] [blame]	213	<script type="text/javascript">
				214	var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
				215	document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
				216	</script><script src="ipojo-ant-task_files/ga.js" type="text/javascript"></script>
				217	<script type="text/javascript">
				218	var pageTracker = _gat._getTracker("UA-1518442-4");
				219	pageTracker._trackPageview();
				220	</script>
				221	</td></tr></tbody></table>
				222	</div>
				223	</body></html>