Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 55213335ed6aaecedbf71557e877643fa590b6c3 / . / bundleplugin / doc / site / bundle-mojo.html
blob: 4dbbac1b481c2f7de7d635cab204e11165604d84 [file] [log] [blame]
Stuart McCulloch55213332011-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:bundle</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:bundle<a name="bundle:bundle"></a></h2>
163 <p><b>Full name</b>:</p>
164 <p>org.apache.felix:maven-bundle-plugin:2.3.5:bundle</p>
165 <p><b>Description</b>:</p>
166 <div>Create an OSGi bundle from Maven project</div>
167 <p><b>Attributes</b>:</p>
168 <ul>
169 <li>Requires a Maven project to be executed.</li>
170 <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
171 <li>The goal is thread-safe and supports parallel builds.</li>
172 <li>Binds by default to the lifecycle phase: <tt>package</tt>.</li>
173 </ul>
174 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
175 <table class="bodyTable" border="0">
176 <tr class="a">
177 <th>Name</th>
178 <th>Type</th>
179 <th>Since</th>
180 <th>Description</th>
181 </tr>
182 <tr class="b">
183 <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
184 <td><tt>String</tt></td>
185 <td><tt>-</tt></td>
186 <td>The directory for the generated JAR.<br /></td>
187 </tr>
188 <tr class="a">
189 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
190 <td><tt>File</tt></td>
191 <td><tt>-</tt></td>
192 <td>The directory for the generated bundles.<br /></td>
193 </tr>
194 </table>
195 </div>
196 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
197 <table class="bodyTable" border="0">
198 <tr class="a">
199 <th>Name</th>
200 <th>Type</th>
201 <th>Since</th>
202 <th>Description</th>
203 </tr>
204 <tr class="b">
205 <td><b><a href="#archive">archive</a></b></td>
206 <td><tt>MavenArchiveConfiguration</tt></td>
207 <td><tt>-</tt></td>
208 <td>The archive configuration to use.<br /></td>
209 </tr>
210 <tr class="a">
211 <td><b><a href="#classifier">classifier</a></b></td>
212 <td><tt>String</tt></td>
213 <td><tt>-</tt></td>
214 <td>Classifier type of the bundle to be installed. For example,
215&quot;jdk14&quot;. Defaults to none which means this is the project's main
216bundle.<br /></td>
217 </tr>
218 <tr class="b">
219 <td><b><a href="#dumpClasspath">dumpClasspath</a></b></td>
220 <td><tt>File</tt></td>
221 <td><tt>-</tt></td>
222 <td>File where the BND class-path will be dumped<br /></td>
223 </tr>
224 <tr class="a">
225 <td><b><a href="#dumpInstructions">dumpInstructions</a></b></td>
226 <td><tt>File</tt></td>
227 <td><tt>-</tt></td>
228 <td>File where the BND instructions will be dumped<br /></td>
229 </tr>
230 <tr class="b">
231 <td><b><a href="#excludeDependencies">excludeDependencies</a></b></td>
232 <td><tt>String</tt></td>
233 <td><tt>-</tt></td>
234 <td>Comma separated list of artifactIds to exclude from the dependency
235classpath passed to BND (use &quot;true&quot; to exclude everything)<br /></td>
236 </tr>
237 <tr class="a">
238 <td><b><a href="#instructions">instructions</a></b></td>
239 <td><tt>Map</tt></td>
240 <td><tt>-</tt></td>
241 <td>The BND instructions for the bundle.<br /></td>
242 </tr>
243 <tr class="b">
244 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
245 <td><tt>File</tt></td>
246 <td><tt>-</tt></td>
247 <td>Directory where the manifest will be written<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/META-INF</tt>.</td>
248 </tr>
249 <tr class="a">
250 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
251 <td><tt>List</tt></td>
252 <td><tt>-</tt></td>
253 <td>Project types which this plugin supports.<br /></td>
254 </tr>
255 <tr class="b">
256 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
257 <td><tt>boolean</tt></td>
258 <td><tt>-</tt></td>
259 <td>When true, unpack the bundle contents to the outputDirectory<br /></td>
260 </tr>
261 </table>
262 </div>
263 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
264 <p><b><a name="archive">archive</a>:</b></p>
265 <div>The archive configuration to use.</div>
266 <ul>
267 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
268 <li><b>Required</b>: <tt>No</tt></li>
269 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
270 <div>The directory for the generated JAR.</div>
271 <ul>
272 <li><b>Type</b>: <tt>java.lang.String</tt></li>
273 <li><b>Required</b>: <tt>Yes</tt></li>
274 <li><b>Expression</b>: <tt>${project.build.directory}</tt></li>
275 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
276 <div>Classifier type of the bundle to be installed. For example,
277&quot;jdk14&quot;. Defaults to none which means this is the project's main
278bundle.</div>
279 <ul>
280 <li><b>Type</b>: <tt>java.lang.String</tt></li>
281 <li><b>Required</b>: <tt>No</tt></li>
282 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
283 <div>File where the BND class-path will be dumped</div>
284 <ul>
285 <li><b>Type</b>: <tt>java.io.File</tt></li>
286 <li><b>Required</b>: <tt>No</tt></li>
287 <li><b>Expression</b>: <tt>${dumpClasspath}</tt></li>
288 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
289 <div>File where the BND instructions will be dumped</div>
290 <ul>
291 <li><b>Type</b>: <tt>java.io.File</tt></li>
292 <li><b>Required</b>: <tt>No</tt></li>
293 <li><b>Expression</b>: <tt>${dumpInstructions}</tt></li>
294 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
295 <div>Comma separated list of artifactIds to exclude from the dependency
296classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
297 <ul>
298 <li><b>Type</b>: <tt>java.lang.String</tt></li>
299 <li><b>Required</b>: <tt>No</tt></li>
300 <li><b>Expression</b>: <tt>${excludeDependencies}</tt></li>
301 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
302 <div>The BND instructions for the bundle.</div>
303 <ul>
304 <li><b>Type</b>: <tt>java.util.Map</tt></li>
305 <li><b>Required</b>: <tt>No</tt></li>
306 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
307 <div>Directory where the manifest will be written</div>
308 <ul>
309 <li><b>Type</b>: <tt>java.io.File</tt></li>
310 <li><b>Required</b>: <tt>No</tt></li>
311 <li><b>Expression</b>: <tt>${manifestLocation}</tt></li>
312 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
313 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
314 <div>The directory for the generated bundles.</div>
315 <ul>
316 <li><b>Type</b>: <tt>java.io.File</tt></li>
317 <li><b>Required</b>: <tt>Yes</tt></li>
318 <li><b>Expression</b>: <tt>${project.build.outputDirectory}</tt></li>
319 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
320 <div>Project types which this plugin supports.</div>
321 <ul>
322 <li><b>Type</b>: <tt>java.util.List</tt></li>
323 <li><b>Required</b>: <tt>No</tt></li>
324 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
325 <div>When true, unpack the bundle contents to the outputDirectory</div>
326 <ul>
327 <li><b>Type</b>: <tt>boolean</tt></li>
328 <li><b>Required</b>: <tt>No</tt></li>
329 <li><b>Expression</b>: <tt>${unpackBundle}</tt></li>
330 </ul>
331 </div>
332 </div>
333
334
335
336 </div>
337
338 </div>
339
340 <div class="clear">
341
342 <hr/>
343
344 </div>
345
346 <div id="footer">
347
348 <div class="xright">Copyright &#169; 2006-2011
349
350 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
351
352 All Rights Reserved.
353
354
355
356 </div>
357
358 <div class="clear">
359
360 <hr/>
361
362 </div>
363
364 </div>
365
366 </body>
367
368</html>
369