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