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