Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / d16db971a0c0e5d5dca00769fa441ae41fab4ee2 / . / bundleplugin / doc / site / deploy-mojo.html
blob: faff7d88e4d3a39fa7ceaea10a3268c41bfe8d2d [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</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<a name="bundle:deploy"></a></h2>
163 <p><b>Full name</b>:</p>
164 <p>org.apache.felix:maven-bundle-plugin:2.3.5:deploy</p>
165 <p><b>Description</b>:</p>
166 <div>Deploys bundle details to a remote OBR repository (life-cycle goal)</div>
167 <p><b>Attributes</b>:</p>
168 <ul>
169 <li>Requires a Maven project to be executed.</li>
170 <li>The goal is thread-safe and supports parallel builds.</li>
171 <li>Binds by default to the lifecycle phase: <tt>deploy</tt>.</li>
172 </ul>
173 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
174 <table class="bodyTable" border="0">
175 <tr class="a">
176 <th>Name</th>
177 <th>Type</th>
178 <th>Since</th>
179 <th>Description</th>
180 </tr>
181 <tr class="b">
182 <td><b><a href="#altDeploymentRepository">altDeploymentRepository</a></b></td>
183 <td><tt>String</tt></td>
184 <td><tt>-</tt></td>
185 <td>Alternative deployment repository. Format: id::layout::url<br /></td>
186 </tr>
187 <tr class="a">
188 <td><b><a href="#bundleUrl">bundleUrl</a></b></td>
189 <td><tt>String</tt></td>
190 <td><tt>-</tt></td>
191 <td>Optional public URL where the bundle has been deployed.<br /></td>
192 </tr>
193 <tr class="b">
194 <td><b><a href="#ignoreLock">ignoreLock</a></b></td>
195 <td><tt>boolean</tt></td>
196 <td><tt>-</tt></td>
197 <td>When true, ignore remote locking.<br /></td>
198 </tr>
199 <tr class="a">
200 <td><b><a href="#obrDeploymentRepository">obrDeploymentRepository</a></b></td>
201 <td><tt>String</tt></td>
202 <td><tt>-</tt></td>
203 <td>OBR specific deployment repository. Format: id::layout::url<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>Local OBR Repository.<br /></td>
210 </tr>
211 <tr class="a">
212 <td><b><a href="#prefixUrl">prefixUrl</a></b></td>
213 <td><tt>String</tt></td>
214 <td><tt>-</tt></td>
215 <td>Optional public URL prefix for the remote repository.<br /></td>
216 </tr>
217 <tr class="b">
218 <td><b><a href="#remoteOBR">remoteOBR</a></b></td>
219 <td><tt>String</tt></td>
220 <td><tt>-</tt></td>
221 <td>Remote OBR Repository.<br /><b>Default value is</b>: <tt>NONE</tt>.</td>
222 </tr>
223 <tr class="a">
224 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
225 <td><tt>List</tt></td>
226 <td><tt>-</tt></td>
227 <td>Project types which this plugin supports.<br /></td>
228 </tr>
229 </table>
230 </div>
231 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
232 <p><b><a name="altDeploymentRepository">altDeploymentRepository</a>:</b></p>
233 <div>Alternative deployment repository. Format: id::layout::url</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>${altDeploymentRepository}</tt></li>
238 </ul><hr /><p><b><a name="bundleUrl">bundleUrl</a>:</b></p>
239 <div>Optional public URL where the bundle has been deployed.</div>
240 <ul>
241 <li><b>Type</b>: <tt>java.lang.String</tt></li>
242 <li><b>Required</b>: <tt>No</tt></li>
243 <li><b>Expression</b>: <tt>${bundleUrl}</tt></li>
244 </ul><hr /><p><b><a name="ignoreLock">ignoreLock</a>:</b></p>
245 <div>When true, ignore remote locking.</div>
246 <ul>
247 <li><b>Type</b>: <tt>boolean</tt></li>
248 <li><b>Required</b>: <tt>No</tt></li>
249 <li><b>Expression</b>: <tt>${ignoreLock}</tt></li>
250 </ul><hr /><p><b><a name="obrDeploymentRepository">obrDeploymentRepository</a>:</b></p>
251 <div>OBR specific deployment repository. Format: id::layout::url</div>
252 <ul>
253 <li><b>Type</b>: <tt>java.lang.String</tt></li>
254 <li><b>Required</b>: <tt>No</tt></li>
255 <li><b>Expression</b>: <tt>${obrDeploymentRepository}</tt></li>
256 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
257 <div>Local OBR Repository.</div>
258 <ul>
259 <li><b>Type</b>: <tt>java.lang.String</tt></li>
260 <li><b>Required</b>: <tt>No</tt></li>
261 <li><b>Expression</b>: <tt>${obrRepository}</tt></li>
262 </ul><hr /><p><b><a name="prefixUrl">prefixUrl</a>:</b></p>
263 <div>Optional public URL prefix for the remote repository.</div>
264 <ul>
265 <li><b>Type</b>: <tt>java.lang.String</tt></li>
266 <li><b>Required</b>: <tt>No</tt></li>
267 <li><b>Expression</b>: <tt>${prefixUrl}</tt></li>
268 </ul><hr /><p><b><a name="remoteOBR">remoteOBR</a>:</b></p>
269 <div>Remote OBR Repository.</div>
270 <ul>
271 <li><b>Type</b>: <tt>java.lang.String</tt></li>
272 <li><b>Required</b>: <tt>No</tt></li>
273 <li><b>Expression</b>: <tt>${remoteOBR}</tt></li>
274 <li><b>Default</b>: <tt>NONE</tt></li>
275 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
276 <div>Project types which this plugin supports.</div>
277 <ul>
278 <li><b>Type</b>: <tt>java.util.List</tt></li>
279 <li><b>Required</b>: <tt>No</tt></li>
280 </ul>
281 </div>
282 </div>
283
284
285
286 </div>
287
288 </div>
289
290 <div class="clear">
291
292 <hr/>
293
294 </div>
295
296 <div id="footer">
297
298 <div class="xright">Copyright &#169; 2006-2011
299
300 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
301
302 All Rights Reserved.
303
304
305
306 </div>
307
308 <div class="clear">
309
310 <hr/>
311
312 </div>
313
314 </div>
315
316 </body>
317
318</html>
319