Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 8ddadb72b9c82c39310124489373afe8a0d57b80 / . / bundleplugin / doc / site / deploy-mojo.html
blob: a4676583c6f53d6ca2f19143c404cc48d11e4f26 [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 McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]2<!-- Generated by Apache Maven Doxia at Jun 8, 2013 -->
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:deploy</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 McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]14 <meta name="Date-Revision-yyyymmdd" content="20130608" />
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 McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]31 <span id="publishDate">Last Published: 2013-06-08</span>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +0000[diff] [blame]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:deploy<a name="bundle:deploy"></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:deploy</p>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]86 <p><b>Description</b>:</p>
87 <div>Deploys bundle details to a remote OBR repository (life-cycle goal)</div>
88 <p><b>Attributes</b>:</p>
89 <ul>
90 <li>Requires a Maven project to be executed.</li>
91 <li>The goal is thread-safe and supports parallel builds.</li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]92 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>deploy</tt>.</li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]93 </ul>
94 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
95 <table class="bodyTable" border="0">
96 <tr class="a">
97 <th>Name</th>
98 <th>Type</th>
99 <th>Since</th>
100 <th>Description</th>
101 </tr>
102 <tr class="b">
103 <td><b><a href="#altDeploymentRepository">altDeploymentRepository</a></b></td>
104 <td><tt>String</tt></td>
105 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]106 <td>Alternative deployment repository. Format: id::layout::url<br /><b>User property is</b>: <tt>altDeploymentRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]107 </tr>
108 <tr class="a">
109 <td><b><a href="#bundleUrl">bundleUrl</a></b></td>
110 <td><tt>String</tt></td>
111 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]112 <td>Optional public URL where the bundle has been deployed.<br /><b>User property is</b>: <tt>bundleUrl</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]113 </tr>
114 <tr class="b">
115 <td><b><a href="#ignoreLock">ignoreLock</a></b></td>
116 <td><tt>boolean</tt></td>
117 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]118 <td>When true, ignore remote locking.<br /><b>User property is</b>: <tt>ignoreLock</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]119 </tr>
120 <tr class="a">
121 <td><b><a href="#obrDeploymentRepository">obrDeploymentRepository</a></b></td>
122 <td><tt>String</tt></td>
123 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]124 <td>OBR specific deployment repository. Format: id::layout::url<br /><b>User property is</b>: <tt>obrDeploymentRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]125 </tr>
126 <tr class="b">
127 <td><b><a href="#obrRepository">obrRepository</a></b></td>
128 <td><tt>String</tt></td>
129 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]130 <td>Local OBR Repository.<br /><b>User property is</b>: <tt>obrRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]131 </tr>
132 <tr class="a">
133 <td><b><a href="#prefixUrl">prefixUrl</a></b></td>
134 <td><tt>String</tt></td>
135 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]136 <td>Optional public URL prefix for the remote repository.<br /><b>User property is</b>: <tt>prefixUrl</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]137 </tr>
138 <tr class="b">
139 <td><b><a href="#remoteOBR">remoteOBR</a></b></td>
140 <td><tt>String</tt></td>
141 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]142 <td>Remote OBR Repository.<br /><b>Default value is</b>: <tt>NONE</tt>.<br /><b>User property is</b>: <tt>remoteOBR</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]143 </tr>
144 <tr class="a">
145 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
146 <td><tt>List</tt></td>
147 <td><tt>-</tt></td>
148 <td>Project types which this plugin supports.<br /></td>
149 </tr>
150 </table>
151 </div>
152 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
153 <p><b><a name="altDeploymentRepository">altDeploymentRepository</a>:</b></p>
154 <div>Alternative deployment repository. Format: id::layout::url</div>
155 <ul>
156 <li><b>Type</b>: <tt>java.lang.String</tt></li>
157 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]158 <li><b>User Property</b>: <tt>altDeploymentRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]159 </ul><hr /><p><b><a name="bundleUrl">bundleUrl</a>:</b></p>
160 <div>Optional public URL where the bundle has been deployed.</div>
161 <ul>
162 <li><b>Type</b>: <tt>java.lang.String</tt></li>
163 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]164 <li><b>User Property</b>: <tt>bundleUrl</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]165 </ul><hr /><p><b><a name="ignoreLock">ignoreLock</a>:</b></p>
166 <div>When true, ignore remote locking.</div>
167 <ul>
168 <li><b>Type</b>: <tt>boolean</tt></li>
169 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]170 <li><b>User Property</b>: <tt>ignoreLock</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]171 </ul><hr /><p><b><a name="obrDeploymentRepository">obrDeploymentRepository</a>:</b></p>
172 <div>OBR specific deployment repository. Format: id::layout::url</div>
173 <ul>
174 <li><b>Type</b>: <tt>java.lang.String</tt></li>
175 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]176 <li><b>User Property</b>: <tt>obrDeploymentRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]177 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
178 <div>Local OBR Repository.</div>
179 <ul>
180 <li><b>Type</b>: <tt>java.lang.String</tt></li>
181 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]182 <li><b>User Property</b>: <tt>obrRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]183 </ul><hr /><p><b><a name="prefixUrl">prefixUrl</a>:</b></p>
184 <div>Optional public URL prefix for the remote repository.</div>
185 <ul>
186 <li><b>Type</b>: <tt>java.lang.String</tt></li>
187 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]188 <li><b>User Property</b>: <tt>prefixUrl</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]189 </ul><hr /><p><b><a name="remoteOBR">remoteOBR</a>:</b></p>
190 <div>Remote OBR Repository.</div>
191 <ul>
192 <li><b>Type</b>: <tt>java.lang.String</tt></li>
193 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]194 <li><b>User Property</b>: <tt>remoteOBR</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]195 <li><b>Default</b>: <tt>NONE</tt></li>
196 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
197 <div>Project types which this plugin supports.</div>
198 <ul>
199 <li><b>Type</b>: <tt>java.util.List</tt></li>
200 <li><b>Required</b>: <tt>No</tt></li>
201 </ul>
202 </div>
203 </div>
204
205
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]206 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]207 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]208 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]209 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]210 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]211 <div id="footer">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame^]212 <div class="xright">Copyright &#169; 2006-2013
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]213 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]214 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]215
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]216 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]217 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]218 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]219 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]220 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]221 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]222</html>