blob: aaad96cefbdc8b7333362c7a0f044cc5e4703bc4 [file] [log] [blame]
Stuart McCullochd16db972011-07-05 11:48:22 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +00002<!-- Generated by Apache Maven Doxia at Jun 20, 2014 -->
Stuart McCullochd16db972011-07-05 11:48:22 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
Stuart McCullochd16db972011-07-05 11:48:22 +00004 <head>
Stuart McCullochd16db972011-07-05 11:48:22 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Stuart McCullochd16db972011-07-05 11:48:22 +00006 <title>Maven Bundle Plugin -
7 bundle:deploy</title>
Stuart McCullochd16db972011-07-05 11:48:22 +00008 <style type="text/css" media="all">
Stuart McCullochd16db972011-07-05 11:48:22 +00009 @import url("./css/maven-base.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000010 @import url("./css/maven-theme.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000011 @import url("./css/site.css");
Stuart McCullochd16db972011-07-05 11:48:22 +000012 </style>
Stuart McCullochd16db972011-07-05 11:48:22 +000013 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000014 <meta name="Date-Revision-yyyymmdd" content="20140620" />
Stuart McCullochd16db972011-07-05 11:48:22 +000015 <meta http-equiv="Content-Language" content="en" />
Stuart McCullochd16db972011-07-05 11:48:22 +000016
Stuart McCullochd16db972011-07-05 11:48:22 +000017 </head>
Stuart McCullochd16db972011-07-05 11:48:22 +000018 <body class="composite">
Stuart McCullochd16db972011-07-05 11:48:22 +000019 <div id="banner">
Stuart McCullochd16db972011-07-05 11:48:22 +000020 <div id="bannerLeft">
Stuart McCullochd16db972011-07-05 11:48:22 +000021 Maven Bundle Plugin
Stuart McCullochd16db972011-07-05 11:48:22 +000022 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000023 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000024 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000025 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000026 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000027 <div id="breadcrumbs">
Stuart McCullochd16db972011-07-05 11:48:22 +000028
Stuart McCullochd16db972011-07-05 11:48:22 +000029
Stuart McCullochd16db972011-07-05 11:48:22 +000030 <div class="xleft">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000031 <span id="publishDate">Last Published: 2014-06-20</span>
32 &nbsp;| <span id="projectVersion">Version: 2.5.0</span>
Stuart McCullochd16db972011-07-05 11:48:22 +000033 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000034 <div class="xright">
Stuart McCullochd16db972011-07-05 11:48:22 +000035
Stuart McCullochd16db972011-07-05 11:48:22 +000036 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000037 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +000038 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +000039 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000040 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000041 <div id="leftColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000042 <div id="navcolumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000043
Stuart McCullochd16db972011-07-05 11:48:22 +000044
Stuart McCullochd16db972011-07-05 11:48:22 +000045 <h5>Overview</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000046 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000047 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000048 <a href="index.html" title="Introduction">Introduction</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000049 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000050 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000051 <a href="plugin-info.html" title="Goals">Goals</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000052 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000053 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000054 <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 +000055 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000056 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000057 <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 +000058 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000059 <li class="none">
Stuart McCullochd16db972011-07-05 11:48:22 +000060 <a href="jira-report.html" title="Release Notes">Release Notes</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000061 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000062 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000063 <h5>Project Documentation</h5>
Stuart McCullochd16db972011-07-05 11:48:22 +000064 <ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000065 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000066 <a href="project-info.html" title="Project Information">Project Information</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000067 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000068 <li class="collapsed">
Stuart McCullochd16db972011-07-05 11:48:22 +000069 <a href="project-reports.html" title="Project Reports">Project Reports</a>
Stuart McCullochd16db972011-07-05 11:48:22 +000070 </li>
Stuart McCullochd16db972011-07-05 11:48:22 +000071 </ul>
Stuart McCullochd16db972011-07-05 11:48:22 +000072 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
Stuart McCullochd16db972011-07-05 11:48:22 +000073 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
Stuart McCullochd16db972011-07-05 11:48:22 +000074 </a>
Stuart McCullochd16db972011-07-05 11:48:22 +000075
Stuart McCullochd16db972011-07-05 11:48:22 +000076
Stuart McCullochd16db972011-07-05 11:48:22 +000077 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000078 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +000079 <div id="bodyColumn">
Stuart McCullochd16db972011-07-05 11:48:22 +000080 <div id="contentBox">
Stuart McCullochd16db972011-07-05 11:48:22 +000081
82
83 <div class="section"><h2>bundle:deploy<a name="bundle:deploy"></a></h2>
84 <p><b>Full name</b>:</p>
Stuart McCulloch68b7ef72014-06-20 11:11:41 +000085 <p>org.apache.felix:maven-bundle-plugin:2.5.0:deploy</p>
Stuart McCullochd16db972011-07-05 11:48:22 +000086 <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 +000092 <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 +000093 </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 +0000106 <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 +0000107 </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 +0000112 <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 +0000113 </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 +0000118 <td>When true, ignore remote locking.<br /><b>User property is</b>: <tt>ignoreLock</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000119 </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 +0000124 <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 +0000125 </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 +0000130 <td>Local OBR Repository.<br /><b>User property is</b>: <tt>obrRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000131 </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 +0000136 <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 +0000137 </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 +0000142 <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 +0000143 </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 +0000158 <li><b>User Property</b>: <tt>altDeploymentRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000159 </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 +0000164 <li><b>User Property</b>: <tt>bundleUrl</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000165 </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 +0000170 <li><b>User Property</b>: <tt>ignoreLock</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000171 </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 +0000176 <li><b>User Property</b>: <tt>obrDeploymentRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000177 </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 +0000182 <li><b>User Property</b>: <tt>obrRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000183 </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 +0000188 <li><b>User Property</b>: <tt>prefixUrl</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000189 </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 +0000194 <li><b>User Property</b>: <tt>remoteOBR</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000195 <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 +0000206 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000207 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000208 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000209 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000210 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000211 <div id="footer">
Stuart McCulloch68b7ef72014-06-20 11:11:41 +0000212 <div class="xright">Copyright &#169; 2006-2014
Stuart McCullochd16db972011-07-05 11:48:22 +0000213 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000214 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000215
Stuart McCullochd16db972011-07-05 11:48:22 +0000216 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000217 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000218 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000219 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000220 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000221 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000222</html>