Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 1f7f4308d4cd6447ccdd5ae4d97911897d2a98ee / . / tools / maven-bundle-plugin / doc / site / wrap-mojo.html
blob: 876309bcfbddcc7953ace13f3eec9ef2744c8350 [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 McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]2<!-- Generated by Apache Maven Doxia at Jun 20, 2014 -->
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 McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]14 <meta name="Date-Revision-yyyymmdd" content="20140620" />
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 McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]31 <span id="publishDate">Last Published: 2014-06-20</span>
32 &nbsp;| <span id="projectVersion">Version: 2.5.0</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 McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]85 <p>org.apache.felix:maven-bundle-plugin:2.5.0: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>
Stuart McCullocha5689862014-06-20 11:41:00 +0000[diff] [blame]90 <div>Create OSGi bundles from the direct dependencies of the Maven
91project.</div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]92 <p><b>Attributes</b>:</p>
93 <ul>
94 <li>Requires a Maven project to be executed.</li>
95 <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
96 <li>The goal is thread-safe and supports parallel builds.</li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]97 <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 McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]98 </ul>
99 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
100 <table class="bodyTable" border="0">
101 <tr class="a">
102 <th>Name</th>
103 <th>Type</th>
104 <th>Since</th>
105 <th>Description</th>
106 </tr>
107 <tr class="b">
108 <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
109 <td><tt>String</tt></td>
110 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]111 <td>The directory for the generated JAR.<br /><b>User property is</b>: <tt>project.build.directory</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]112 </tr>
113 <tr class="a">
114 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
115 <td><tt>File</tt></td>
116 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]117 <td>The directory for the generated bundles.<br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]118 </tr>
119 </table>
120 </div>
121 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
122 <table class="bodyTable" border="0">
123 <tr class="a">
124 <th>Name</th>
125 <th>Type</th>
126 <th>Since</th>
127 <th>Description</th>
128 </tr>
129 <tr class="b">
130 <td><b><a href="#archive">archive</a></b></td>
131 <td><tt>MavenArchiveConfiguration</tt></td>
132 <td><tt>-</tt></td>
133 <td>The archive configuration to use.<br /></td>
134 </tr>
135 <tr class="a">
136 <td><b><a href="#classifier">classifier</a></b></td>
137 <td><tt>String</tt></td>
138 <td><tt>-</tt></td>
139 <td>Classifier type of the bundle to be installed. For example,
140&quot;jdk14&quot;. Defaults to none which means this is the project's main
141bundle.<br /></td>
142 </tr>
143 <tr class="b">
144 <td><b><a href="#depth">depth</a></b></td>
145 <td><tt>int</tt></td>
146 <td><tt>-</tt></td>
147 <td>Process up to some depth<br /></td>
148 </tr>
149 <tr class="a">
150 <td><b><a href="#dumpClasspath">dumpClasspath</a></b></td>
151 <td><tt>File</tt></td>
152 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]153 <td>File where the BND class-path will be dumped<br /><b>User property is</b>: <tt>dumpClasspath</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]154 </tr>
155 <tr class="b">
156 <td><b><a href="#dumpInstructions">dumpInstructions</a></b></td>
157 <td><tt>File</tt></td>
158 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]159 <td>File where the BND instructions will be dumped<br /><b>User property is</b>: <tt>dumpInstructions</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]160 </tr>
161 <tr class="a">
162 <td><b><a href="#excludeDependencies">excludeDependencies</a></b></td>
163 <td><tt>String</tt></td>
164 <td><tt>-</tt></td>
165 <td>Comma separated list of artifactIds to exclude from the dependency
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]166classpath passed to BND (use &quot;true&quot; to exclude everything)<br /><b>User property is</b>: <tt>excludeDependencies</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]167 </tr>
168 <tr class="b">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]169 <td><b><a href="#finalName">finalName</a></b></td>
170 <td><tt>String</tt></td>
171 <td><tt>-</tt></td>
172 <td>Final name of the bundle (without classifier or extension)<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td>
173 </tr>
174 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]175 <td><b><a href="#ignoreMissingArtifacts">ignoreMissingArtifacts</a></b></td>
176 <td><tt>boolean</tt></td>
177 <td><tt>-</tt></td>
178 <td>Ignore missing artifacts that are not required by current project
179but are required by the transitive dependencies.<br /></td>
180 </tr>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]181 <tr class="b">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]182 <td><b><a href="#instructions">instructions</a></b></td>
183 <td><tt>Map</tt></td>
184 <td><tt>-</tt></td>
185 <td>The BND instructions for the bundle.<br /></td>
186 </tr>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]187 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]188 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
189 <td><tt>File</tt></td>
190 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]191 <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>
192 </tr>
193 <tr class="b">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]194 <td><b><a href="#niceManifest">niceManifest</a></b></td>
195 <td><tt>boolean</tt></td>
196 <td><tt>-</tt></td>
Stuart McCullocha5689862014-06-20 11:41:00 +0000[diff] [blame]197 <td>Output a nicely formatted manifest that still respects the 72
198character line limit.<br /></td>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]199 </tr>
200 <tr class="a">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]201 <td><b><a href="#packaging">packaging</a></b></td>
202 <td><tt>String</tt></td>
203 <td><tt>-</tt></td>
204 <td>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
205Defaults to none which means use the same packaging as the project.<br /></td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]206 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]207 <tr class="b">
Stuart McCulloch148b7bf2011-11-28 16:39:12 +0000[diff] [blame]208 <td><b><a href="#rebuildBundle">rebuildBundle</a></b></td>
209 <td><tt>boolean</tt></td>
210 <td><tt>-</tt></td>
211 <td>When true, generate the manifest by rebuilding the full bundle in
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]212memory<br /><b>User property is</b>: <tt>rebuildBundle</tt>.</td>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +0000[diff] [blame]213 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]214 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]215 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
216 <td><tt>List</tt></td>
217 <td><tt>-</tt></td>
218 <td>Project types which this plugin supports.<br /></td>
219 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]220 <tr class="b">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]221 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
222 <td><tt>boolean</tt></td>
223 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]224 <td>When true, unpack the bundle contents to the outputDirectory<br /><b>User property is</b>: <tt>unpackBundle</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]225 </tr>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]226 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]227 <td><b><a href="#wrapImportPackage">wrapImportPackage</a></b></td>
228 <td><tt>String</tt></td>
229 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]230 <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 McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]231 </tr>
232 </table>
233 </div>
234 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
235 <p><b><a name="archive">archive</a>:</b></p>
236 <div>The archive configuration to use.</div>
237 <ul>
238 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
239 <li><b>Required</b>: <tt>No</tt></li>
240 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
241 <div>The directory for the generated JAR.</div>
242 <ul>
243 <li><b>Type</b>: <tt>java.lang.String</tt></li>
244 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]245 <li><b>User Property</b>: <tt>project.build.directory</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]246 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
247 <div>Classifier type of the bundle to be installed. For example,
248&quot;jdk14&quot;. Defaults to none which means this is the project's main
249bundle.</div>
250 <ul>
251 <li><b>Type</b>: <tt>java.lang.String</tt></li>
252 <li><b>Required</b>: <tt>No</tt></li>
253 </ul><hr /><p><b><a name="depth">depth</a>:</b></p>
254 <div>Process up to some depth</div>
255 <ul>
256 <li><b>Type</b>: <tt>int</tt></li>
257 <li><b>Required</b>: <tt>No</tt></li>
258 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
259 <div>File where the BND class-path will be dumped</div>
260 <ul>
261 <li><b>Type</b>: <tt>java.io.File</tt></li>
262 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]263 <li><b>User Property</b>: <tt>dumpClasspath</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]264 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
265 <div>File where the BND instructions will be dumped</div>
266 <ul>
267 <li><b>Type</b>: <tt>java.io.File</tt></li>
268 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]269 <li><b>User Property</b>: <tt>dumpInstructions</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]270 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
271 <div>Comma separated list of artifactIds to exclude from the dependency
272classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
273 <ul>
274 <li><b>Type</b>: <tt>java.lang.String</tt></li>
275 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]276 <li><b>User Property</b>: <tt>excludeDependencies</tt></li>
277 </ul><hr /><p><b><a name="finalName">finalName</a>:</b></p>
278 <div>Final name of the bundle (without classifier or extension)</div>
279 <ul>
280 <li><b>Type</b>: <tt>java.lang.String</tt></li>
281 <li><b>Required</b>: <tt>No</tt></li>
282 <li><b>User Property</b>: <tt>project.build.finalName</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]283 </ul><hr /><p><b><a name="ignoreMissingArtifacts">ignoreMissingArtifacts</a>:</b></p>
284 <div>Ignore missing artifacts that are not required by current project
285but are required by the transitive dependencies.</div>
286 <ul>
287 <li><b>Type</b>: <tt>boolean</tt></li>
288 <li><b>Required</b>: <tt>No</tt></li>
289 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
290 <div>The BND instructions for the bundle.</div>
291 <ul>
292 <li><b>Type</b>: <tt>java.util.Map</tt></li>
293 <li><b>Required</b>: <tt>No</tt></li>
294 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
295 <div>Directory where the manifest will be written</div>
296 <ul>
297 <li><b>Type</b>: <tt>java.io.File</tt></li>
298 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]299 <li><b>User Property</b>: <tt>manifestLocation</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]300 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]301 </ul><hr /><p><b><a name="niceManifest">niceManifest</a>:</b></p>
Stuart McCullocha5689862014-06-20 11:41:00 +0000[diff] [blame]302 <div>Output a nicely formatted manifest that still respects the 72
303character line limit.</div>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]304 <ul>
305 <li><b>Type</b>: <tt>boolean</tt></li>
306 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]307 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
308 <div>The directory for the generated bundles.</div>
309 <ul>
310 <li><b>Type</b>: <tt>java.io.File</tt></li>
311 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]312 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
313 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
314 <div>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
315Defaults to none which means use the same packaging as the project.</div>
316 <ul>
317 <li><b>Type</b>: <tt>java.lang.String</tt></li>
318 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +0000[diff] [blame]319 </ul><hr /><p><b><a name="rebuildBundle">rebuildBundle</a>:</b></p>
320 <div>When true, generate the manifest by rebuilding the full bundle in
321memory</div>
322 <ul>
323 <li><b>Type</b>: <tt>boolean</tt></li>
324 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]325 <li><b>User Property</b>: <tt>rebuildBundle</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]326 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
327 <div>Project types which this plugin supports.</div>
328 <ul>
329 <li><b>Type</b>: <tt>java.util.List</tt></li>
330 <li><b>Required</b>: <tt>No</tt></li>
331 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
332 <div>When true, unpack the bundle contents to the outputDirectory</div>
333 <ul>
334 <li><b>Type</b>: <tt>boolean</tt></li>
335 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]336 <li><b>User Property</b>: <tt>unpackBundle</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]337 </ul><hr /><p><b><a name="wrapImportPackage">wrapImportPackage</a>:</b></p>
338 <div>Import-Package to be used when wrapping dependencies.</div>
339 <ul>
340 <li><b>Type</b>: <tt>java.lang.String</tt></li>
341 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]342 <li><b>User Property</b>: <tt>wrapImportPackage</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]343 <li><b>Default</b>: <tt>*</tt></li>
344 </ul>
345 </div>
346 </div>
347
348
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]349 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]350 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]351 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]352 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]353 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]354 <div id="footer">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000[diff] [blame]355 <div class="xright">Copyright &#169; 2006-2014
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]356 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]357 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]358
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]359 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]360 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]361 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]362 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]363 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]364 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]365</html>