Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 38e94dc4de71d3d5ed59fc6ebbbc9f7d2da53181 / . / bundleplugin / doc / site / instructions-mojo.html
blob: 112251c1f5f1c861e6b0a9b756ee8bc098d4aff5 [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:instructions</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:instructions<a name="bundle:instructions"></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:instructions</p>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]86 <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>
93 <li>Binds by default to the lifecycle phase: <tt>package</tt>.</li>
94 </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>
107 <td>The directory for the generated JAR.<br /></td>
108 </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>
113 <td>The directory for the generated bundles.<br /></td>
114 </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>
143 <td>File where the BND class-path will be dumped<br /></td>
144 </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>
149 <td>File where the BND instructions will be dumped<br /></td>
150 </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
156classpath passed to BND (use &quot;true&quot; to exclude everything)<br /></td>
157 </tr>
158 <tr class="a">
159 <td><b><a href="#instructions">instructions</a></b></td>
160 <td><tt>Map</tt></td>
161 <td><tt>-</tt></td>
162 <td>The BND instructions for the bundle.<br /></td>
163 </tr>
164 <tr class="b">
165 <td><b><a href="#manifestLocation">manifestLocation</a></b></td>
166 <td><tt>File</tt></td>
167 <td><tt>-</tt></td>
168 <td>Directory where the manifest will be written<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/META-INF</tt>.</td>
169 </tr>
170 <tr class="a">
171 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
172 <td><tt>List</tt></td>
173 <td><tt>-</tt></td>
174 <td>Project types which this plugin supports.<br /></td>
175 </tr>
176 <tr class="b">
177 <td><b><a href="#unpackBundle">unpackBundle</a></b></td>
178 <td><tt>boolean</tt></td>
179 <td><tt>-</tt></td>
180 <td>When true, unpack the bundle contents to the outputDirectory<br /></td>
181 </tr>
182 </table>
183 </div>
184 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
185 <p><b><a name="archive">archive</a>:</b></p>
186 <div>The archive configuration to use.</div>
187 <ul>
188 <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
189 <li><b>Required</b>: <tt>No</tt></li>
190 </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
191 <div>The directory for the generated JAR.</div>
192 <ul>
193 <li><b>Type</b>: <tt>java.lang.String</tt></li>
194 <li><b>Required</b>: <tt>Yes</tt></li>
195 <li><b>Expression</b>: <tt>${project.build.directory}</tt></li>
196 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
197 <div>Classifier type of the bundle to be installed. For example,
198&quot;jdk14&quot;. Defaults to none which means this is the project's main
199bundle.</div>
200 <ul>
201 <li><b>Type</b>: <tt>java.lang.String</tt></li>
202 <li><b>Required</b>: <tt>No</tt></li>
203 </ul><hr /><p><b><a name="dumpClasspath">dumpClasspath</a>:</b></p>
204 <div>File where the BND class-path will be dumped</div>
205 <ul>
206 <li><b>Type</b>: <tt>java.io.File</tt></li>
207 <li><b>Required</b>: <tt>No</tt></li>
208 <li><b>Expression</b>: <tt>${dumpClasspath}</tt></li>
209 </ul><hr /><p><b><a name="dumpInstructions">dumpInstructions</a>:</b></p>
210 <div>File where the BND instructions will be dumped</div>
211 <ul>
212 <li><b>Type</b>: <tt>java.io.File</tt></li>
213 <li><b>Required</b>: <tt>No</tt></li>
214 <li><b>Expression</b>: <tt>${dumpInstructions}</tt></li>
215 </ul><hr /><p><b><a name="excludeDependencies">excludeDependencies</a>:</b></p>
216 <div>Comma separated list of artifactIds to exclude from the dependency
217classpath passed to BND (use &quot;true&quot; to exclude everything)</div>
218 <ul>
219 <li><b>Type</b>: <tt>java.lang.String</tt></li>
220 <li><b>Required</b>: <tt>No</tt></li>
221 <li><b>Expression</b>: <tt>${excludeDependencies}</tt></li>
222 </ul><hr /><p><b><a name="instructions">instructions</a>:</b></p>
223 <div>The BND instructions for the bundle.</div>
224 <ul>
225 <li><b>Type</b>: <tt>java.util.Map</tt></li>
226 <li><b>Required</b>: <tt>No</tt></li>
227 </ul><hr /><p><b><a name="manifestLocation">manifestLocation</a>:</b></p>
228 <div>Directory where the manifest will be written</div>
229 <ul>
230 <li><b>Type</b>: <tt>java.io.File</tt></li>
231 <li><b>Required</b>: <tt>No</tt></li>
232 <li><b>Expression</b>: <tt>${manifestLocation}</tt></li>
233 <li><b>Default</b>: <tt>${project.build.outputDirectory}/META-INF</tt></li>
234 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
235 <div>The directory for the generated bundles.</div>
236 <ul>
237 <li><b>Type</b>: <tt>java.io.File</tt></li>
238 <li><b>Required</b>: <tt>Yes</tt></li>
239 <li><b>Expression</b>: <tt>${project.build.outputDirectory}</tt></li>
240 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
241 <div>Project types which this plugin supports.</div>
242 <ul>
243 <li><b>Type</b>: <tt>java.util.List</tt></li>
244 <li><b>Required</b>: <tt>No</tt></li>
245 </ul><hr /><p><b><a name="unpackBundle">unpackBundle</a>:</b></p>
246 <div>When true, unpack the bundle contents to the outputDirectory</div>
247 <ul>
248 <li><b>Type</b>: <tt>boolean</tt></li>
249 <li><b>Required</b>: <tt>No</tt></li>
250 <li><b>Expression</b>: <tt>${unpackBundle}</tt></li>
251 </ul>
252 </div>
253 </div>
254
255
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]256 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]257 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]258 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]259 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]260 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]261 <div id="footer">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]262 <div class="xright">Copyright &#169; 2006-2011
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]263 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]264 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]265
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]266 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]267 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]268 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]269 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]270 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]271 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]272</html>