Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / a2b77384fd54eac7eef93affa609af6de11af029 / . / bundleplugin / doc / site / deploy-file-mojo.html
blob: 9323bae5339fdcf4e57f47deab9779c22ede3a1f [file] [log] [blame]
Stuart McCulloch55213332011-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 McCulloch8f9c4652011-11-28 16:39:12 +0000[diff] [blame]2<!-- Generated by Apache Maven Doxia at Nov 28, 2011 -->
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]4 <head>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]6 <title>Maven Bundle Plugin -
7 bundle:deploy-file</title>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]8 <style type="text/css" media="all">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]9 @import url("./css/maven-base.css");
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]10 @import url("./css/maven-theme.css");
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]11 @import url("./css/site.css");
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]12 </style>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]13 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
Stuart McCulloch8f9c4652011-11-28 16:39:12 +0000[diff] [blame]14 <meta name="Date-Revision-yyyymmdd" content="20111128" />
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]15 <meta http-equiv="Content-Language" content="en" />
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]16
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]17 </head>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]18 <body class="composite">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]19 <div id="banner">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]20 <div id="bannerLeft">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]21 Maven Bundle Plugin
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]22 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]23 <div class="clear">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]24 <hr/>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]25 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]26 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]27 <div id="breadcrumbs">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]28
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]29
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]30 <div class="xleft">
Stuart McCulloch8f9c4652011-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 McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]33 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]34 <div class="xright">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]35
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]36 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]37 <div class="clear">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]38 <hr/>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]39 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]40 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]41 <div id="leftColumn">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]42 <div id="navcolumn">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]43
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]44
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]45 <h5>Overview</h5>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]46 <ul>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]47 <li class="none">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]48 <a href="index.html" title="Introduction">Introduction</a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]49 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]50 <li class="none">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]51 <a href="plugin-info.html" title="Goals">Goals</a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]52 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]53 <li class="none">
Stuart McCulloch55213332011-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 McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]55 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]56 <li class="none">
Stuart McCulloch55213332011-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 McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]58 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]59 <li class="none">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]60 <a href="jira-report.html" title="Release Notes">Release Notes</a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]61 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]62 </ul>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]63 <h5>Project Documentation</h5>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]64 <ul>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]65 <li class="collapsed">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]66 <a href="project-info.html" title="Project Information">Project Information</a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]67 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]68 <li class="collapsed">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]69 <a href="project-reports.html" title="Project Reports">Project Reports</a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]70 </li>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]71 </ul>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]72 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]73 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]74 </a>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]75
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]76
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]77 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]78 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]79 <div id="bodyColumn">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]80 <div id="contentBox">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]81
82
83 <div class="section"><h2>bundle:deploy-file<a name="bundle:deploy-file"></a></h2>
84 <p><b>Full name</b>:</p>
Stuart McCulloch8f9c4652011-11-28 16:39:12 +0000[diff] [blame]85 <p>org.apache.felix:maven-bundle-plugin:2.4.0-SNAPSHOT:deploy-file</p>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]86 <p><b>Description</b>:</p>
87 <div>Deploys bundle details to a remote OBR repository (command-line
88goal)</div>
89 <p><b>Attributes</b>:</p>
90 <ul>
91 <li>Binds by default to the lifecycle phase: <tt>deploy</tt>.</li>
92 </ul>
93 <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
94 <table class="bodyTable" border="0">
95 <tr class="a">
96 <th>Name</th>
97 <th>Type</th>
98 <th>Since</th>
99 <th>Description</th>
100 </tr>
101 <tr class="b">
102 <td><b><a href="#repositoryId">repositoryId</a></b></td>
103 <td><tt>String</tt></td>
104 <td><tt>-</tt></td>
105 <td>Remote repository id, used to lookup authentication settings.<br /><b>Default value is</b>: <tt>remote-repository</tt>.</td>
106 </tr>
107 <tr class="a">
108 <td><b><a href="#url">url</a></b></td>
109 <td><tt>String</tt></td>
110 <td><tt>-</tt></td>
111 <td>Remote OBR repository URL, where the bundle details are to be
112uploaded.<br /></td>
113 </tr>
114 </table>
115 </div>
116 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
117 <table class="bodyTable" border="0">
118 <tr class="a">
119 <th>Name</th>
120 <th>Type</th>
121 <th>Since</th>
122 <th>Description</th>
123 </tr>
124 <tr class="b">
125 <td><b><a href="#artifactId">artifactId</a></b></td>
126 <td><tt>String</tt></td>
127 <td><tt>-</tt></td>
128 <td>ArtifactId of the bundle. Retrieved from POM file if specified.<br /></td>
129 </tr>
130 <tr class="a">
131 <td><b><a href="#bundleUrl">bundleUrl</a></b></td>
132 <td><tt>String</tt></td>
133 <td><tt>-</tt></td>
134 <td>Optional public URL where the bundle has been deployed.<br /></td>
135 </tr>
136 <tr class="b">
137 <td><b><a href="#classifier">classifier</a></b></td>
138 <td><tt>String</tt></td>
139 <td><tt>-</tt></td>
140 <td>Classifier type of the bundle. Defaults to none.<br /></td>
141 </tr>
142 <tr class="a">
143 <td><b><a href="#file">file</a></b></td>
144 <td><tt>File</tt></td>
145 <td><tt>-</tt></td>
146 <td>Bundle file, defaults to the artifact in the local Maven
147repository.<br /></td>
148 </tr>
149 <tr class="b">
150 <td><b><a href="#groupId">groupId</a></b></td>
151 <td><tt>String</tt></td>
152 <td><tt>-</tt></td>
153 <td>GroupId of the bundle. Retrieved from POM file if specified.<br /></td>
154 </tr>
155 <tr class="a">
156 <td><b><a href="#ignoreLock">ignoreLock</a></b></td>
157 <td><tt>boolean</tt></td>
158 <td><tt>-</tt></td>
159 <td>When true, ignore remote locking.<br /></td>
160 </tr>
161 <tr class="b">
162 <td><b><a href="#obrRepository">obrRepository</a></b></td>
163 <td><tt>String</tt></td>
164 <td><tt>-</tt></td>
165 <td>Local OBR Repository.<br /></td>
166 </tr>
167 <tr class="a">
168 <td><b><a href="#obrXml">obrXml</a></b></td>
169 <td><tt>String</tt></td>
170 <td><tt>-</tt></td>
171 <td>Optional XML file describing additional requirements and
172capabilities.<br /></td>
173 </tr>
174 <tr class="b">
175 <td><b><a href="#packaging">packaging</a></b></td>
176 <td><tt>String</tt></td>
177 <td><tt>-</tt></td>
178 <td>Packaging type of the bundle. Retrieved from POM file if specified.<br /></td>
179 </tr>
180 <tr class="a">
181 <td><b><a href="#pomFile">pomFile</a></b></td>
182 <td><tt>File</tt></td>
183 <td><tt>-</tt></td>
184 <td>Location of an existing POM file.<br /></td>
185 </tr>
186 <tr class="b">
187 <td><b><a href="#remoteOBR">remoteOBR</a></b></td>
188 <td><tt>String</tt></td>
189 <td><tt>-</tt></td>
190 <td>Remote OBR Repository.<br /></td>
191 </tr>
192 <tr class="a">
193 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
194 <td><tt>List</tt></td>
195 <td><tt>-</tt></td>
196 <td>Project types which this plugin supports.<br /></td>
197 </tr>
198 <tr class="b">
199 <td><b><a href="#version">version</a></b></td>
200 <td><tt>String</tt></td>
201 <td><tt>-</tt></td>
202 <td>Version of the bundle. Retrieved from POM file if specified.<br /></td>
203 </tr>
204 </table>
205 </div>
206 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
207 <p><b><a name="artifactId">artifactId</a>:</b></p>
208 <div>ArtifactId of the bundle. Retrieved from POM file if specified.</div>
209 <ul>
210 <li><b>Type</b>: <tt>java.lang.String</tt></li>
211 <li><b>Required</b>: <tt>No</tt></li>
212 <li><b>Expression</b>: <tt>${artifactId}</tt></li>
213 </ul><hr /><p><b><a name="bundleUrl">bundleUrl</a>:</b></p>
214 <div>Optional public URL where the bundle has been deployed.</div>
215 <ul>
216 <li><b>Type</b>: <tt>java.lang.String</tt></li>
217 <li><b>Required</b>: <tt>No</tt></li>
218 <li><b>Expression</b>: <tt>${bundleUrl}</tt></li>
219 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
220 <div>Classifier type of the bundle. Defaults to none.</div>
221 <ul>
222 <li><b>Type</b>: <tt>java.lang.String</tt></li>
223 <li><b>Required</b>: <tt>No</tt></li>
224 <li><b>Expression</b>: <tt>${classifier}</tt></li>
225 </ul><hr /><p><b><a name="file">file</a>:</b></p>
226 <div>Bundle file, defaults to the artifact in the local Maven
227repository.</div>
228 <ul>
229 <li><b>Type</b>: <tt>java.io.File</tt></li>
230 <li><b>Required</b>: <tt>No</tt></li>
231 <li><b>Expression</b>: <tt>${file}</tt></li>
232 </ul><hr /><p><b><a name="groupId">groupId</a>:</b></p>
233 <div>GroupId of the bundle. Retrieved from POM file if specified.</div>
234 <ul>
235 <li><b>Type</b>: <tt>java.lang.String</tt></li>
236 <li><b>Required</b>: <tt>No</tt></li>
237 <li><b>Expression</b>: <tt>${groupId}</tt></li>
238 </ul><hr /><p><b><a name="ignoreLock">ignoreLock</a>:</b></p>
239 <div>When true, ignore remote locking.</div>
240 <ul>
241 <li><b>Type</b>: <tt>boolean</tt></li>
242 <li><b>Required</b>: <tt>No</tt></li>
243 <li><b>Expression</b>: <tt>${ignoreLock}</tt></li>
244 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
245 <div>Local OBR Repository.</div>
246 <ul>
247 <li><b>Type</b>: <tt>java.lang.String</tt></li>
248 <li><b>Required</b>: <tt>No</tt></li>
249 <li><b>Expression</b>: <tt>${obrRepository}</tt></li>
250 </ul><hr /><p><b><a name="obrXml">obrXml</a>:</b></p>
251 <div>Optional XML file describing additional requirements and
252capabilities.</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>${obrXml}</tt></li>
257 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
258 <div>Packaging type of the bundle. Retrieved from POM file if specified.</div>
259 <ul>
260 <li><b>Type</b>: <tt>java.lang.String</tt></li>
261 <li><b>Required</b>: <tt>No</tt></li>
262 <li><b>Expression</b>: <tt>${packaging}</tt></li>
263 </ul><hr /><p><b><a name="pomFile">pomFile</a>:</b></p>
264 <div>Location of an existing POM file.</div>
265 <ul>
266 <li><b>Type</b>: <tt>java.io.File</tt></li>
267 <li><b>Required</b>: <tt>No</tt></li>
268 <li><b>Expression</b>: <tt>${pomFile}</tt></li>
269 </ul><hr /><p><b><a name="remoteOBR">remoteOBR</a>:</b></p>
270 <div>Remote OBR Repository.</div>
271 <ul>
272 <li><b>Type</b>: <tt>java.lang.String</tt></li>
273 <li><b>Required</b>: <tt>No</tt></li>
274 <li><b>Expression</b>: <tt>${remoteOBR}</tt></li>
275 </ul><hr /><p><b><a name="repositoryId">repositoryId</a>:</b></p>
276 <div>Remote repository id, used to lookup authentication settings.</div>
277 <ul>
278 <li><b>Type</b>: <tt>java.lang.String</tt></li>
279 <li><b>Required</b>: <tt>Yes</tt></li>
280 <li><b>Expression</b>: <tt>${repositoryId}</tt></li>
281 <li><b>Default</b>: <tt>remote-repository</tt></li>
282 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
283 <div>Project types which this plugin supports.</div>
284 <ul>
285 <li><b>Type</b>: <tt>java.util.List</tt></li>
286 <li><b>Required</b>: <tt>No</tt></li>
287 </ul><hr /><p><b><a name="url">url</a>:</b></p>
288 <div>Remote OBR repository URL, where the bundle details are to be
289uploaded.</div>
290 <ul>
291 <li><b>Type</b>: <tt>java.lang.String</tt></li>
292 <li><b>Required</b>: <tt>Yes</tt></li>
293 <li><b>Expression</b>: <tt>${url}</tt></li>
294 </ul><hr /><p><b><a name="version">version</a>:</b></p>
295 <div>Version of the bundle. Retrieved from POM file if specified.</div>
296 <ul>
297 <li><b>Type</b>: <tt>java.lang.String</tt></li>
298 <li><b>Required</b>: <tt>No</tt></li>
299 <li><b>Expression</b>: <tt>${version}</tt></li>
300 </ul>
301 </div>
302 </div>
303
304
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]305 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]306 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]307 <div class="clear">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]308 <hr/>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]309 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]310 <div id="footer">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]311 <div class="xright">Copyright &#169; 2006-2011
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]312 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]313 All Rights Reserved.
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]314
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]315 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]316 <div class="clear">
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]317 <hr/>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]318 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]319 </div>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]320 </body>
Stuart McCulloch55213332011-07-05 11:48:22 +0000[diff] [blame]321</html>