Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 1cde38df181fac66b2ddedc7271bce1c1d0ad753 / . / bundleplugin / doc / site / deploy-file-mojo.html
blob: 3a40db7926046a000c839c0d1049ef918d2ff747 [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:deploy-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:deploy-file<a name="bundle:deploy-file"></a></h2>
163 <p><b>Full name</b>:</p>
164 <p>org.apache.felix:maven-bundle-plugin:2.3.5:deploy-file</p>
165 <p><b>Description</b>:</p>
166 <div>Deploys bundle details to a remote OBR repository (command-line
167goal)</div>
168 <p><b>Attributes</b>:</p>
169 <ul>
170 <li>Binds by default to the lifecycle phase: <tt>deploy</tt>.</li>
171 </ul>
172 <div class="section"><h3>Required Parameters<a name="Required_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="#repositoryId">repositoryId</a></b></td>
182 <td><tt>String</tt></td>
183 <td><tt>-</tt></td>
184 <td>Remote repository id, used to lookup authentication settings.<br /><b>Default value is</b>: <tt>remote-repository</tt>.</td>
185 </tr>
186 <tr class="a">
187 <td><b><a href="#url">url</a></b></td>
188 <td><tt>String</tt></td>
189 <td><tt>-</tt></td>
190 <td>Remote OBR repository URL, where the bundle details are to be
191uploaded.<br /></td>
192 </tr>
193 </table>
194 </div>
195 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
196 <table class="bodyTable" border="0">
197 <tr class="a">
198 <th>Name</th>
199 <th>Type</th>
200 <th>Since</th>
201 <th>Description</th>
202 </tr>
203 <tr class="b">
204 <td><b><a href="#artifactId">artifactId</a></b></td>
205 <td><tt>String</tt></td>
206 <td><tt>-</tt></td>
207 <td>ArtifactId of the bundle. Retrieved from POM file if specified.<br /></td>
208 </tr>
209 <tr class="a">
210 <td><b><a href="#bundleUrl">bundleUrl</a></b></td>
211 <td><tt>String</tt></td>
212 <td><tt>-</tt></td>
213 <td>Optional public URL where the bundle has been deployed.<br /></td>
214 </tr>
215 <tr class="b">
216 <td><b><a href="#classifier">classifier</a></b></td>
217 <td><tt>String</tt></td>
218 <td><tt>-</tt></td>
219 <td>Classifier type of the bundle. Defaults to none.<br /></td>
220 </tr>
221 <tr class="a">
222 <td><b><a href="#file">file</a></b></td>
223 <td><tt>File</tt></td>
224 <td><tt>-</tt></td>
225 <td>Bundle file, defaults to the artifact in the local Maven
226repository.<br /></td>
227 </tr>
228 <tr class="b">
229 <td><b><a href="#groupId">groupId</a></b></td>
230 <td><tt>String</tt></td>
231 <td><tt>-</tt></td>
232 <td>GroupId of the bundle. Retrieved from POM file if specified.<br /></td>
233 </tr>
234 <tr class="a">
235 <td><b><a href="#ignoreLock">ignoreLock</a></b></td>
236 <td><tt>boolean</tt></td>
237 <td><tt>-</tt></td>
238 <td>When true, ignore remote locking.<br /></td>
239 </tr>
240 <tr class="b">
241 <td><b><a href="#obrRepository">obrRepository</a></b></td>
242 <td><tt>String</tt></td>
243 <td><tt>-</tt></td>
244 <td>Local OBR Repository.<br /></td>
245 </tr>
246 <tr class="a">
247 <td><b><a href="#obrXml">obrXml</a></b></td>
248 <td><tt>String</tt></td>
249 <td><tt>-</tt></td>
250 <td>Optional XML file describing additional requirements and
251capabilities.<br /></td>
252 </tr>
253 <tr class="b">
254 <td><b><a href="#packaging">packaging</a></b></td>
255 <td><tt>String</tt></td>
256 <td><tt>-</tt></td>
257 <td>Packaging type of the bundle. Retrieved from POM file if specified.<br /></td>
258 </tr>
259 <tr class="a">
260 <td><b><a href="#pomFile">pomFile</a></b></td>
261 <td><tt>File</tt></td>
262 <td><tt>-</tt></td>
263 <td>Location of an existing POM file.<br /></td>
264 </tr>
265 <tr class="b">
266 <td><b><a href="#remoteOBR">remoteOBR</a></b></td>
267 <td><tt>String</tt></td>
268 <td><tt>-</tt></td>
269 <td>Remote OBR Repository.<br /></td>
270 </tr>
271 <tr class="a">
272 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
273 <td><tt>List</tt></td>
274 <td><tt>-</tt></td>
275 <td>Project types which this plugin supports.<br /></td>
276 </tr>
277 <tr class="b">
278 <td><b><a href="#version">version</a></b></td>
279 <td><tt>String</tt></td>
280 <td><tt>-</tt></td>
281 <td>Version of the bundle. Retrieved from POM file if specified.<br /></td>
282 </tr>
283 </table>
284 </div>
285 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
286 <p><b><a name="artifactId">artifactId</a>:</b></p>
287 <div>ArtifactId of the bundle. Retrieved from POM file if specified.</div>
288 <ul>
289 <li><b>Type</b>: <tt>java.lang.String</tt></li>
290 <li><b>Required</b>: <tt>No</tt></li>
291 <li><b>Expression</b>: <tt>${artifactId}</tt></li>
292 </ul><hr /><p><b><a name="bundleUrl">bundleUrl</a>:</b></p>
293 <div>Optional public URL where the bundle has been deployed.</div>
294 <ul>
295 <li><b>Type</b>: <tt>java.lang.String</tt></li>
296 <li><b>Required</b>: <tt>No</tt></li>
297 <li><b>Expression</b>: <tt>${bundleUrl}</tt></li>
298 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
299 <div>Classifier type of the bundle. Defaults to none.</div>
300 <ul>
301 <li><b>Type</b>: <tt>java.lang.String</tt></li>
302 <li><b>Required</b>: <tt>No</tt></li>
303 <li><b>Expression</b>: <tt>${classifier}</tt></li>
304 </ul><hr /><p><b><a name="file">file</a>:</b></p>
305 <div>Bundle file, defaults to the artifact in the local Maven
306repository.</div>
307 <ul>
308 <li><b>Type</b>: <tt>java.io.File</tt></li>
309 <li><b>Required</b>: <tt>No</tt></li>
310 <li><b>Expression</b>: <tt>${file}</tt></li>
311 </ul><hr /><p><b><a name="groupId">groupId</a>:</b></p>
312 <div>GroupId of the bundle. Retrieved from POM file if specified.</div>
313 <ul>
314 <li><b>Type</b>: <tt>java.lang.String</tt></li>
315 <li><b>Required</b>: <tt>No</tt></li>
316 <li><b>Expression</b>: <tt>${groupId}</tt></li>
317 </ul><hr /><p><b><a name="ignoreLock">ignoreLock</a>:</b></p>
318 <div>When true, ignore remote locking.</div>
319 <ul>
320 <li><b>Type</b>: <tt>boolean</tt></li>
321 <li><b>Required</b>: <tt>No</tt></li>
322 <li><b>Expression</b>: <tt>${ignoreLock}</tt></li>
323 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
324 <div>Local OBR Repository.</div>
325 <ul>
326 <li><b>Type</b>: <tt>java.lang.String</tt></li>
327 <li><b>Required</b>: <tt>No</tt></li>
328 <li><b>Expression</b>: <tt>${obrRepository}</tt></li>
329 </ul><hr /><p><b><a name="obrXml">obrXml</a>:</b></p>
330 <div>Optional XML file describing additional requirements and
331capabilities.</div>
332 <ul>
333 <li><b>Type</b>: <tt>java.lang.String</tt></li>
334 <li><b>Required</b>: <tt>No</tt></li>
335 <li><b>Expression</b>: <tt>${obrXml}</tt></li>
336 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
337 <div>Packaging type of the bundle. Retrieved from POM file if specified.</div>
338 <ul>
339 <li><b>Type</b>: <tt>java.lang.String</tt></li>
340 <li><b>Required</b>: <tt>No</tt></li>
341 <li><b>Expression</b>: <tt>${packaging}</tt></li>
342 </ul><hr /><p><b><a name="pomFile">pomFile</a>:</b></p>
343 <div>Location of an existing POM file.</div>
344 <ul>
345 <li><b>Type</b>: <tt>java.io.File</tt></li>
346 <li><b>Required</b>: <tt>No</tt></li>
347 <li><b>Expression</b>: <tt>${pomFile}</tt></li>
348 </ul><hr /><p><b><a name="remoteOBR">remoteOBR</a>:</b></p>
349 <div>Remote OBR Repository.</div>
350 <ul>
351 <li><b>Type</b>: <tt>java.lang.String</tt></li>
352 <li><b>Required</b>: <tt>No</tt></li>
353 <li><b>Expression</b>: <tt>${remoteOBR}</tt></li>
354 </ul><hr /><p><b><a name="repositoryId">repositoryId</a>:</b></p>
355 <div>Remote repository id, used to lookup authentication settings.</div>
356 <ul>
357 <li><b>Type</b>: <tt>java.lang.String</tt></li>
358 <li><b>Required</b>: <tt>Yes</tt></li>
359 <li><b>Expression</b>: <tt>${repositoryId}</tt></li>
360 <li><b>Default</b>: <tt>remote-repository</tt></li>
361 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
362 <div>Project types which this plugin supports.</div>
363 <ul>
364 <li><b>Type</b>: <tt>java.util.List</tt></li>
365 <li><b>Required</b>: <tt>No</tt></li>
366 </ul><hr /><p><b><a name="url">url</a>:</b></p>
367 <div>Remote OBR repository URL, where the bundle details are to be
368uploaded.</div>
369 <ul>
370 <li><b>Type</b>: <tt>java.lang.String</tt></li>
371 <li><b>Required</b>: <tt>Yes</tt></li>
372 <li><b>Expression</b>: <tt>${url}</tt></li>
373 </ul><hr /><p><b><a name="version">version</a>:</b></p>
374 <div>Version of the bundle. Retrieved from POM file if specified.</div>
375 <ul>
376 <li><b>Type</b>: <tt>java.lang.String</tt></li>
377 <li><b>Required</b>: <tt>No</tt></li>
378 <li><b>Expression</b>: <tt>${version}</tt></li>
379 </ul>
380 </div>
381 </div>
382
383
384
385 </div>
386
387 </div>
388
389 <div class="clear">
390
391 <hr/>
392
393 </div>
394
395 <div id="footer">
396
397 <div class="xright">Copyright &#169; 2006-2011
398
399 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
400
401 All Rights Reserved.
402
403
404
405 </div>
406
407 <div class="clear">
408
409 <hr/>
410
411 </div>
412
413 </div>
414
415 </body>
416
417</html>
418