Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 1cde38df181fac66b2ddedc7271bce1c1d0ad753 / . / bundleplugin / doc / site / install-file-mojo.html
blob: f4473c3083913d2ce9a94376c60b3c1659248e12 [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">
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:install-file</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 &nbsp;| <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:install-file<a name="bundle:install-file"></a></h2>
163 <p><b>Full name</b>:</p>
164 <p>org.apache.felix:maven-bundle-plugin:2.3.5:install-file</p>
165 <p><b>Description</b>:</p>
166 <div>Installs bundle details in the local OBR repository (command-line
167goal)</div>
168 <p><b>Attributes</b>:</p>
169 <ul>
170 <li>Binds by default to the lifecycle phase: <tt>install</tt>.</li>
171 </ul>
172 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
173 <table class="bodyTable" border="0">
174 <tr class="a">
175 <th>Name</th>
176 <th>Type</th>
177 <th>Since</th>
178 <th>Description</th>
179 </tr>
180 <tr class="b">
181 <td><b><a href="#artifactId">artifactId</a></b></td>
182 <td><tt>String</tt></td>
183 <td><tt>-</tt></td>
184 <td>ArtifactId of the bundle. Retrieved from POM file if specified.<br /></td>
185 </tr>
186 <tr class="a">
187 <td><b><a href="#classifier">classifier</a></b></td>
188 <td><tt>String</tt></td>
189 <td><tt>-</tt></td>
190 <td>Classifier type of the bundle. Defaults to none.<br /></td>
191 </tr>
192 <tr class="b">
193 <td><b><a href="#file">file</a></b></td>
194 <td><tt>File</tt></td>
195 <td><tt>-</tt></td>
196 <td>Bundle file, defaults to the artifact in the local Maven
197repository.<br /></td>
198 </tr>
199 <tr class="a">
200 <td><b><a href="#groupId">groupId</a></b></td>
201 <td><tt>String</tt></td>
202 <td><tt>-</tt></td>
203 <td>GroupId of the bundle. Retrieved from POM file if specified.<br /></td>
204 </tr>
205 <tr class="b">
206 <td><b><a href="#obrRepository">obrRepository</a></b></td>
207 <td><tt>String</tt></td>
208 <td><tt>-</tt></td>
209 <td>OBR Repository.<br /></td>
210 </tr>
211 <tr class="a">
212 <td><b><a href="#obrXml">obrXml</a></b></td>
213 <td><tt>String</tt></td>
214 <td><tt>-</tt></td>
215 <td>Optional XML file describing additional requirements and
216capabilities.<br /></td>
217 </tr>
218 <tr class="b">
219 <td><b><a href="#packaging">packaging</a></b></td>
220 <td><tt>String</tt></td>
221 <td><tt>-</tt></td>
222 <td>Packaging type of the bundle. Retrieved from POM file if specified.<br /></td>
223 </tr>
224 <tr class="a">
225 <td><b><a href="#pomFile">pomFile</a></b></td>
226 <td><tt>File</tt></td>
227 <td><tt>-</tt></td>
228 <td>Location of an existing POM file.<br /></td>
229 </tr>
230 <tr class="b">
231 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
232 <td><tt>List</tt></td>
233 <td><tt>-</tt></td>
234 <td>Project types which this plugin supports.<br /></td>
235 </tr>
236 <tr class="a">
237 <td><b><a href="#version">version</a></b></td>
238 <td><tt>String</tt></td>
239 <td><tt>-</tt></td>
240 <td>Version of the bundle. Retrieved from POM file if specified.<br /></td>
241 </tr>
242 </table>
243 </div>
244 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
245 <p><b><a name="artifactId">artifactId</a>:</b></p>
246 <div>ArtifactId of the bundle. Retrieved from POM file if specified.</div>
247 <ul>
248 <li><b>Type</b>: <tt>java.lang.String</tt></li>
249 <li><b>Required</b>: <tt>No</tt></li>
250 <li><b>Expression</b>: <tt>${artifactId}</tt></li>
251 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
252 <div>Classifier type of the bundle. Defaults to none.</div>
253 <ul>
254 <li><b>Type</b>: <tt>java.lang.String</tt></li>
255 <li><b>Required</b>: <tt>No</tt></li>
256 <li><b>Expression</b>: <tt>${classifier}</tt></li>
257 </ul><hr /><p><b><a name="file">file</a>:</b></p>
258 <div>Bundle file, defaults to the artifact in the local Maven
259repository.</div>
260 <ul>
261 <li><b>Type</b>: <tt>java.io.File</tt></li>
262 <li><b>Required</b>: <tt>No</tt></li>
263 <li><b>Expression</b>: <tt>${file}</tt></li>
264 </ul><hr /><p><b><a name="groupId">groupId</a>:</b></p>
265 <div>GroupId of the bundle. Retrieved from POM file if specified.</div>
266 <ul>
267 <li><b>Type</b>: <tt>java.lang.String</tt></li>
268 <li><b>Required</b>: <tt>No</tt></li>
269 <li><b>Expression</b>: <tt>${groupId}</tt></li>
270 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
271 <div>OBR Repository.</div>
272 <ul>
273 <li><b>Type</b>: <tt>java.lang.String</tt></li>
274 <li><b>Required</b>: <tt>No</tt></li>
275 <li><b>Expression</b>: <tt>${obrRepository}</tt></li>
276 </ul><hr /><p><b><a name="obrXml">obrXml</a>:</b></p>
277 <div>Optional XML file describing additional requirements and
278capabilities.</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>Expression</b>: <tt>${obrXml}</tt></li>
283 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
284 <div>Packaging type of the bundle. Retrieved from POM file if specified.</div>
285 <ul>
286 <li><b>Type</b>: <tt>java.lang.String</tt></li>
287 <li><b>Required</b>: <tt>No</tt></li>
288 <li><b>Expression</b>: <tt>${packaging}</tt></li>
289 </ul><hr /><p><b><a name="pomFile">pomFile</a>:</b></p>
290 <div>Location of an existing POM file.</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>${pomFile}</tt></li>
295 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
296 <div>Project types which this plugin supports.</div>
297 <ul>
298 <li><b>Type</b>: <tt>java.util.List</tt></li>
299 <li><b>Required</b>: <tt>No</tt></li>
300 </ul><hr /><p><b><a name="version">version</a>:</b></p>
301 <div>Version of the bundle. Retrieved from POM file if specified.</div>
302 <ul>
303 <li><b>Type</b>: <tt>java.lang.String</tt></li>
304 <li><b>Required</b>: <tt>No</tt></li>
305 <li><b>Expression</b>: <tt>${version}</tt></li>
306 </ul>
307 </div>
308 </div>
309
310
311
312 </div>
313
314 </div>
315
316 <div class="clear">
317
318 <hr/>
319
320 </div>
321
322 <div id="footer">
323
324 <div class="xright">Copyright &#169; 2006-2011
325
326 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
327
328 All Rights Reserved.
329
330
331
332 </div>
333
334 <div class="clear">
335
336 <hr/>
337
338 </div>
339
340 </div>
341
342 </body>
343
344</html>
345