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"> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 2 | <!-- Generated by Apache Maven Doxia at Jun 8, 2013 --> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 4 | <head> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 6 | <title>Maven Bundle Plugin - |
| 7 | bundle:wrap</title> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 8 | <style type="text/css" media="all"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 9 | @import url("./css/maven-base.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 10 | @import url("./css/maven-theme.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 11 | @import url("./css/site.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 12 | </style> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 13 | <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 14 | <meta name="Date-Revision-yyyymmdd" content="20130608" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 15 | <meta http-equiv="Content-Language" content="en" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 16 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 17 | </head> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 18 | <body class="composite"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 19 | <div id="banner"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 20 | <div id="bannerLeft"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 21 | Maven Bundle Plugin |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 22 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 23 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 24 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 25 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 26 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 27 | <div id="breadcrumbs"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 28 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 29 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 30 | <div class="xleft"> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 31 | <span id="publishDate">Last Published: 2013-06-08</span> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 32 | | <span id="projectVersion">Version: 2.4.0-SNAPSHOT</span> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 33 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 34 | <div class="xright"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 35 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 36 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 37 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 38 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 39 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 40 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 41 | <div id="leftColumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 42 | <div id="navcolumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 43 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 44 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 45 | <h5>Overview</h5> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 46 | <ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 47 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 48 | <a href="index.html" title="Introduction">Introduction</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 49 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 50 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 51 | <a href="plugin-info.html" title="Goals">Goals</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 52 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 53 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 55 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 56 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 58 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 59 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 60 | <a href="jira-report.html" title="Release Notes">Release Notes</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 61 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 62 | </ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 63 | <h5>Project Documentation</h5> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 64 | <ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 65 | <li class="collapsed"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 66 | <a href="project-info.html" title="Project Information">Project Information</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 67 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 68 | <li class="collapsed"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 69 | <a href="project-reports.html" title="Project Reports">Project Reports</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 70 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 71 | </ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 72 | <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 73 | <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 74 | </a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 75 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 76 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 77 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 78 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 79 | <div id="bodyColumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 80 | <div id="contentBox"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 85 | <p>org.apache.felix:maven-bundle-plugin:2.4.0-SNAPSHOT:wrap</p> |
Stuart McCulloch | d16db97 | 2011-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 |
| 88 | release</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> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 96 | <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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 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> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 110 | <td>The directory for the generated JAR.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 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> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 116 | <td>The directory for the generated bundles.<br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 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 | "jdk14". Defaults to none which means this is the project's main |
| 140 | bundle.<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> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 152 | <td>File where the BND class-path will be dumped<br /><b>User property is</b>: <tt>dumpClasspath</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 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> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 158 | <td>File where the BND instructions will be dumped<br /><b>User property is</b>: <tt>dumpInstructions</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 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 |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 165 | classpath passed to BND (use "true" to exclude everything)<br /><b>User property is</b>: <tt>excludeDependencies</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 166 | </tr> |
| 167 | <tr class="b"> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 168 | <td><b><a href="#finalName">finalName</a></b></td> |
| 169 | <td><tt>String</tt></td> |
| 170 | <td><tt>-</tt></td> |
| 171 | <td>Final name of the bundle (without classifier or extension)<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td> |
| 172 | </tr> |
| 173 | <tr class="a"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 174 | <td><b><a href="#ignoreMissingArtifacts">ignoreMissingArtifacts</a></b></td> |
| 175 | <td><tt>boolean</tt></td> |
| 176 | <td><tt>-</tt></td> |
| 177 | <td>Ignore missing artifacts that are not required by current project |
| 178 | but are required by the transitive dependencies.<br /></td> |
| 179 | </tr> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 180 | <tr class="b"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 181 | <td><b><a href="#instructions">instructions</a></b></td> |
| 182 | <td><tt>Map</tt></td> |
| 183 | <td><tt>-</tt></td> |
| 184 | <td>The BND instructions for the bundle.<br /></td> |
| 185 | </tr> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 186 | <tr class="a"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 187 | <td><b><a href="#manifestLocation">manifestLocation</a></b></td> |
| 188 | <td><tt>File</tt></td> |
| 189 | <td><tt>-</tt></td> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 190 | <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> |
| 191 | </tr> |
| 192 | <tr class="b"> |
| 193 | <td><b><a href="#packaging">packaging</a></b></td> |
| 194 | <td><tt>String</tt></td> |
| 195 | <td><tt>-</tt></td> |
| 196 | <td>Packaging type of the bundle to be installed. For example, "jar". |
| 197 | Defaults to none which means use the same packaging as the project.<br /></td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 198 | </tr> |
| 199 | <tr class="a"> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 200 | <td><b><a href="#rebuildBundle">rebuildBundle</a></b></td> |
| 201 | <td><tt>boolean</tt></td> |
| 202 | <td><tt>-</tt></td> |
| 203 | <td>When true, generate the manifest by rebuilding the full bundle in |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 204 | memory<br /><b>User property is</b>: <tt>rebuildBundle</tt>.</td> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 205 | </tr> |
| 206 | <tr class="b"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 207 | <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td> |
| 208 | <td><tt>List</tt></td> |
| 209 | <td><tt>-</tt></td> |
| 210 | <td>Project types which this plugin supports.<br /></td> |
| 211 | </tr> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 212 | <tr class="a"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 213 | <td><b><a href="#unpackBundle">unpackBundle</a></b></td> |
| 214 | <td><tt>boolean</tt></td> |
| 215 | <td><tt>-</tt></td> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 216 | <td>When true, unpack the bundle contents to the outputDirectory<br /><b>User property is</b>: <tt>unpackBundle</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 217 | </tr> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 218 | <tr class="b"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 219 | <td><b><a href="#wrapImportPackage">wrapImportPackage</a></b></td> |
| 220 | <td><tt>String</tt></td> |
| 221 | <td><tt>-</tt></td> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 222 | <td>Import-Package to be used when wrapping dependencies.<br /><b>Default value is</b>: <tt>*</tt>.<br /><b>User property is</b>: <tt>wrapImportPackage</tt>.</td> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 223 | </tr> |
| 224 | </table> |
| 225 | </div> |
| 226 | <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3> |
| 227 | <p><b><a name="archive">archive</a>:</b></p> |
| 228 | <div>The archive configuration to use.</div> |
| 229 | <ul> |
| 230 | <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li> |
| 231 | <li><b>Required</b>: <tt>No</tt></li> |
| 232 | </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p> |
| 233 | <div>The directory for the generated JAR.</div> |
| 234 | <ul> |
| 235 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 236 | <li><b>Required</b>: <tt>Yes</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 237 | <li><b>User Property</b>: <tt>project.build.directory</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 238 | </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p> |
| 239 | <div>Classifier type of the bundle to be installed. For example, |
| 240 | "jdk14". Defaults to none which means this is the project's main |
| 241 | bundle.</div> |
| 242 | <ul> |
| 243 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 244 | <li><b>Required</b>: <tt>No</tt></li> |
| 245 | </ul><hr /><p><b><a name="depth">depth</a>:</b></p> |
| 246 | <div>Process up to some depth</div> |
| 247 | <ul> |
| 248 | <li><b>Type</b>: <tt>int</tt></li> |
| 249 | <li><b>Required</b>: <tt>No</tt></li> |
| 250 | </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p> |
| 251 | <div>File where the BND class-path will be dumped</div> |
| 252 | <ul> |
| 253 | <li><b>Type</b>: <tt>java.io.File</tt></li> |
| 254 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 255 | <li><b>User Property</b>: <tt>dumpClasspath</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 256 | </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p> |
| 257 | <div>File where the BND instructions will be dumped</div> |
| 258 | <ul> |
| 259 | <li><b>Type</b>: <tt>java.io.File</tt></li> |
| 260 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 261 | <li><b>User Property</b>: <tt>dumpInstructions</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 262 | </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p> |
| 263 | <div>Comma separated list of artifactIds to exclude from the dependency |
| 264 | classpath passed to BND (use "true" to exclude everything)</div> |
| 265 | <ul> |
| 266 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 267 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 268 | <li><b>User Property</b>: <tt>excludeDependencies</tt></li> |
| 269 | </ul><hr /><p><b><a name="finalName">finalName</a>:</b></p> |
| 270 | <div>Final name of the bundle (without classifier or extension)</div> |
| 271 | <ul> |
| 272 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 273 | <li><b>Required</b>: <tt>No</tt></li> |
| 274 | <li><b>User Property</b>: <tt>project.build.finalName</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 275 | </ul><hr /><p><b><a name="ignoreMissingArtifacts">ignoreMissingArtifacts</a>:</b></p> |
| 276 | <div>Ignore missing artifacts that are not required by current project |
| 277 | but are required by the transitive dependencies.</div> |
| 278 | <ul> |
| 279 | <li><b>Type</b>: <tt>boolean</tt></li> |
| 280 | <li><b>Required</b>: <tt>No</tt></li> |
| 281 | </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p> |
| 282 | <div>The BND instructions for the bundle.</div> |
| 283 | <ul> |
| 284 | <li><b>Type</b>: <tt>java.util.Map</tt></li> |
| 285 | <li><b>Required</b>: <tt>No</tt></li> |
| 286 | </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p> |
| 287 | <div>Directory where the manifest will be written</div> |
| 288 | <ul> |
| 289 | <li><b>Type</b>: <tt>java.io.File</tt></li> |
| 290 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 291 | <li><b>User Property</b>: <tt>manifestLocation</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 292 | <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li> |
| 293 | </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p> |
| 294 | <div>The directory for the generated bundles.</div> |
| 295 | <ul> |
| 296 | <li><b>Type</b>: <tt>java.io.File</tt></li> |
| 297 | <li><b>Required</b>: <tt>Yes</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 298 | <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li> |
| 299 | </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p> |
| 300 | <div>Packaging type of the bundle to be installed. For example, "jar". |
| 301 | Defaults to none which means use the same packaging as the project.</div> |
| 302 | <ul> |
| 303 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 304 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame] | 305 | </ul><hr /><p><b><a name="rebuildBundle">rebuildBundle</a>:</b></p> |
| 306 | <div>When true, generate the manifest by rebuilding the full bundle in |
| 307 | memory</div> |
| 308 | <ul> |
| 309 | <li><b>Type</b>: <tt>boolean</tt></li> |
| 310 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 311 | <li><b>User Property</b>: <tt>rebuildBundle</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 312 | </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p> |
| 313 | <div>Project types which this plugin supports.</div> |
| 314 | <ul> |
| 315 | <li><b>Type</b>: <tt>java.util.List</tt></li> |
| 316 | <li><b>Required</b>: <tt>No</tt></li> |
| 317 | </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p> |
| 318 | <div>When true, unpack the bundle contents to the outputDirectory</div> |
| 319 | <ul> |
| 320 | <li><b>Type</b>: <tt>boolean</tt></li> |
| 321 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 322 | <li><b>User Property</b>: <tt>unpackBundle</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 323 | </ul><hr /><p><b><a name="wrapImportPackage">wrapImportPackage</a>:</b></p> |
| 324 | <div>Import-Package to be used when wrapping dependencies.</div> |
| 325 | <ul> |
| 326 | <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| 327 | <li><b>Required</b>: <tt>No</tt></li> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 328 | <li><b>User Property</b>: <tt>wrapImportPackage</tt></li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 329 | <li><b>Default</b>: <tt>*</tt></li> |
| 330 | </ul> |
| 331 | </div> |
| 332 | </div> |
| 333 | |
| 334 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 335 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 336 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 337 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 338 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 339 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 340 | <div id="footer"> |
Stuart McCulloch | 8ddadb7 | 2013-06-07 23:25:18 +0000 | [diff] [blame^] | 341 | <div class="xright">Copyright © 2006-2013 |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 342 | <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 343 | All Rights Reserved. |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 344 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 345 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 346 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 347 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 348 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 349 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 350 | </body> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 351 | </html> |