Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 8605263c6a6cfaa989fbbe7fa7dbd7d00e6022cc / . / bundleplugin / doc / site / install-file-mojo.html
blob: 1a94866a0565e1deea8776a7a0b45d54c2387944 [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:install-file</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:install-file<a name="bundle:install-file"></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:install-file</p>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]86 <p><b>Description</b>:</p>
87 <div>Installs bundle details in the local OBR repository (command-line
88goal)</div>
89 <p><b>Attributes</b>:</p>
90 <ul>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]91 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>install</tt>.</li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]92 </ul>
93 <div class="section"><h3>Optional Parameters<a name="Optional_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="#artifactId">artifactId</a></b></td>
103 <td><tt>String</tt></td>
104 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]105 <td>ArtifactId of the bundle. Retrieved from POM file if specified.<br /><b>User property is</b>: <tt>artifactId</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]106 </tr>
107 <tr class="a">
108 <td><b><a href="#classifier">classifier</a></b></td>
109 <td><tt>String</tt></td>
110 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]111 <td>Classifier type of the bundle. Defaults to none.<br /><b>User property is</b>: <tt>classifier</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]112 </tr>
113 <tr class="b">
114 <td><b><a href="#file">file</a></b></td>
115 <td><tt>File</tt></td>
116 <td><tt>-</tt></td>
117 <td>Bundle file, defaults to the artifact in the local Maven
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]118repository.<br /><b>User property is</b>: <tt>file</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]119 </tr>
120 <tr class="a">
121 <td><b><a href="#groupId">groupId</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>GroupId of the bundle. Retrieved from POM file if specified.<br /><b>User property is</b>: <tt>groupId</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>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="#obrXml">obrXml</a></b></td>
134 <td><tt>String</tt></td>
135 <td><tt>-</tt></td>
136 <td>Optional XML file describing additional requirements and
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]137capabilities.<br /><b>User property is</b>: <tt>obrXml</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]138 </tr>
139 <tr class="b">
140 <td><b><a href="#packaging">packaging</a></b></td>
141 <td><tt>String</tt></td>
142 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]143 <td>Packaging type of the bundle. Retrieved from POM file if specified.<br /><b>User property is</b>: <tt>packaging</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]144 </tr>
145 <tr class="a">
146 <td><b><a href="#pomFile">pomFile</a></b></td>
147 <td><tt>File</tt></td>
148 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]149 <td>Location of an existing POM file.<br /><b>User property is</b>: <tt>pomFile</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]150 </tr>
151 <tr class="b">
152 <td><b><a href="#supportedProjectTypes">supportedProjectTypes</a></b></td>
153 <td><tt>List</tt></td>
154 <td><tt>-</tt></td>
155 <td>Project types which this plugin supports.<br /></td>
156 </tr>
157 <tr class="a">
158 <td><b><a href="#version">version</a></b></td>
159 <td><tt>String</tt></td>
160 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]161 <td>Version of the bundle. Retrieved from POM file if specified.<br /><b>User property is</b>: <tt>version</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]162 </tr>
163 </table>
164 </div>
165 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
166 <p><b><a name="artifactId">artifactId</a>:</b></p>
167 <div>ArtifactId of the bundle. Retrieved from POM file if specified.</div>
168 <ul>
169 <li><b>Type</b>: <tt>java.lang.String</tt></li>
170 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]171 <li><b>User Property</b>: <tt>artifactId</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]172 </ul><hr /><p><b><a name="classifier">classifier</a>:</b></p>
173 <div>Classifier type of the bundle. Defaults to none.</div>
174 <ul>
175 <li><b>Type</b>: <tt>java.lang.String</tt></li>
176 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]177 <li><b>User Property</b>: <tt>classifier</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]178 </ul><hr /><p><b><a name="file">file</a>:</b></p>
179 <div>Bundle file, defaults to the artifact in the local Maven
180repository.</div>
181 <ul>
182 <li><b>Type</b>: <tt>java.io.File</tt></li>
183 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]184 <li><b>User Property</b>: <tt>file</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]185 </ul><hr /><p><b><a name="groupId">groupId</a>:</b></p>
186 <div>GroupId of the bundle. Retrieved from POM file if specified.</div>
187 <ul>
188 <li><b>Type</b>: <tt>java.lang.String</tt></li>
189 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]190 <li><b>User Property</b>: <tt>groupId</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]191 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
192 <div>OBR Repository.</div>
193 <ul>
194 <li><b>Type</b>: <tt>java.lang.String</tt></li>
195 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]196 <li><b>User Property</b>: <tt>obrRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]197 </ul><hr /><p><b><a name="obrXml">obrXml</a>:</b></p>
198 <div>Optional XML file describing additional requirements and
199capabilities.</div>
200 <ul>
201 <li><b>Type</b>: <tt>java.lang.String</tt></li>
202 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]203 <li><b>User Property</b>: <tt>obrXml</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]204 </ul><hr /><p><b><a name="packaging">packaging</a>:</b></p>
205 <div>Packaging type of the bundle. Retrieved from POM file if specified.</div>
206 <ul>
207 <li><b>Type</b>: <tt>java.lang.String</tt></li>
208 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]209 <li><b>User Property</b>: <tt>packaging</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]210 </ul><hr /><p><b><a name="pomFile">pomFile</a>:</b></p>
211 <div>Location of an existing POM file.</div>
212 <ul>
213 <li><b>Type</b>: <tt>java.io.File</tt></li>
214 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]215 <li><b>User Property</b>: <tt>pomFile</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]216 </ul><hr /><p><b><a name="supportedProjectTypes">supportedProjectTypes</a>:</b></p>
217 <div>Project types which this plugin supports.</div>
218 <ul>
219 <li><b>Type</b>: <tt>java.util.List</tt></li>
220 <li><b>Required</b>: <tt>No</tt></li>
221 </ul><hr /><p><b><a name="version">version</a>:</b></p>
222 <div>Version of the bundle. Retrieved from POM file if specified.</div>
223 <ul>
224 <li><b>Type</b>: <tt>java.lang.String</tt></li>
225 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]226 <li><b>User Property</b>: <tt>version</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]227 </ul>
228 </div>
229 </div>
230
231
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]232 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]233 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]234 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]235 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]236 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]237 <div id="footer">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000[diff] [blame]238 <div class="xright">Copyright &#169; 2006-2013
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]239 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]240 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]241
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]242 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]243 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]244 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]245 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]246 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]247 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000[diff] [blame]248</html>