blob: 5b51e8d9eac98c53d6554d69757061c8e4e5021f [file] [log] [blame]
Stuart McCullochd16db972011-07-05 11:48:22 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +00002<!-- Generated by Apache Maven Doxia at Jun 8, 2013 -->
Stuart McCullochd16db972011-07-05 11:48:22 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Stuart McCullochd16db972011-07-05 11:48:22 +00004 <head>
Stuart McCullochd16db972011-07-05 11:48:22 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Stuart McCullochd16db972011-07-05 11:48:22 +00006 <title>Maven Bundle Plugin -
7 bundle:instructions</title>
Stuart McCullochd16db972011-07-05 11:48:22 +00008 <style type="text/css" media="all">
Stuart McCullochd16db972011-07-05 11:48:22 +00009 @import url("./css/maven-base.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000010 @import url("./css/maven-theme.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000011 @import url("./css/site.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000012 </style>
Stuart McCullochd16db972011-07-05 11:48:22 +000013 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
Stuart McCulloch8ddadb72013-06-07 23:25:18 +000014 <meta name="Date-Revision-yyyymmdd" content="20130608" />
Stuart McCullochd16db972011-07-05 11:48:22 +000015 <meta http-equiv="Content-Language" content="en" />
Stuart McCullochd16db972011-07-05 11:48:22 +000016
Stuart McCullochd16db972011-07-05 11:48:22 +000017 </head>
Stuart McCullochd16db972011-07-05 11:48:22 +000018 <body class="composite">
Stuart McCullochd16db972011-07-05 11:48:22 +000019 <div id="banner">
Stuart McCullochd16db972011-07-05 11:48:22 +000020 <div id="bannerLeft">
Stuart McCullochd16db972011-07-05 11:48:22 +000021 Maven Bundle Plugin
Stuart McCullochd16db972011-07-05 11:48:22 +000022 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000023 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000024 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000025 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000026 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000027 <div id="breadcrumbs">
Stuart McCullochd16db972011-07-05 11:48:22 +000028
Stuart McCullochd16db972011-07-05 11:48:22 +000029
Stuart McCullochd16db972011-07-05 11:48:22 +000030 <div class="xleft">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +000031 <span id="publishDate">Last Published: 2013-06-08</span>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +000032 &nbsp;| <span id="projectVersion">Version: 2.4.0-SNAPSHOT</span>
Stuart McCullochd16db972011-07-05 11:48:22 +000033 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000034 <div class="xright">
Stuart McCullochd16db972011-07-05 11:48:22 +000035
Stuart McCullochd16db972011-07-05 11:48:22 +000036 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000037 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000038 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000039 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000040 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000041 <div id="leftColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000042 <div id="navcolumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000043
Stuart McCullochd16db972011-07-05 11:48:22 +000044
Stuart McCullochd16db972011-07-05 11:48:22 +000045 <h5>Overview</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000046 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000047 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000048 <a href="index.html" title="Introduction">Introduction</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000049 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000050 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000051 <a href="plugin-info.html" title="Goals">Goals</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000052 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000053 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000054 <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 +000055 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000056 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000057 <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 +000058 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000059 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000060 <a href="jira-report.html" title="Release Notes">Release Notes</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000061 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000062 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000063 <h5>Project Documentation</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000064 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000065 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000066 <a href="project-info.html" title="Project Information">Project Information</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000067 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000068 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000069 <a href="project-reports.html" title="Project Reports">Project Reports</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000070 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000071 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000072 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
Stuart McCullochd16db972011-07-05 11:48:22 +000073 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
Stuart McCullochd16db972011-07-05 11:48:22 +000074 </a>
Stuart McCullochd16db972011-07-05 11:48:22 +000075
Stuart McCullochd16db972011-07-05 11:48:22 +000076
Stuart McCullochd16db972011-07-05 11:48:22 +000077 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000078 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000079 <div id="bodyColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000080 <div id="contentBox">
Stuart McCullochd16db972011-07-05 11:48:22 +000081
82
83 <div class="section"><h2>bundle:instructions<a name="bundle:instructions"></a></h2>
84 <p><b>Full name</b>:</p>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +000085 <p>org.apache.felix:maven-bundle-plugin:2.4.0-SNAPSHOT:instructions</p>
Stuart McCullochd16db972011-07-05 11:48:22 +000086 <p><b>Description</b>:</p>
87 <div>Generate BND instructions for this project</div>
88 <p><b>Attributes</b>:</p>
89 <ul>
90 <li>Requires a Maven project to be executed.</li>
91 <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
92 <li>The goal is thread-safe and supports parallel builds.</li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +000093 <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 +000094 </ul>
95 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
96 <table class="bodyTable" border="0">
97 <tr class="a">
98 <th>Name</th>
99 <th>Type</th>
100 <th>Since</th>
101 <th>Description</th>
102 </tr>
103 <tr class="b">
104 <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
105 <td><tt>String</tt></td>
106 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000107 <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 +0000108 </tr>
109 <tr class="a">
110 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
111 <td><tt>File</tt></td>
112 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000113 <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 +0000114 </tr>
115 </table>
116 </div>
117 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
118 <table class="bodyTable" border="0">
119 <tr class="a">
120 <th>Name</th>
121 <th>Type</th>
122 <th>Since</th>
123 <th>Description</th>
124 </tr>
125 <tr class="b">
126 <td><b><a href="#archive">archive</a></b></td>
127 <td><tt>MavenArchiveConfiguration</tt></td>
128 <td><tt>-</tt></td>
129 <td>The archive configuration to use.<br /></td>
130 </tr>
131 <tr class="a">
132 <td><b><a href="#classifier">classifier</a></b></td>
133 <td><tt>String</tt></td>
134 <td><tt>-</tt></td>
135 <td>Classifier type of the bundle to be installed. For example,
136&quot;jdk14&quot;. Defaults to none which means this is the project's main
137bundle.<br /></td>
138 </tr>
139 <tr class="b">
140 <td><b><a href="#dumpClasspath">dumpClasspath</a></b></td>
141 <td><tt>File</tt></td>
142 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000143 <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 +0000144 </tr>
145 <tr class="a">
146 <td><b><a href="#dumpInstructions">dumpInstructions</a></b></td>
147 <td><tt>File</tt></td>
148 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000149 <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 +0000150 </tr>
151 <tr class="b">
152 <td><b><a href="#excludeDependencies">excludeDependencies</a></b></td>
153 <td><tt>String</tt></td>
154 <td><tt>-</tt></td>
155 <td>Comma separated list of artifactIds to exclude from the dependency
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000156classpath 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 +0000157 </tr>
158 <tr class="a">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000159 <td><b><a href="#finalName">finalName</a></b></td>
160 <td><tt>String</tt></td>
161 <td><tt>-</tt></td>
162 <td>Final name of the bundle (without classifier or extension)<br /><b>User property is</b>: <tt>project.build.finalName</tt>.</td>
163 </tr>
164 <tr class="b">
Stuart McCullochd16db972011-07-05 11:48:22 +0000165 <td><b><a href="#instructions">instructions</a></b></td>
166 <td><tt>Map</tt></td>
167 <td><tt>-</tt></td>
168 <td>The BND instructions for the bundle.<br /></td>
169 </tr>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000170 <tr class="a">
Stuart McCullochd16db972011-07-05 11:48:22 +0000171 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
172 <td><tt>File</tt></td>
173 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000174 <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>
175 </tr>
176 <tr class="b">
177 <td><b><a href="#packaging">packaging</a></b></td>
178 <td><tt>String</tt></td>
179 <td><tt>-</tt></td>
180 <td>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
181Defaults to none which means use the same packaging as the project.<br /></td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000182 </tr>
183 <tr class="a">
184 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
185 <td><tt>List</tt></td>
186 <td><tt>-</tt></td>
187 <td>Project types which this plugin supports.<br /></td>
188 </tr>
189 <tr class="b">
190 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
191 <td><tt>boolean</tt></td>
192 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000193 <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 +0000194 </tr>
195 </table>
196 </div>
197 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
198 <p><b><a name="archive">archive</a>:</b></p>
199 <div>The archive configuration to use.</div>
200 <ul>
201 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
202 <li><b>Required</b>: <tt>No</tt></li>
203 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
204 <div>The directory for the generated JAR.</div>
205 <ul>
206 <li><b>Type</b>: <tt>java.lang.String</tt></li>
207 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000208 <li><b>User Property</b>: <tt>project.build.directory</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000209 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
210 <div>Classifier type of the bundle to be installed. For example,
211&quot;jdk14&quot;. Defaults to none which means this is the project's main
212bundle.</div>
213 <ul>
214 <li><b>Type</b>: <tt>java.lang.String</tt></li>
215 <li><b>Required</b>: <tt>No</tt></li>
216 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
217 <div>File where the BND class-path will be dumped</div>
218 <ul>
219 <li><b>Type</b>: <tt>java.io.File</tt></li>
220 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000221 <li><b>User Property</b>: <tt>dumpClasspath</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000222 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
223 <div>File where the BND instructions will be dumped</div>
224 <ul>
225 <li><b>Type</b>: <tt>java.io.File</tt></li>
226 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000227 <li><b>User Property</b>: <tt>dumpInstructions</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000228 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
229 <div>Comma separated list of artifactIds to exclude from the dependency
230classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
231 <ul>
232 <li><b>Type</b>: <tt>java.lang.String</tt></li>
233 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000234 <li><b>User Property</b>: <tt>excludeDependencies</tt></li>
235 </ul><hr /><p><b><a name="finalName">finalName</a>:</b></p>
236 <div>Final name of the bundle (without classifier or extension)</div>
237 <ul>
238 <li><b>Type</b>: <tt>java.lang.String</tt></li>
239 <li><b>Required</b>: <tt>No</tt></li>
240 <li><b>User Property</b>: <tt>project.build.finalName</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000241 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
242 <div>The BND instructions for the bundle.</div>
243 <ul>
244 <li><b>Type</b>: <tt>java.util.Map</tt></li>
245 <li><b>Required</b>: <tt>No</tt></li>
246 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
247 <div>Directory where the manifest will be written</div>
248 <ul>
249 <li><b>Type</b>: <tt>java.io.File</tt></li>
250 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000251 <li><b>User Property</b>: <tt>manifestLocation</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000252 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
253 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
254 <div>The directory for the generated bundles.</div>
255 <ul>
256 <li><b>Type</b>: <tt>java.io.File</tt></li>
257 <li><b>Required</b>: <tt>Yes</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000258 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
259 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
260 <div>Packaging type of the bundle to be installed. For example, &quot;jar&quot;.
261Defaults to none which means use the same packaging as the project.</div>
262 <ul>
263 <li><b>Type</b>: <tt>java.lang.String</tt></li>
264 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000265 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
266 <div>Project types which this plugin supports.</div>
267 <ul>
268 <li><b>Type</b>: <tt>java.util.List</tt></li>
269 <li><b>Required</b>: <tt>No</tt></li>
270 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
271 <div>When true, unpack the bundle contents to the outputDirectory</div>
272 <ul>
273 <li><b>Type</b>: <tt>boolean</tt></li>
274 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000275 <li><b>User Property</b>: <tt>unpackBundle</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000276 </ul>
277 </div>
278 </div>
279
280
Stuart McCullochd16db972011-07-05 11:48:22 +0000281 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000282 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000283 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000284 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000285 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000286 <div id="footer">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000287 <div class="xright">Copyright &#169; 2006-2013
Stuart McCullochd16db972011-07-05 11:48:22 +0000288 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000289 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000290
Stuart McCullochd16db972011-07-05 11:48:22 +0000291 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000292 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000293 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000294 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000295 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000296 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000297</html>