Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 45e544e44c4d3486b7ef47b6443139496ac0ea19 / . / bundleplugin / doc / site / wrap-mojo.html
blob: f75df61e2076db4bc442def2d6270cc6dcee8735 [file] [log] [blame]
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
3<!-- Generated by Apache Maven Doxia at Jul 5, 2011 -->
4
5<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
7 <head>
8
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
10
11 <title>Maven Bundle Plugin -
12 bundle:wrap</title>
13
14 <style type="text/css" media="all">
15
16 @import url("./css/maven-base.css");
17
18 @import url("./css/maven-theme.css");
19
20 @import url("./css/site.css");
21
22 </style>
23
24 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
25
26 <meta name="Date-Revision-yyyymmdd" content="20110705" />
27
28 <meta http-equiv="Content-Language" content="en" />
29
30
31
32 </head>
33
34 <body class="composite">
35
36 <div id="banner">
37
38 <div id="bannerLeft">
39
40 Maven Bundle Plugin
41
42 </div>
43
44 <div class="clear">
45
46 <hr/>
47
48 </div>
49
50 </div>
51
52 <div id="breadcrumbs">
53
54
55
56
57
58 <div class="xleft">
59
60 <span id="publishDate">Last Published: 2011-07-05</span>
61
62 &nbsp;| <span id="projectVersion">Version: 2.3.5</span>
63
64 </div>
65
66 <div class="xright">
67
68
69
70 </div>
71
72 <div class="clear">
73
74 <hr/>
75
76 </div>
77
78 </div>
79
80 <div id="leftColumn">
81
82 <div id="navcolumn">
83
84
85
86
87
88 <h5>Overview</h5>
89
90 <ul>
91
92 <li class="none">
93
94 <a href="index.html" title="Introduction">Introduction</a>
95
96 </li>
97
98 <li class="none">
99
100 <a href="plugin-info.html" title="Goals">Goals</a>
101
102 </li>
103
104 <li class="none">
105
106 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Maven+Bundle+Plugin+%28BND%29" class="externalLink" title="Wiki">Wiki</a>
107
108 </li>
109
110 <li class="none">
111
112 <a href="https://cwiki.apache.org/confluence/display/FELIX/Apache+Felix+Bundle+Plugin+FAQ" class="externalLink" title="FAQ">FAQ</a>
113
114 </li>
115
116 <li class="none">
117
118 <a href="jira-report.html" title="Release Notes">Release Notes</a>
119
120 </li>
121
122 </ul>
123
124 <h5>Project Documentation</h5>
125
126 <ul>
127
128 <li class="collapsed">
129
130 <a href="project-info.html" title="Project Information">Project Information</a>
131
132 </li>
133
134 <li class="collapsed">
135
136 <a href="project-reports.html" title="Project Reports">Project Reports</a>
137
138 </li>
139
140 </ul>
141
142 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
143
144 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
145
146 </a>
147
148
149
150
151
152 </div>
153
154 </div>
155
156 <div id="bodyColumn">
157
158 <div id="contentBox">
159
160
161
162 <div class="section"><h2>bundle:wrap<a name="bundle:wrap"></a></h2>
163 <p><b>Full name</b>:</p>
164 <p>org.apache.felix:maven-bundle-plugin:2.3.5:wrap</p>
165 <p><b>This plugin goal has been deprecated</b>:</p>
166 <div>The wrap goal is no longer supported and may be removed in a future
167release</div>
168 <p><b>Description</b>:</p>
169 <div>(no description)</div>
170 <p><b>Attributes</b>:</p>
171 <ul>
172 <li>Requires a Maven project to be executed.</li>
173 <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
174 <li>The goal is thread-safe and supports parallel builds.</li>
175 <li>Binds by default to the lifecycle phase: <tt>package</tt>.</li>
176 </ul>
177 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
178 <table class="bodyTable" border="0">
179 <tr class="a">
180 <th>Name</th>
181 <th>Type</th>
182 <th>Since</th>
183 <th>Description</th>
184 </tr>
185 <tr class="b">
186 <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
187 <td><tt>String</tt></td>
188 <td><tt>-</tt></td>
189 <td>The directory for the generated JAR.<br /></td>
190 </tr>
191 <tr class="a">
192 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
193 <td><tt>File</tt></td>
194 <td><tt>-</tt></td>
195 <td>The directory for the generated bundles.<br /></td>
196 </tr>
197 </table>
198 </div>
199 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
200 <table class="bodyTable" border="0">
201 <tr class="a">
202 <th>Name</th>
203 <th>Type</th>
204 <th>Since</th>
205 <th>Description</th>
206 </tr>
207 <tr class="b">
208 <td><b><a href="#archive">archive</a></b></td>
209 <td><tt>MavenArchiveConfiguration</tt></td>
210 <td><tt>-</tt></td>
211 <td>The archive configuration to use.<br /></td>
212 </tr>
213 <tr class="a">
214 <td><b><a href="#classifier">classifier</a></b></td>
215 <td><tt>String</tt></td>
216 <td><tt>-</tt></td>
217 <td>Classifier type of the bundle to be installed. For example,
218&quot;jdk14&quot;. Defaults to none which means this is the project's main
219bundle.<br /></td>
220 </tr>
221 <tr class="b">
222 <td><b><a href="#depth">depth</a></b></td>
223 <td><tt>int</tt></td>
224 <td><tt>-</tt></td>
225 <td>Process up to some depth<br /></td>
226 </tr>
227 <tr class="a">
228 <td><b><a href="#dumpClasspath">dumpClasspath</a></b></td>
229 <td><tt>File</tt></td>
230 <td><tt>-</tt></td>
231 <td>File where the BND class-path will be dumped<br /></td>
232 </tr>
233 <tr class="b">
234 <td><b><a href="#dumpInstructions">dumpInstructions</a></b></td>
235 <td><tt>File</tt></td>
236 <td><tt>-</tt></td>
237 <td>File where the BND instructions will be dumped<br /></td>
238 </tr>
239 <tr class="a">
240 <td><b><a href="#excludeDependencies">excludeDependencies</a></b></td>
241 <td><tt>String</tt></td>
242 <td><tt>-</tt></td>
243 <td>Comma separated list of artifactIds to exclude from the dependency
244classpath passed to BND (use &quot;true&quot; to exclude everything)<br /></td>
245 </tr>
246 <tr class="b">
247 <td><b><a href="#ignoreMissingArtifacts">ignoreMissingArtifacts</a></b></td>
248 <td><tt>boolean</tt></td>
249 <td><tt>-</tt></td>
250 <td>Ignore missing artifacts that are not required by current project
251but are required by the transitive dependencies.<br /></td>
252 </tr>
253 <tr class="a">
254 <td><b><a href="#instructions">instructions</a></b></td>
255 <td><tt>Map</tt></td>
256 <td><tt>-</tt></td>
257 <td>The BND instructions for the bundle.<br /></td>
258 </tr>
259 <tr class="b">
260 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
261 <td><tt>File</tt></td>
262 <td><tt>-</tt></td>
263 <td>Directory where the manifest will be written<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/META-INF</tt>.</td>
264 </tr>
265 <tr class="a">
266 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
267 <td><tt>List</tt></td>
268 <td><tt>-</tt></td>
269 <td>Project types which this plugin supports.<br /></td>
270 </tr>
271 <tr class="b">
272 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
273 <td><tt>boolean</tt></td>
274 <td><tt>-</tt></td>
275 <td>When true, unpack the bundle contents to the outputDirectory<br /></td>
276 </tr>
277 <tr class="a">
278 <td><b><a href="#wrapImportPackage">wrapImportPackage</a></b></td>
279 <td><tt>String</tt></td>
280 <td><tt>-</tt></td>
281 <td>Import-Package to be used when wrapping dependencies.<br /><b>Default value is</b>: <tt>*</tt>.</td>
282 </tr>
283 </table>
284 </div>
285 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
286 <p><b><a name="archive">archive</a>:</b></p>
287 <div>The archive configuration to use.</div>
288 <ul>
289 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
290 <li><b>Required</b>: <tt>No</tt></li>
291 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
292 <div>The directory for the generated JAR.</div>
293 <ul>
294 <li><b>Type</b>: <tt>java.lang.String</tt></li>
295 <li><b>Required</b>: <tt>Yes</tt></li>
296 <li><b>Expression</b>: <tt>${project.build.directory}</tt></li>
297 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
298 <div>Classifier type of the bundle to be installed. For example,
299&quot;jdk14&quot;. Defaults to none which means this is the project's main
300bundle.</div>
301 <ul>
302 <li><b>Type</b>: <tt>java.lang.String</tt></li>
303 <li><b>Required</b>: <tt>No</tt></li>
304 </ul><hr /><p><b><a name="depth">depth</a>:</b></p>
305 <div>Process up to some depth</div>
306 <ul>
307 <li><b>Type</b>: <tt>int</tt></li>
308 <li><b>Required</b>: <tt>No</tt></li>
309 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
310 <div>File where the BND class-path will be dumped</div>
311 <ul>
312 <li><b>Type</b>: <tt>java.io.File</tt></li>
313 <li><b>Required</b>: <tt>No</tt></li>
314 <li><b>Expression</b>: <tt>${dumpClasspath}</tt></li>
315 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
316 <div>File where the BND instructions will be dumped</div>
317 <ul>
318 <li><b>Type</b>: <tt>java.io.File</tt></li>
319 <li><b>Required</b>: <tt>No</tt></li>
320 <li><b>Expression</b>: <tt>${dumpInstructions}</tt></li>
321 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
322 <div>Comma separated list of artifactIds to exclude from the dependency
323classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
324 <ul>
325 <li><b>Type</b>: <tt>java.lang.String</tt></li>
326 <li><b>Required</b>: <tt>No</tt></li>
327 <li><b>Expression</b>: <tt>${excludeDependencies}</tt></li>
328 </ul><hr /><p><b><a name="ignoreMissingArtifacts">ignoreMissingArtifacts</a>:</b></p>
329 <div>Ignore missing artifacts that are not required by current project
330but are required by the transitive dependencies.</div>
331 <ul>
332 <li><b>Type</b>: <tt>boolean</tt></li>
333 <li><b>Required</b>: <tt>No</tt></li>
334 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
335 <div>The BND instructions for the bundle.</div>
336 <ul>
337 <li><b>Type</b>: <tt>java.util.Map</tt></li>
338 <li><b>Required</b>: <tt>No</tt></li>
339 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
340 <div>Directory where the manifest will be written</div>
341 <ul>
342 <li><b>Type</b>: <tt>java.io.File</tt></li>
343 <li><b>Required</b>: <tt>No</tt></li>
344 <li><b>Expression</b>: <tt>${manifestLocation}</tt></li>
345 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
346 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
347 <div>The directory for the generated bundles.</div>
348 <ul>
349 <li><b>Type</b>: <tt>java.io.File</tt></li>
350 <li><b>Required</b>: <tt>Yes</tt></li>
351 <li><b>Expression</b>: <tt>${project.build.outputDirectory}</tt></li>
352 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
353 <div>Project types which this plugin supports.</div>
354 <ul>
355 <li><b>Type</b>: <tt>java.util.List</tt></li>
356 <li><b>Required</b>: <tt>No</tt></li>
357 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
358 <div>When true, unpack the bundle contents to the outputDirectory</div>
359 <ul>
360 <li><b>Type</b>: <tt>boolean</tt></li>
361 <li><b>Required</b>: <tt>No</tt></li>
362 <li><b>Expression</b>: <tt>${unpackBundle}</tt></li>
363 </ul><hr /><p><b><a name="wrapImportPackage">wrapImportPackage</a>:</b></p>
364 <div>Import-Package to be used when wrapping dependencies.</div>
365 <ul>
366 <li><b>Type</b>: <tt>java.lang.String</tt></li>
367 <li><b>Required</b>: <tt>No</tt></li>
368 <li><b>Expression</b>: <tt>${wrapImportPackage}</tt></li>
369 <li><b>Default</b>: <tt>*</tt></li>
370 </ul>
371 </div>
372 </div>
373
374
375
376 </div>
377
378 </div>
379
380 <div class="clear">
381
382 <hr/>
383
384 </div>
385
386 <div id="footer">
387
388 <div class="xright">Copyright &#169; 2006-2011
389
390 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
391
392 All Rights Reserved.
393
394
395
396 </div>
397
398 <div class="clear">
399
400 <hr/>
401
402 </div>
403
404 </div>
405
406 </body>
407
408</html>
409