blob: 5e6180742faac956c9d0cd3236a5c54a83165c22 [file] [log] [blame]
Stuart McCullochd16db972011-07-05 11:48:22 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +00002<!-- Generated by Apache Maven Doxia at Jun 20, 2014 -->
Stuart McCullochd16db972011-07-05 11:48:22 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Stuart McCullochd16db972011-07-05 11:48:22 +00004 <head>
Stuart McCullochd16db972011-07-05 11:48:22 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Stuart McCullochd16db972011-07-05 11:48:22 +00006 <title>Maven Bundle Plugin -
7 bundle:ant</title>
Stuart McCullochd16db972011-07-05 11:48:22 +00008 <style type="text/css" media="all">
Stuart McCullochd16db972011-07-05 11:48:22 +00009 @import url("./css/maven-base.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000010 @import url("./css/maven-theme.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000011 @import url("./css/site.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000012 </style>
Stuart McCullochd16db972011-07-05 11:48:22 +000013 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000014 <meta name="Date-Revision-yyyymmdd" content="20140620" />
Stuart McCullochd16db972011-07-05 11:48:22 +000015 <meta http-equiv="Content-Language" content="en" />
Stuart McCullochd16db972011-07-05 11:48:22 +000016
Stuart McCullochd16db972011-07-05 11:48:22 +000017 </head>
Stuart McCullochd16db972011-07-05 11:48:22 +000018 <body class="composite">
Stuart McCullochd16db972011-07-05 11:48:22 +000019 <div id="banner">
Stuart McCullochd16db972011-07-05 11:48:22 +000020 <div id="bannerLeft">
Stuart McCullochd16db972011-07-05 11:48:22 +000021 Maven Bundle Plugin
Stuart McCullochd16db972011-07-05 11:48:22 +000022 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000023 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000024 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000025 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000026 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000027 <div id="breadcrumbs">
Stuart McCullochd16db972011-07-05 11:48:22 +000028
Stuart McCullochd16db972011-07-05 11:48:22 +000029
Stuart McCullochd16db972011-07-05 11:48:22 +000030 <div class="xleft">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000031 <span id="publishDate">Last Published: 2014-06-20</span>
32 &nbsp;| <span id="projectVersion">Version: 2.5.0</span>
Stuart McCullochd16db972011-07-05 11:48:22 +000033 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000034 <div class="xright">
Stuart McCullochd16db972011-07-05 11:48:22 +000035
Stuart McCullochd16db972011-07-05 11:48:22 +000036 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000037 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000038 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000039 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000040 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000041 <div id="leftColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000042 <div id="navcolumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000043
Stuart McCullochd16db972011-07-05 11:48:22 +000044
Stuart McCullochd16db972011-07-05 11:48:22 +000045 <h5>Overview</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000046 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000047 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000048 <a href="index.html" title="Introduction">Introduction</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000049 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000050 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000051 <a href="plugin-info.html" title="Goals">Goals</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000052 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000053 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000054 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000055 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000056 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000057 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000058 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000059 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000060 <a href="jira-report.html" title="Release Notes">Release Notes</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000061 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000062 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000063 <h5>Project Documentation</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000064 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000065 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000066 <a href="project-info.html" title="Project Information">Project Information</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000067 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000068 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000069 <a href="project-reports.html" title="Project Reports">Project Reports</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000070 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000071 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000072 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
Stuart McCullochd16db972011-07-05 11:48:22 +000073 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
Stuart McCullochd16db972011-07-05 11:48:22 +000074 </a>
Stuart McCullochd16db972011-07-05 11:48:22 +000075
Stuart McCullochd16db972011-07-05 11:48:22 +000076
Stuart McCullochd16db972011-07-05 11:48:22 +000077 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000078 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000079 <div id="bodyColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000080 <div id="contentBox">
Stuart McCullochd16db972011-07-05 11:48:22 +000081
82
83 <div class="section"><h2>bundle:ant<a name="bundle:ant"></a></h2>
84 <p><b>Full name</b>:</p>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000085 <p>org.apache.felix:maven-bundle-plugin:2.5.0:ant</p>
Stuart McCullochd16db972011-07-05 11:48:22 +000086 <p><b>Description</b>:</p>
87 <div>Generate Ant script to create the bundle (you should run ant:ant
88first).</div>
89 <p><b>Attributes</b>:</p>
90 <ul>
91 <li>Requires a Maven project to be executed.</li>
92 <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
93 <li>The goal is thread-safe and supports parallel builds.</li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +000094 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>package</tt>.</li>
Stuart McCullochd16db972011-07-05 11:48:22 +000095 </ul>
96 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
97 <table class="bodyTable" border="0">
98 <tr class="a">
99 <th>Name</th>
100 <th>Type</th>
101 <th>Since</th>
102 <th>Description</th>
103 </tr>
104 <tr class="b">
105 <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
106 <td><tt>String</tt></td>
107 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000108 <td>The directory for the generated JAR.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000109 </tr>
110 <tr class="a">
111 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
112 <td><tt>File</tt></td>
113 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000114 <td>The directory for the generated bundles.<br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000115 </tr>
116 </table>
117 </div>
118 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
119 <table class="bodyTable" border="0">
120 <tr class="a">
121 <th>Name</th>
122 <th>Type</th>
123 <th>Since</th>
124 <th>Description</th>
125 </tr>
126 <tr class="b">
127 <td><b><a href="#archive">archive</a></b></td>
128 <td><tt>MavenArchiveConfiguration</tt></td>
129 <td><tt>-</tt></td>
130 <td>The archive configuration to use.<br /></td>
131 </tr>
132 <tr class="a">
133 <td><b><a href="#classifier">classifier</a></b></td>
134 <td><tt>String</tt></td>
135 <td><tt>-</tt></td>
136 <td>Classifier type of the bundle to be installed. For example,
137&quot;jdk14&quot;. Defaults to none which means this is the project's main
138bundle.<br /></td>
139 </tr>
140 <tr class="b">
141 <td><b><a href="#dumpClasspath">dumpClasspath</a></b></td>
142 <td><tt>File</tt></td>
143 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000144 <td>File where the BND class-path will be dumped<br /><b>User property is</b>: <tt>dumpClasspath</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000145 </tr>
146 <tr class="a">
147 <td><b><a href="#dumpInstructions">dumpInstructions</a></b></td>
148 <td><tt>File</tt></td>
149 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000150 <td>File where the BND instructions will be dumped<br /><b>User property is</b>: <tt>dumpInstructions</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000151 </tr>
152 <tr class="b">
153 <td><b><a href="#excludeDependencies">excludeDependencies</a></b></td>
154 <td><tt>String</tt></td>
155 <td><tt>-</tt></td>
156 <td>Comma separated list of artifactIds to exclude from the dependency
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000157classpath passed to BND (use &quot;true&quot; to exclude everything)<br /><b>User property is</b>: <tt>excludeDependencies</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000158 </tr>
159 <tr class="a">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000160 <td><b><a href="#finalName">finalName</a></b></td>
161 <td><tt>String</tt></td>
162 <td><tt>-</tt></td>
163 <td>Final name of the bundle (without classifier or extension)<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td>
164 </tr>
165 <tr class="b">
Stuart McCullochd16db972011-07-05 11:48:22 +0000166 <td><b><a href="#instructions">instructions</a></b></td>
167 <td><tt>Map</tt></td>
168 <td><tt>-</tt></td>
169 <td>The BND instructions for the bundle.<br /></td>
170 </tr>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000171 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000172 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
173 <td><tt>File</tt></td>
174 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000175 <td>Directory where the manifest will be written<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/META-INF</tt>.<br /><b>User property is</b>: <tt>manifestLocation</tt>.</td>
176 </tr>
177 <tr class="b">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000178 <td><b><a href="#niceManifest">niceManifest</a></b></td>
179 <td><tt>boolean</tt></td>
180 <td><tt>-</tt></td>
Stuart McCullocha5689862014-06-20 11:41:00 +0000181 <td>Output a nicely formatted manifest that still respects the 72
182character line limit.<br /></td>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000183 </tr>
184 <tr class="a">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000185 <td><b><a href="#packaging">packaging</a></b></td>
186 <td><tt>String</tt></td>
187 <td><tt>-</tt></td>
188 <td>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
189Defaults to none which means use the same packaging as the project.<br /></td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000190 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000191 <tr class="b">
Stuart McCullochd16db972011-07-05 11:48:22 +0000192 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
193 <td><tt>List</tt></td>
194 <td><tt>-</tt></td>
195 <td>Project types which this plugin supports.<br /></td>
196 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000197 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000198 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
199 <td><tt>boolean</tt></td>
200 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000201 <td>When true, unpack the bundle contents to the outputDirectory<br /><b>User property is</b>: <tt>unpackBundle</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000202 </tr>
203 </table>
204 </div>
205 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
206 <p><b><a name="archive">archive</a>:</b></p>
207 <div>The archive configuration to use.</div>
208 <ul>
209 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
210 <li><b>Required</b>: <tt>No</tt></li>
211 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
212 <div>The directory for the generated JAR.</div>
213 <ul>
214 <li><b>Type</b>: <tt>java.lang.String</tt></li>
215 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000216 <li><b>User Property</b>: <tt>project.build.directory</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000217 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
218 <div>Classifier type of the bundle to be installed. For example,
219&quot;jdk14&quot;. Defaults to none which means this is the project's main
220bundle.</div>
221 <ul>
222 <li><b>Type</b>: <tt>java.lang.String</tt></li>
223 <li><b>Required</b>: <tt>No</tt></li>
224 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
225 <div>File where the BND class-path will be dumped</div>
226 <ul>
227 <li><b>Type</b>: <tt>java.io.File</tt></li>
228 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000229 <li><b>User Property</b>: <tt>dumpClasspath</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000230 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
231 <div>File where the BND instructions will be dumped</div>
232 <ul>
233 <li><b>Type</b>: <tt>java.io.File</tt></li>
234 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000235 <li><b>User Property</b>: <tt>dumpInstructions</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000236 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
237 <div>Comma separated list of artifactIds to exclude from the dependency
238classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
239 <ul>
240 <li><b>Type</b>: <tt>java.lang.String</tt></li>
241 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000242 <li><b>User Property</b>: <tt>excludeDependencies</tt></li>
243 </ul><hr /><p><b><a name="finalName">finalName</a>:</b></p>
244 <div>Final name of the bundle (without classifier or extension)</div>
245 <ul>
246 <li><b>Type</b>: <tt>java.lang.String</tt></li>
247 <li><b>Required</b>: <tt>No</tt></li>
248 <li><b>User Property</b>: <tt>project.build.finalName</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000249 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
250 <div>The BND instructions for the bundle.</div>
251 <ul>
252 <li><b>Type</b>: <tt>java.util.Map</tt></li>
253 <li><b>Required</b>: <tt>No</tt></li>
254 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
255 <div>Directory where the manifest will be written</div>
256 <ul>
257 <li><b>Type</b>: <tt>java.io.File</tt></li>
258 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000259 <li><b>User Property</b>: <tt>manifestLocation</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000260 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000261 </ul><hr /><p><b><a name="niceManifest">niceManifest</a>:</b></p>
Stuart McCullocha5689862014-06-20 11:41:00 +0000262 <div>Output a nicely formatted manifest that still respects the 72
263character line limit.</div>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000264 <ul>
265 <li><b>Type</b>: <tt>boolean</tt></li>
266 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000267 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
268 <div>The directory for the generated bundles.</div>
269 <ul>
270 <li><b>Type</b>: <tt>java.io.File</tt></li>
271 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000272 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
273 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
274 <div>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
275Defaults to none which means use the same packaging as the project.</div>
276 <ul>
277 <li><b>Type</b>: <tt>java.lang.String</tt></li>
278 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000279 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
280 <div>Project types which this plugin supports.</div>
281 <ul>
282 <li><b>Type</b>: <tt>java.util.List</tt></li>
283 <li><b>Required</b>: <tt>No</tt></li>
284 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
285 <div>When true, unpack the bundle contents to the outputDirectory</div>
286 <ul>
287 <li><b>Type</b>: <tt>boolean</tt></li>
288 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000289 <li><b>User Property</b>: <tt>unpackBundle</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000290 </ul>
291 </div>
292 </div>
293
294
Stuart McCullochd16db972011-07-05 11:48:22 +0000295 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000296 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000297 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000298 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000299 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000300 <div id="footer">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000301 <div class="xright">Copyright &#169; 2006-2014
Stuart McCullochd16db972011-07-05 11:48:22 +0000302 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000303 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000304
Stuart McCullochd16db972011-07-05 11:48:22 +0000305 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000306 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000307 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000308 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000309 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000310 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000311</html>