Stuart McCulloch | d16db97 | 2011-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 McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame^] | 2 | <!-- Generated by Apache Maven Doxia at Nov 28, 2011 --> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 4 | <head> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 6 | <title>Maven Bundle Plugin - |
| 7 | bundle:deploy</title> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 8 | <style type="text/css" media="all"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 9 | @import url("./css/maven-base.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 10 | @import url("./css/maven-theme.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 11 | @import url("./css/site.css"); |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 12 | </style> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 13 | <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame^] | 14 | <meta name="Date-Revision-yyyymmdd" content="20111128" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 15 | <meta http-equiv="Content-Language" content="en" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 16 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 17 | </head> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 18 | <body class="composite"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 19 | <div id="banner"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 20 | <div id="bannerLeft"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 21 | Maven Bundle Plugin |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 22 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 23 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 24 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 25 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 26 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 27 | <div id="breadcrumbs"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 28 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 29 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 30 | <div class="xleft"> |
Stuart McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame^] | 31 | <span id="publishDate">Last Published: 2011-11-28</span> |
| 32 | | <span id="projectVersion">Version: 2.4.0-SNAPSHOT</span> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 33 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 34 | <div class="xright"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 35 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 36 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 37 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 38 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 39 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 40 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 41 | <div id="leftColumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 42 | <div id="navcolumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 43 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 44 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 45 | <h5>Overview</h5> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 46 | <ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 47 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 48 | <a href="index.html" title="Introduction">Introduction</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 49 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 50 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 51 | <a href="plugin-info.html" title="Goals">Goals</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 52 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 53 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 55 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 56 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 58 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 59 | <li class="none"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 60 | <a href="jira-report.html" title="Release Notes">Release Notes</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 61 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 62 | </ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 63 | <h5>Project Documentation</h5> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 64 | <ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 65 | <li class="collapsed"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 66 | <a href="project-info.html" title="Project Information">Project Information</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 67 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 68 | <li class="collapsed"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 69 | <a href="project-reports.html" title="Project Reports">Project Reports</a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 70 | </li> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 71 | </ul> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 72 | <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 73 | <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 74 | </a> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 75 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 76 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 77 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 78 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 79 | <div id="bodyColumn"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 80 | <div id="contentBox"> |
Stuart McCulloch | d16db97 | 2011-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 McCulloch | 148b7bf | 2011-11-28 16:39:12 +0000 | [diff] [blame^] | 85 | <p>org.apache.felix:maven-bundle-plugin:2.4.0-SNAPSHOT:deploy</p> |
Stuart McCulloch | d16db97 | 2011-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> |
| 92 | <li>Binds by default to the lifecycle phase: <tt>deploy</tt>.</li> |
| 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> |
| 106 | <td>Alternative deployment repository. Format: id::layout::url<br /></td> |
| 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> |
| 112 | <td>Optional public URL where the bundle has been deployed.<br /></td> |
| 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> |
| 118 | <td>When true, ignore remote locking.<br /></td> |
| 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> |
| 124 | <td>OBR specific deployment repository. Format: id::layout::url<br /></td> |
| 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> |
| 130 | <td>Local OBR Repository.<br /></td> |
| 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> |
| 136 | <td>Optional public URL prefix for the remote repository.<br /></td> |
| 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> |
| 142 | <td>Remote OBR Repository.<br /><b>Default value is</b>: <tt>NONE</tt>.</td> |
| 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> |
| 158 | <li><b>Expression</b>: <tt>${altDeploymentRepository}</tt></li> |
| 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> |
| 164 | <li><b>Expression</b>: <tt>${bundleUrl}</tt></li> |
| 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> |
| 170 | <li><b>Expression</b>: <tt>${ignoreLock}</tt></li> |
| 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> |
| 176 | <li><b>Expression</b>: <tt>${obrDeploymentRepository}</tt></li> |
| 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> |
| 182 | <li><b>Expression</b>: <tt>${obrRepository}</tt></li> |
| 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> |
| 188 | <li><b>Expression</b>: <tt>${prefixUrl}</tt></li> |
| 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> |
| 194 | <li><b>Expression</b>: <tt>${remoteOBR}</tt></li> |
| 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 McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 206 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 207 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 208 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 209 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 210 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 211 | <div id="footer"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 212 | <div class="xright">Copyright © 2006-2011 |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 213 | <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 214 | All Rights Reserved. |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 215 | |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 216 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 217 | <div class="clear"> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 218 | <hr/> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 219 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 220 | </div> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 221 | </body> |
Stuart McCulloch | d16db97 | 2011-07-05 11:48:22 +0000 | [diff] [blame] | 222 | </html> |