blob: 6aa60505fbade67f10e4ae872936006549683058 [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 McCulloch8ddadb72013-06-07 23:25:18 +00002<!-- Generated by Apache Maven Doxia at Jun 8, 2013 -->
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:index</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 McCulloch8ddadb72013-06-07 23:25:18 +000014 <meta name="Date-Revision-yyyymmdd" content="20130608" />
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 McCulloch8ddadb72013-06-07 23:25:18 +000031 <span id="publishDate">Last Published: 2013-06-08</span>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +000032 &nbsp;| <span id="projectVersion">Version: 2.4.0-SNAPSHOT</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:index<a name="bundle:index"></a></h2>
84 <p><b>Full name</b>:</p>
Stuart McCulloch148b7bf2011-11-28 16:39:12 +000085 <p>org.apache.felix:maven-bundle-plugin:2.4.0-SNAPSHOT:index</p>
Stuart McCullochd16db972011-07-05 11:48:22 +000086 <p><b>Description</b>:</p>
87 <div>Index the content of a maven repository using OBR</div>
88 <p><b>Attributes</b>:</p>
89 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
90 <table class="bodyTable" border="0">
91 <tr class="a">
92 <th>Name</th>
93 <th>Type</th>
94 <th>Since</th>
95 <th>Description</th>
96 </tr>
97 <tr class="b">
98 <td><b><a href="#mavenRepository">mavenRepository</a></b></td>
99 <td><tt>String</tt></td>
100 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000101 <td>The repository to index<br /><b>User property is</b>: <tt>mavenRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000102 </tr>
103 <tr class="a">
104 <td><b><a href="#obrRepository">obrRepository</a></b></td>
105 <td><tt>String</tt></td>
106 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000107 <td>OBR Repository.<br /><b>User property is</b>: <tt>obrRepository</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000108 </tr>
109 <tr class="b">
110 <td><b><a href="#urlTemplate">urlTemplate</a></b></td>
111 <td><tt>String</tt></td>
112 <td><tt>-</tt></td>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000113 <td>Template for urls<br /><b>User property is</b>: <tt>urlTemplate</tt>.</td>
Stuart McCullochd16db972011-07-05 11:48:22 +0000114 </tr>
115 </table>
116 </div>
117 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
118 <p><b><a name="mavenRepository">mavenRepository</a>:</b></p>
119 <div>The repository to index</div>
120 <ul>
121 <li><b>Type</b>: <tt>java.lang.String</tt></li>
122 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000123 <li><b>User Property</b>: <tt>mavenRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000124 </ul><hr /><p><b><a name="obrRepository">obrRepository</a>:</b></p>
125 <div>OBR Repository.</div>
126 <ul>
127 <li><b>Type</b>: <tt>java.lang.String</tt></li>
128 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000129 <li><b>User Property</b>: <tt>obrRepository</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000130 </ul><hr /><p><b><a name="urlTemplate">urlTemplate</a>:</b></p>
131 <div>Template for urls</div>
132 <ul>
133 <li><b>Type</b>: <tt>java.lang.String</tt></li>
134 <li><b>Required</b>: <tt>No</tt></li>
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000135 <li><b>User Property</b>: <tt>urlTemplate</tt></li>
Stuart McCullochd16db972011-07-05 11:48:22 +0000136 </ul>
137 </div>
138 </div>
139
140
Stuart McCullochd16db972011-07-05 11:48:22 +0000141 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000142 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000143 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000144 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000145 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000146 <div id="footer">
Stuart McCulloch8ddadb72013-06-07 23:25:18 +0000147 <div class="xright">Copyright &#169; 2006-2013
Stuart McCullochd16db972011-07-05 11:48:22 +0000148 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
Stuart McCullochd16db972011-07-05 11:48:22 +0000149 All Rights Reserved.
Stuart McCullochd16db972011-07-05 11:48:22 +0000150
Stuart McCullochd16db972011-07-05 11:48:22 +0000151 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000152 <div class="clear">
Stuart McCullochd16db972011-07-05 11:48:22 +0000153 <hr/>
Stuart McCullochd16db972011-07-05 11:48:22 +0000154 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000155 </div>
Stuart McCullochd16db972011-07-05 11:48:22 +0000156 </body>
Stuart McCullochd16db972011-07-05 11:48:22 +0000157</html>