Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +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 | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 2 | <html><head><title>Apache Felix - Maven Bundle Plugin (BND)</title> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 3 | |
| 4 | |
| 5 | |
| 6 | |
| 7 | <link rel="stylesheet" href="maven-bundle-plugin-bnd_files/site.css" type="text/css" media="all"> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 8 | <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"></head><body> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 9 | <div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="maven-bundle-plugin-bnd_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="maven-bundle-plugin-bnd_files/apache.png" border="0"></a></div></div> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 10 | <div class="menu"> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 11 | <ul> |
| 12 | <li><a href="http://felix.apache.org/site/index.html" title="Index">home</a></li> |
| 13 | <li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li> |
| 14 | <li><a href="http://felix.apache.org/site/status.html" title="status">status</a></li> |
| 15 | <li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li> |
| 16 | <li><span class="nobr"><a href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></li> |
| 17 | <li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li> |
| 18 | <li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li> |
| 19 | <li><span class="nobr"><a href="http://cwiki.apache.org/confluence/x/O-" title="Visit page outside Confluence" rel="nofollow">wiki<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></li> |
| 20 | <li><a href="http://felix.apache.org/site/committers.html" title="committers">committers</a></li> |
| 21 | <li><a href="http://felix.apache.org/site/faq.html" title="faq">faq</a></li> |
| 22 | <li><a href="http://felix.apache.org/site/roadmap.html" title="roadmap">roadmap</a></li> |
| 23 | <li><a href="http://felix.apache.org/site/sourcecode.html" title="sourcecode">source code</a></li> |
| 24 | <li><a href="http://felix.apache.org/site/codingstandards.html" title="codingstandards">coding standards</a></li> |
| 25 | <li><a href="http://felix.apache.org/site/issuetracking.html" title="issuetracking">issue tracking</a></li> |
| 26 | <li><a href="http://felix.apache.org/site/dependencies.html" title="dependencies">dependencies</a></li> |
| 27 | <li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">apache software foundation<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></li> |
| 28 | <li><span class="nobr"><a href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></li> |
| 29 | <li><span class="nobr"><a href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span></li> |
| 30 | </ul> </div> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 31 | <div class="main"> |
| 32 | <h1><a name="MavenBundlePlugin(BND)-BundlePluginforMaven"></a>Bundle Plugin for Maven</h1> |
| 33 | |
| 34 | <p>This plugin for Maven 2 is based on the <span class="nobr"><a href="http://www.aqute.biz/Code/Bnd" title="Visit page outside Confluence" rel="nofollow">BND<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span> |
| 35 | tool from Peter Kriens. The way BND works is by treating your project |
| 36 | as a big collection of classes (e.g., project code, dependencies, and |
| 37 | the class path). The way you create a bundle with BND is to tell it the |
| 38 | content of the bundle's JAR file as a subset of the available classes. |
| 39 | This plugin wraps BND to make it work specifically with the Maven 2 |
| 40 | project structure and to provide it with reasonable default behavior |
| 41 | for Maven 2 projects.</p> |
| 42 | |
| 43 | <p><a name="MavenBundlePlugin(BND)-simpleexample"></a></p> |
| 44 | |
| 45 | <h1><a name="MavenBundlePlugin(BND)-SimpleExample"></a>Simple Example</h1> |
| 46 | |
| 47 | <p>Rather than going straight to a detailed list of plugin features, we |
| 48 | will first look at a simple example of how to use the plugin to give an |
| 49 | immediate flavor. A detailed "<a href="#MavenBundlePlugin%2528BND%2529-howto" title="how-to on Maven Bundle Plugin (BND)">how to</a>" will follow.</p> |
| 50 | |
| 51 | <p>Assume that we have a simple bundle project that has a pubic API package an several implementation packages, such as:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 52 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 53 | <div class="preformatted"><div class="preformattedContent"> |
| 54 | <pre>org.foo.myproject.api |
| 55 | org.foo.myproject.impl1 |
| 56 | org.foo.myproject.impl2 |
| 57 | ... |
| 58 | </pre> |
| 59 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 60 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 61 | <p>If we also assume that we have a bundle activator in one of the implementation packages, then the <tt><plugins></tt> section of the POM file for this bundle project would look like this:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 62 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 63 | <div class="preformatted"><div class="preformattedContent"> |
| 64 | <pre>... |
| 65 | <plugins> |
| 66 | <plugin> |
| 67 | <groupId>org.apache.felix</groupId> |
| 68 | <artifactId>maven-bundle-plugin</artifactId> |
| 69 | <extensions>true</extensions> |
| 70 | <configuration> |
| 71 | <instructions> |
| 72 | <Export-Package>org.foo.myproject.api</Export-Package> |
| 73 | <Private-Package>org.foo.myproject.*</Private-Package> |
| 74 | <Bundle-Activator>org.foo.myproject.impl1.Activator</Bundle-Activator> |
| 75 | </instructions> |
| 76 | </configuration> |
| 77 | </plugin> |
| 78 | </plugins> |
| 79 | ... |
| 80 | </pre> |
| 81 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 82 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 83 | <p>The <tt><Export-Package></tt> and <tt><Private-Package></tt> instructions tell the plugin about the contents of the resulting bundle JAR file. The <tt><Export-Package></tt> instruction tells the plugin which of the available packages to copy into the bundle <b>and</b> export, while the <tt><Private-Package></tt> instruction indicates which of the available packages to copy into the bundle <b>but not</b> |
| 84 | export. If the two sets overlap, as they do in the case, then the |
| 85 | export takes precedence. Since we did not specify any values for any |
| 86 | other bundle manifest headers, they will assume default values which |
| 87 | are described <a href="#MavenBundlePlugin%2528BND%2529-defaultbehavior" title="default-behavior on Maven Bundle Plugin (BND)">below</a>. One specific behavior to highlight is that the plugin generates the <tt>Import-Package</tt> |
| 88 | bundle manifest header based on the contents of the bundle, which means |
| 89 | that you generally do not ever need to explicitly specify it yourself. |
| 90 | That's it.</p> |
| 91 | |
| 92 | <h1><a name="MavenBundlePlugin(BND)-Features"></a>Features</h1> |
| 93 | |
| 94 | <p>The BND library underlying the plugin defines instructions to direct |
| 95 | its behavior. For this Maven plugin, these instructions are issued in |
| 96 | the plugin configuration section of the POM file, as was illustrated <a href="#MavenBundlePlugin%2528BND%2529-simpleexample" title="simple-example on Maven Bundle Plugin (BND)">above</a>. BND recognizes three types of instructions:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 97 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 98 | <ol> |
| 99 | <li><em>Manifest headers</em> - Any instruction that starts with |
| 100 | a capital letter will appear in the resulting bundle's manifest file; |
| 101 | the value for the header will either be copied, augmented, or generated |
| 102 | by BND depending on the instruction.</li> |
| 103 | <li><em>Variables</em> - Any instruction starting with a lowercase letter is assumed to be a variable in the form of a name-value pair, such as <tt>version=3.0</tt>, that can be used for property substitution, but is not copied to the manifest.</li> |
| 104 | <li><em>Directives</em> |
| 105 | - Any instruction starting with a '-' character is considered to be a |
| 106 | directive that informs BND to perform some special processing and is |
| 107 | not copied to the manifest.</li> |
| 108 | </ol> |
| 109 | |
| 110 | |
| 111 | <p>The remainder of this section covers the most important aspects of BND's instructions; for complete details refer to the <span class="nobr"><a href="http://www.aqute.biz/Code/Bnd" title="Visit page outside Confluence" rel="nofollow">BND documentation<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p> |
| 112 | |
| 113 | <p><a name="MavenBundlePlugin(BND)-instructions"></a></p> |
| 114 | |
| 115 | <h2><a name="MavenBundlePlugin(BND)-Instructions"></a>Instructions</h2> |
| 116 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 117 | <h3><a name="MavenBundlePlugin(BND)-{{<ExportPackage>}}"></a><tt><Export-Package></tt></h3> |
| 118 | |
| 119 | <p>The <tt><Export-Package></tt> instruction is a list of |
| 120 | packages for the bundle to export. These packages are copied into the |
| 121 | resulting bundle JAR file from the available classes (i.e., project |
| 122 | classes, dependencies, and class path); thus, it is possible to include |
| 123 | classes into your bundle that are not associated with source files in |
| 124 | your project. <tt><Export-Package></tt> can be specified with |
| 125 | package patterns using the '*' wildcard. Also, it is possible to |
| 126 | exclude packages using negation by starting the package pattern with |
| 127 | '!'. Thus, non-negated patterns indicate which of the available |
| 128 | packages to include in the bundle, whereas negated patterns indicate |
| 129 | which should not be included in the bundle.</p> |
| 130 | |
| 131 | <p>The list of package patterns is ordered and earlier patterns are applied before later patterns. For example, if you specify "<tt>org.foo.*,!org.foo.impl</tt>" the second pattern has no effect since all <tt>org.foo</tt> packages have already been selected by the first pattern. Instead, you should specify "<tt>!org.foo.impl,org.foo.*</tt>", which will export all <tt>org.foo</tt> packages except <tt>org.foo.impl</tt>.</p> |
| 132 | |
| 133 | <p>Following standard OSGi R4 syntax, package patterns can include both |
| 134 | directives and attributes, which will be copied appropriately into the |
| 135 | generated Export-Package manifest header. Besides explicitly listing |
| 136 | package version attributes, BND will also determine package versions by |
| 137 | examining the source JAR file or from <tt>packageinfo</tt> files in the package directory.</p> |
| 138 | |
| 139 | <h3><a name="MavenBundlePlugin(BND)-{{<PrivatePackage>}}"></a><tt><Private-Package></tt></h3> |
| 140 | |
| 141 | <p>The <tt><Private-Package></tt> instruction is similar in every way to the <tt><Export-Package></tt> instruction, except for the fact that these packages will <b>not</b> |
| 142 | be exported by the bundle. If a package is selected by both the export |
| 143 | and private package headers, then the export takes precedence.</p> |
| 144 | |
| 145 | <h3><a name="MavenBundlePlugin(BND)-{{<IncludeResource>}}"></a><tt><Include-Resource></tt></h3> |
| 146 | |
| 147 | <p>The <tt><Include-Resource></tt> instruction is a list of |
| 148 | arbitrary resources that should be copied into the bundle JAR file. The |
| 149 | specified resources are declared as clauses that can have the following |
| 150 | forms:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 151 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 152 | <div class="preformatted"><div class="preformattedContent"> |
| 153 | <pre>clause ::= assignment | inline | simple |
| 154 | assignment ::= PATH '=' PATH |
| 155 | simple ::= PATH |
| 156 | inline ::= '@' PATH |
| 157 | </pre> |
| 158 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 159 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 160 | <p>For the <tt><Include-Resource></tt> instruction, actual file paths are relative to the <tt>pom.xml</tt>, while file copy destinations are relative to the root of the resulting bundle JAR file. In the case of <tt>assignment</tt> or <tt>simple</tt> forms, the <tt>PATH</tt> parameter can point to a file or directory. The <tt>simple</tt> |
| 161 | form will place the resource in the bundle JAR with only the file name, |
| 162 | i.e., without any path component. For example, including <tt>src/main/resources/a/b.c</tt> will result in a resource <tt>b.c</tt> in the root of the bundle JAR. If the <tt>PATH</tt> |
| 163 | points to a directory, the entire directory hierarchy is copied into |
| 164 | the resulting bundle JAR file relative to the specified directory. If a |
| 165 | specific resource must be placed into a subdirectory of the bundle jar, |
| 166 | then use the <tt>assignment</tt> form, where the first path is the the |
| 167 | destination path (including file name if the resource is a file) and |
| 168 | the second path is the resource to copy. The <tt>inline</tt> form requires a ZIP or JAR file, which will be completely expanded in the bundle JAR.</p> |
| 169 | |
| 170 | <p>If a resource clause is specified inside of "{ ... }" brackets, then |
| 171 | variable substitution will be performed on the resource, where |
| 172 | variables in the resources are denoted with "${ ... }" syntax.</p> |
| 173 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 174 | <p>By default the bundle plugin converts the project's Maven resource directories into a single <tt><Include-Resource></tt> instruction. If you specify your own <tt><Include-Resource></tt> instruction, this will replace the generated one. To include the generated list of Maven resources in your own <tt><Include-Resource></tt> instruction just add {<tt>maven-resources</tt>} to the list and it will be expanded automatically.</p> |
| 175 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 176 | <h3><a name="MavenBundlePlugin(BND)-{{<ImportPackage>}}"></a><tt><Import-Package></tt></h3> |
| 177 | |
| 178 | <p>The <tt><Import-Package></tt> instruction is a list of |
| 179 | packages that are required by the bundle's contained packages. The |
| 180 | default for this header is "*", resulting in importing all referred |
| 181 | packages. This header rarely has to be explicitly specified. However, |
| 182 | in certain cases when there is an unwanted import, such an import can |
| 183 | be removed by using a negation package pattern. The package patterns |
| 184 | work in the same way as for <tt><Export-Package></tt>, which means they are ordered. For example, if you wanted to import all packages except <tt>org.foo.impl</tt> you would specify "<tt>!org.foo.impl,*</tt>"</p> |
| 185 | |
| 186 | <p><a name="MavenBundlePlugin(BND)-defaultbehavior"></a></p> |
| 187 | |
| 188 | <h2><a name="MavenBundlePlugin(BND)-DefaultBehavior"></a>Default Behavior</h2> |
| 189 | |
| 190 | <p>To use this plugin, very little information is required by BND. As |
| 191 | part of the Maven integration, the plugin tries to set reasonable |
| 192 | defaults for various instructions. For example:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 193 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 194 | <ul> |
| 195 | <li><tt><Bundle-SymbolicName></tt> is assumed to be "<tt>${groupId}.${artifactId</tt>}".</li> |
| 196 | <li><tt><Export-Package></tt> is assumed to be "<tt>${groupId}.${artifactId}.*</tt>", unless <tt><Private-Package></tt> is specified, then <tt><Export-Package></tt> is assumed to be empty.</li> |
| 197 | <li><tt><Private-Package></tt> is assumed to be empty by default.</li> |
| 198 | <li><tt><Import-Package></tt> is assumed to be "<tt>*</tt>", which imports everything referred to by the bundle content, but not contained in the bundle.</li> |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 199 | <li><tt><Include-Resource></tt> is generated from the project's Maven resources, typically "<tt>src/main/resources/</tt>", |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 200 | which will copy the specified project directory hierarchy into the |
| 201 | resulting bundle JAR file, mirroring standard Maven behavior.</li> |
| 202 | <li><tt><Bundle-Version></tt> is assumed to be "<tt>${pom.version</tt>}" with '-' character separator of the qualifier replaced with a '.' character.</li> |
| 203 | <li><tt><Bundle-Name></tt> is assumed to be "<tt>${pom.name</tt>}".</li> |
| 204 | <li><tt><Bundle-Description></tt> is assumed to be "<tt>${pom.description</tt>}".</li> |
| 205 | <li><tt><Bundle-License></tt> is assumed to be "<tt>${pom.licenses</tt>}".</li> |
| 206 | <li><tt><Bundle-Vendor></tt> is assumed to be "<tt>${pom.organization.name</tt>}".</li> |
| 207 | <li><tt><Bundle-DocURL></tt> is assumed to be "<tt>${pom.organization.url</tt>}".</li> |
| 208 | </ul> |
| 209 | |
| 210 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 211 | <p>Since the plugin creates bundles for OSGi R4, it hard-codes <tt>Bundle-ManifestVersion</tt> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 212 | to be '2'. Additionally, it generates imports for every export to |
| 213 | ensure package substitutability, which is very important when working |
| 214 | with collaborating services. It is possible to override any of these |
| 215 | values (except <tt>Bundle-ManifestVersion</tt>) just by specifying the desired value in the plugin configuration section of the POM file.</p> |
| 216 | |
| 217 | <p><a name="MavenBundlePlugin(BND)-howto"></a></p> |
| 218 | |
| 219 | <h1><a name="MavenBundlePlugin(BND)-Detailed"HowTo""></a>Detailed "How To"</h1> |
| 220 | |
| 221 | <h2><a name="MavenBundlePlugin(BND)-GetMaven2"></a>Get Maven2</h2> |
| 222 | |
| 223 | <p>The first step in the process of using the plugin is downloading and |
| 224 | installing the latest version of the Maven2 runtime. The latest Maven2 |
| 225 | release and instuctions for getting started with Maven2 can be found at |
| 226 | the <span class="nobr"><a href="http://maven.apache.org/index.html" title="Visit page outside Confluence" rel="nofollow">Maven website<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p> |
| 227 | |
| 228 | <h2><a name="MavenBundlePlugin(BND)-UsingthePlugin"></a>Using the Plugin</h2> |
| 229 | |
| 230 | <p>To use the maven-bundle-plugin, you first need to add the plugin and |
| 231 | some appropriate plugin configuration to your bundle project's POM. |
| 232 | Below is an example of a simple OSGi bundle POM for Maven2:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 233 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 234 | <div class="preformatted"><div class="preformattedContent"> |
| 235 | <pre><project> |
| 236 | <modelVersion>4.0.0</modelVersion> |
| 237 | <groupId>my-osgi-bundles</groupId> |
| 238 | <artifactId>examplebundle</artifactId> |
| 239 | <packaging>bundle</packaging> <!-- (1) --> |
| 240 | <version>1.0</version> |
| 241 | <name>Example Bundle</name> |
| 242 | <dependencies> |
| 243 | <dependency> |
| 244 | <groupId>org.apache.felix</groupId> |
| 245 | <artifactId>org.osgi.core</artifactId> |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 246 | <version>1.0.0</version> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 247 | </dependency> |
| 248 | </dependencies> |
| 249 | <build> |
| 250 | <plugins> |
| 251 | <plugin> <!-- (2) START --> |
| 252 | <groupId>org.apache.felix</groupId> |
| 253 | <artifactId>maven-bundle-plugin</artifactId> |
| 254 | <extensions>true</extensions> |
| 255 | <configuration> |
| 256 | <instructions> |
| 257 | <Export-Package>com.my.company.api</Export-Package> |
| 258 | <Private-Package>com.my.company.*</Private-Package> |
| 259 | <Bundle-Activator>com.my.company.Activator</Bundle-Activator> |
| 260 | </instructions> |
| 261 | </configuration> |
| 262 | </plugin> <!-- (2) END --> |
| 263 | </plugins> |
| 264 | </build> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 265 | </project> |
| 266 | </pre> |
| 267 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 268 | |
| 269 | <p>There are two main things to note: (1) the <tt><packaging></tt> |
| 270 | specifier must be "bundle" and (2) the plugin and configuration must be |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 271 | specified (the configuration section is where you will issue |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 272 | instructions to the plugin).</p> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 273 | |
| 274 | <h2><a name="MavenBundlePlugin(BND)-RealWorldExample"></a>Real-World Example</h2> |
| 275 | |
| 276 | <p>Consider this more real-world example using Felix' Log Service |
| 277 | implementation. The Log Service project is comprised of a single |
| 278 | package: <tt>org.apache.felix.log.impl</tt>. It has a dependency on |
| 279 | the core OSGi interfaces as well as a dependency on the compendium OSGi |
| 280 | interfaces for the specific log service interfaces. The following is |
| 281 | its POM file:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 282 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 283 | <div class="preformatted"><div class="preformattedContent"> |
| 284 | <pre><project> |
| 285 | <modelVersion>4.0.0</modelVersion> |
| 286 | <groupId>org.apache.felix</groupId> |
| 287 | <artifactId>org.apache.felix.log</artifactId> |
| 288 | <packaging>bundle</packaging> |
| 289 | <name>Apache Felix Log Service</name> |
| 290 | <version>0.8.0-SNAPSHOT</version> |
| 291 | <description> |
| 292 | This bundle provides an implementation of the OSGi R4 Log service. |
| 293 | </description> |
| 294 | <dependencies> |
| 295 | <dependency> |
| 296 | <groupId>${pom.groupId}</groupId> |
| 297 | <artifactId>org.osgi.core</artifactId> |
| 298 | <version>0.8.0-incubator</version> |
| 299 | </dependency> |
| 300 | <dependency> |
| 301 | <groupId>${pom.groupId}</groupId> |
| 302 | <artifactId>org.osgi.compendium</artifactId> |
| 303 | <version>0.9.0-incubator-SNAPSHOT</version> |
| 304 | </dependency> |
| 305 | </dependencies> |
| 306 | <build> |
| 307 | <plugins> |
| 308 | <plugin> |
| 309 | <groupId>org.apache.felix</groupId> |
| 310 | <artifactId>maven-bundle-plugin</artifactId> |
| 311 | <extensions>true</extensions> |
| 312 | <configuration> |
| 313 | <instructions> |
| 314 | <Export-Package>org.osgi.service.log</Export-Package> |
| 315 | <Private-Package>org.apache.felix.log.impl</Private-Package> |
| 316 | <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName> |
| 317 | <Bundle-Activator>${pom.artifactId}.impl.Activator</Bundle-Activator> |
| 318 | <Export-Service>org.osgi.service.log.LogService,org.osgi.service.log.LogReaderService</Export-Service> |
| 319 | </instructions> |
| 320 | </configuration> |
| 321 | </plugin> |
| 322 | </plugins> |
| 323 | </build> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 324 | </project> |
| 325 | </pre> |
| 326 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 327 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 328 | <p>Notice that the <tt><Export-Package></tt> instruction |
| 329 | specifies that the bundle exports the Log Service package, even though |
| 330 | this package is not contained in the bundle project. By declaring this, |
| 331 | the plugin will copy the Log Service package into the resulting bundle |
| 332 | JAR file. This is useful in this case because now the bundle can |
| 333 | resolve without having to download the entire compendium bundle. The |
| 334 | resulting manifest for the Log Service bundle looks like this (notice |
| 335 | how the imports/exports automatically have version information |
| 336 | associated with them, which was obtained from packageinfo files in the |
| 337 | source packages):</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 338 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 339 | <div class="preformatted"><div class="preformattedContent"> |
| 340 | <pre>Manifest-Version: 1 |
| 341 | Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt |
| 342 | Bundle-Activator: org.apache.felix.log.impl.Activator |
| 343 | Import-Package: org.osgi.framework;version=1.3, org.osgi.service.log;v |
| 344 | ersion=1.3 |
| 345 | Include-Resource: src/main/resources |
| 346 | Export-Package: org.osgi.service.log;uses:=org.osgi.framework;version= |
| 347 | 1.3 |
| 348 | Bundle-Version: 0.8.0.SNAPSHOT |
| 349 | Bundle-Name: Apache Felix Log Service |
| 350 | Bundle-Description: This bundle provides an implementation of the OSGi |
| 351 | R4 Log service. |
| 352 | Private-Package: org.apache.felix.log.impl |
| 353 | Bundle-ManifestVersion: 2 |
| 354 | Export-Service: org.osgi.service.log.LogService,org.osgi.service.log.L |
| 355 | ogReaderService |
| 356 | Bundle-SymbolicName: org.apache.felix.log |
| 357 | </pre> |
| 358 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 359 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 360 | <p>The resulting bundle JAR file has the following content (notice how |
| 361 | the LICENSE and NOTICE files were automatically copied from the <tt>src/main/resources/</tt> directory of the project):</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 362 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 363 | <div class="preformatted"><div class="preformattedContent"> |
| 364 | <pre>META-INF/MANIFEST.MF |
| 365 | LICENSE |
| 366 | META-INF/ |
| 367 | META-INF/maven/ |
| 368 | META-INF/maven/org.apache.felix/ |
| 369 | META-INF/maven/org.apache.felix/org.apache.felix.log/ |
| 370 | META-INF/maven/org.apache.felix/org.apache.felix.log/pom.properties |
| 371 | META-INF/maven/org.apache.felix/org.apache.felix.log/pom.xml |
| 372 | NOTICE |
| 373 | org/ |
| 374 | org/apache/ |
| 375 | org/apache/felix/ |
| 376 | org/apache/felix/log/ |
| 377 | org/apache/felix/log/impl/ |
| 378 | org/apache/felix/log/impl/Activator.class |
| 379 | org/apache/felix/log/impl/Log.class |
| 380 | org/apache/felix/log/impl/LogEntryImpl.class |
| 381 | org/apache/felix/log/impl/LogException.class |
| 382 | org/apache/felix/log/impl/LogListenerThread.class |
| 383 | org/apache/felix/log/impl/LogNode.class |
| 384 | org/apache/felix/log/impl/LogNodeEnumeration.class |
| 385 | org/apache/felix/log/impl/LogReaderServiceFactory.class |
| 386 | org/apache/felix/log/impl/LogReaderServiceImpl.class |
| 387 | org/apache/felix/log/impl/LogServiceFactory.class |
| 388 | org/apache/felix/log/impl/LogServiceImpl.class |
| 389 | org/osgi/ |
| 390 | org/osgi/service/ |
| 391 | org/osgi/service/log/ |
| 392 | org/osgi/service/log/LogEntry.class |
| 393 | org/osgi/service/log/LogListener.class |
| 394 | org/osgi/service/log/LogReaderService.class |
| 395 | org/osgi/service/log/LogService.class |
| 396 | org/osgi/service/log/package.html |
| 397 | org/osgi/service/log/packageinfo |
| 398 | </pre> |
| 399 | </div></div> |
| 400 | |
| 401 | <h2><a name="MavenBundlePlugin(BND)-BuildingthePlugin"></a>Building the Plugin</h2> |
| 402 | |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 403 | <p>The plugin is hosted at the Apache Felix project. The following |
| 404 | steps describe how to build and install the plugin into your local |
| 405 | Maven2 repository.</p> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 406 | |
| 407 | <p>Using the SVN client of your choice, checkout the maven-bundle-plugin project.</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 408 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 409 | <div class="preformatted"><div class="preformattedContent"> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 410 | <pre>$ svn co http://svn.apache.org/repos/asf/felix/trunk/bundleplugin |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 411 | </pre> |
| 412 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 413 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 414 | <p>Using Maven2, build and install the maven-bundle-plugin by issuing |
| 415 | the following Maven2 command in the project directory that was created |
| 416 | as a result of the previous step.</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 417 | |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 418 | <div class="preformatted"><div class="preformattedContent"> |
| 419 | <pre>$ mvn install |
| 420 | </pre> |
| 421 | </div></div> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 422 | |
| 423 | <h1><a name="MavenBundlePlugin(BND)-Goals"></a>Goals</h1> |
| 424 | |
| 425 | <p>The maven-bundle-plugin also provides additional functionality via |
| 426 | some Maven goals. Command-line execution of a goal is performed as |
| 427 | follows:</p> |
| 428 | |
| 429 | <div class="preformatted"><div class="preformattedContent"> |
| 430 | <pre>mvn org.apache.felix:maven-bundle-plugin:GOAL |
| 431 | </pre> |
| 432 | </div></div> |
| 433 | |
| 434 | <p>Where GOAL is one of the following:</p> |
| 435 | |
| 436 | <ul> |
| 437 | <li><tt>bundle</tt> - build an OSGi bundle jar<br> |
| 438 | configuration options: |
| 439 | <ul> |
| 440 | <li><tt>manifestLocation</tt> defaults to ${project.build.outputDirectory}/META-INF</li> |
| 441 | <li><tt>unpackBundle</tt> unpack bundle contents to output directory, defaults to false</li> |
| 442 | <li><tt>supportedProjectTypes</tt> defaults to "jar","bundle"</li> |
| 443 | </ul> |
| 444 | </li> |
| 445 | <li><tt>bundleall</tt> - build an OSGi bundle jar for all transitive dependencies<br> |
| 446 | configuration options: |
| 447 | <ul> |
| 448 | <li><tt>supportedProjectTypes</tt> defaults to "jar","bundle"</li> |
| 449 | </ul> |
| 450 | </li> |
| 451 | <li><tt>wrap</tt> - as above, but limited to the first level of dependencies<br> |
| 452 | configuration options: |
| 453 | <ul> |
| 454 | <li><tt>supportedProjectTypes</tt> defaults to "jar","bundle"</li> |
| 455 | </ul> |
| 456 | </li> |
| 457 | <li><tt>manifest</tt> - create an OSGi manifest for the current project<br> |
| 458 | configuration options: |
| 459 | <ul> |
| 460 | <li><tt>manifestLocation</tt> defaults to ${project.build.outputDirectory}/META-INF</li> |
| 461 | <li><tt>supportedProjectTypes</tt> defaults to "jar","bundle"</li> |
| 462 | </ul> |
| 463 | </li> |
| 464 | </ul> |
| 465 | |
| 466 | |
| 467 | <p>There are also new instructions available from the underlying BND |
| 468 | tool, which continues to be improved independently; for the latest see <span class="nobr"><a href="http://aqute.biz/Code/Bnd" title="Visit page outside Confluence" rel="nofollow">BND documentation<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p> |
| 469 | |
| 470 | <p>The default goal <tt>bundle</tt> will be initialized by setting the <packaging> entry to "bundle".</p> |
| 471 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 472 | <h1><a name="MavenBundlePlugin(BND)-Thefollowingfeaturesareonlyavailableinthe1.1.0SNAPSHOTversion"></a>The following features are only available in the 1.1.0-SNAPSHOT version</h1> |
| 473 | |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 474 | <h1><a name="MavenBundlePlugin(BND)-Embeddingdependencies"></a>Embedding dependencies</h1> |
| 475 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 476 | <p>The Maven Bundle Plugin supports embedding of selected project dependencies inside the bundle by using the <tt><Embed-Dependency></tt> instruction:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 477 | |
| 478 | <div class="code"><div class="codeContent"> |
| 479 | <pre class="code-xml"><span class="code-tag"><Embed-Dependency></span>dependencies<span class="code-tag"></Embed-Dependency></span></pre> |
| 480 | </div></div> |
| 481 | |
| 482 | <p>where:</p> |
| 483 | |
| 484 | <div class="preformatted"><div class="preformattedContent"> |
| 485 | <pre>dependencies ::= clause ( ',' clause ) * |
| 486 | clause ::= MATCH ( ';' attr '=' MATCH | ';inline=true' ) |
| 487 | attr ::= 'groupId' | 'artifactId' | 'version' | 'scope' | 'type' | 'classifier' |
| 488 | MATCH ::= <globbed regular expressions> |
| 489 | </pre> |
| 490 | </div></div> |
| 491 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 492 | <p>The plugin uses the <tt><Embed-Dependency></tt> instruction to transform the project dependencies into <tt><Include-Resource></tt> and <tt><Bundle-ClassPath></tt> clauses, which are then appended to the current set of instructions and passed onto BND.</p> |
| 493 | |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 494 | <p>some examples:</p> |
| 495 | |
| 496 | <div class="code"><div class="codeContent"> |
| 497 | <pre class="code-xml"><span class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime<span class="code-tag"></Embed-Dependency></span> |
| 498 | |
| 499 | <span class="code-tag"><Embed-Dependency></span>junit;scope=test<span class="code-tag"></Embed-Dependency></span> |
| 500 | |
| 501 | <span class="code-tag"><Embed-Dependency></span>aopalliance;scope=!test;inline=true<span class="code-tag"></Embed-Dependency></span></pre> |
| 502 | </div></div> |
| 503 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 504 | <p>By default matched dependencies are embedded in the bundle as <tt>artifactId-version.jar</tt>. This behaviour can be modified using the following instructions:</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 505 | |
| 506 | <ul> |
| 507 | <li><tt><Embed-StripVersion>true</Embed-StripVersion></tt> - removes the version from the file (ie. <em>artifactId.jar</em>)</li> |
| 508 | <li><tt><Embed-StripGroup>false</Embed-StripGroup></tt> - adds the groupId as a subdirectory (ie. <em>groupId/artifactId-version.jar</em>)</li> |
| 509 | <li><tt><Embed-Directory>directory</Embed-Directory></tt> - adds a subdirectory (ie. <em>directory/artifactId-version.jar</em>)</li> |
| 510 | </ul> |
| 511 | |
| 512 | |
| 513 | <p>Normally the plugin only checks direct dependencies, but this can be |
| 514 | changed to include the complete set of transitive dependencies with the |
| 515 | following option:</p> |
| 516 | |
| 517 | <div class="code"><div class="codeContent"> |
| 518 | <pre class="code-xml"><span class="code-tag"><Embed-Transitive></span>true<span class="code-tag"></Embed-Transitive></span></pre> |
| 519 | </div></div> |
| 520 | |
| 521 | <p>If you want a dependency inlined instead of embedded add the <tt>inline=true</tt>. For example to inline all <em>compile</em> and <em>runtime</em> scoped dependencies use:</p> |
| 522 | |
| 523 | <div class="code"><div class="codeContent"> |
| 524 | <pre class="code-xml"><span class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime;inline=true<span class="code-tag"></Embed-Dependency></span></pre> |
| 525 | </div></div> |
| 526 | |
Stuart McCulloch | 7c961f5 | 2008-01-02 08:56:07 +0000 | [diff] [blame] | 527 | <h2><a name="MavenBundlePlugin(BND)-EmbedDependencyandExportPackage"></a>Embed-Dependency and Export-Package</h2> |
| 528 | |
| 529 | <p>If you embed a dependency with <tt><Embed-Dependency></tt>, and your <tt><Export-Package></tt> or <tt><Private-Package></tt> instructions match packages inside the embedded jar, you will see some duplication inside the bundle. This is because the <tt><Export-Package></tt> and <tt><Private-Package></tt> |
| 530 | instructions will result in classes being inlined in the bundle, even |
| 531 | though they also exist inside the embedded jar. If you want to export |
| 532 | packages from an embedded dependency without such duplication then you |
| 533 | can either inline the dependency, or use a new BND instruction called <tt><_exportcontents></tt>.</p> |
| 534 | |
| 535 | <p><tt><_exportcontents></tt> behaves just like Export-Package, except it doesn't change the content of the bundle, just what content should be exported.</p> |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 536 | |
| 537 | <h1><a name="MavenBundlePlugin(BND)-OBRintegration"></a>OBR integration</h1> |
| 538 | |
| 539 | <p>The latest Maven Bundle Plugin automatically updates the local OBR |
| 540 | repository.xml file during the install phase, using a default location |
| 541 | of:</p> |
| 542 | |
| 543 | <div class="code"><div class="codeContent"> |
| 544 | <pre class="code-java"><LOCAL-MAVEN-REPOSITORY>/repository.xml</pre> |
| 545 | </div></div> |
| 546 | |
| 547 | <p>You can configure the location of the OBR repository by using the command line:</p> |
| 548 | |
| 549 | <div class="code"><div class="codeContent"> |
| 550 | <pre class="code-java">mvn clean install -DobrRepository=<PATH_TO_OBR></pre> |
| 551 | </div></div> |
| 552 | |
| 553 | <p>or in the configuration section for the maven-bundle-plugin in your Maven POM:</p> |
| 554 | |
| 555 | <div class="code"><div class="codeContent"> |
| 556 | <pre class="code-xml"><span class="code-tag"><groupId></span>org.apache.felix<span class="code-tag"></groupId></span> |
| 557 | <span class="code-tag"><artifactId></span>maven-bundle-plugin<span class="code-tag"></artifactId></span> |
| 558 | <span class="code-tag"><extensions></span>true<span class="code-tag"></extensions></span> |
| 559 | <span class="code-tag"><configuration></span> |
| 560 | <span class="code-tag"><obrRepository></span>PATH_TO_OBR<span class="code-tag"></obrRepository></span> |
| 561 | <span class="code-tag"><instructions></span> |
| 562 | <span class="code-tag"><span class="code-comment"><!-- bnd instructions --></span></span> |
| 563 | <span class="code-tag"></instructions></span> |
| 564 | <span class="code-tag"></configuration></span></pre> |
| 565 | </div></div> |
| 566 | |
| 567 | <p>to disable OBR installation set the obrRepository to NONE, for example:</p> |
| 568 | |
| 569 | <div class="code"><div class="codeContent"> |
| 570 | <pre class="code-xml"><span class="code-tag"><groupId></span>org.apache.felix<span class="code-tag"></groupId></span> |
| 571 | <span class="code-tag"><artifactId></span>maven-bundle-plugin<span class="code-tag"></artifactId></span> |
| 572 | <span class="code-tag"><extensions></span>true<span class="code-tag"></extensions></span> |
| 573 | <span class="code-tag"><configuration></span> |
| 574 | <span class="code-tag"><obrRepository></span>NONE<span class="code-tag"></obrRepository></span> |
| 575 | <span class="code-tag"><instructions></span> |
| 576 | <span class="code-tag"><span class="code-comment"><!-- bnd instructions --></span></span> |
| 577 | <span class="code-tag"></instructions></span> |
| 578 | <span class="code-tag"></configuration></span></pre> |
| 579 | </div></div> |
| 580 | |
| 581 | |
| 582 | <h1><a name="MavenBundlePlugin(BND)-Eclipse/PDEintegration"></a>Eclipse/PDE integration</h1> |
| 583 | |
| 584 | <p>It is possible to configure the Maven Bundle Plugin to put the |
| 585 | bundle manifest where Eclipse/PDE expects it, and use the Maven |
| 586 | Dependency Plugin to arrange for any embedded dependencies to appear in |
| 587 | a local directory that matches the Bundle-ClassPath entries. Here is an |
| 588 | example POM that does this:</p> |
| 589 | |
| 590 | <div class="preformatted"><div class="preformattedContent"> |
| 591 | <pre><project> |
| 592 | |
| 593 | <properties> |
| 594 | <bundle.symbolicName>org.example</bundle.symbolicName> |
| 595 | <bundle.namespace>org.example</bundle.namespace> |
| 596 | </properties> |
| 597 | |
| 598 | <modelVersion>4.0.0</modelVersion> |
| 599 | <groupId>examples</groupId> |
| 600 | <artifactId>org.example</artifactId> |
| 601 | <version>1.0-SNAPSHOT</version> |
| 602 | |
| 603 | <name>${bundle.symbolicName} [${bundle.namespace}]</name> |
| 604 | |
| 605 | <packaging>bundle</packaging> |
| 606 | |
| 607 | <build> |
| 608 | <plugins> |
| 609 | <plugin> |
| 610 | <groupId>org.apache.felix</groupId> |
| 611 | <artifactId>maven-bundle-plugin</artifactId> |
| 612 | <version>1.1.0-SNAPSHOT</version> |
| 613 | <extensions>true</extensions> |
| 614 | <!-- |
| 615 | the following instructions build a simple set of public/private classes into an OSGi bundle |
| 616 | --> |
| 617 | <configuration> |
| 618 | <manifestLocation>META-INF</manifestLocation> |
| 619 | <instructions> |
| 620 | <Bundle-SymbolicName>${bundle.symbolicName}</Bundle-SymbolicName> |
| 621 | <Bundle-Version>${pom.version}</Bundle-Version> |
| 622 | <!-- |
| 623 | assume public classes are in the top package, and private classes are under ".internal" |
| 624 | --> |
| 625 | <Export-Package>${bundle.namespace};version="${pom.version}"</Export-Package> |
| 626 | <Private-Package>${bundle.namespace}.internal</Private-Package> |
| 627 | <Bundle-Activator>${bundle.namespace}.internal.Activator</Bundle-Activator> |
| 628 | <!-- |
| 629 | embed compile/runtime dependencies using path that matches the copied dependency folder |
| 630 | --> |
| 631 | <Embed-Dependency>*;scope=compile|runtime;inline=false</Embed-Dependency> |
| 632 | <Embed-Directory>target/dependency</Embed-Directory> |
| 633 | <Embed-StripGroup>true</Embed-StripGroup> |
| 634 | </instructions> |
| 635 | </configuration> |
| 636 | </plugin> |
| 637 | <plugin> |
| 638 | <artifactId>maven-dependency-plugin</artifactId> |
| 639 | <executions> |
| 640 | <execution> |
| 641 | <id>copy-dependencies</id> |
| 642 | <phase>package</phase> |
| 643 | <goals> |
| 644 | <goal>copy-dependencies</goal> |
| 645 | </goals> |
| 646 | </execution> |
| 647 | </executions> |
| 648 | </plugin> |
| 649 | </plugins> |
| 650 | </build> |
| 651 | |
| 652 | <dependencies> |
| 653 | <dependency> |
| 654 | <groupId>org.osgi</groupId> |
| 655 | <artifactId>osgi_R4_core</artifactId> |
| 656 | <version>1.0</version> |
| 657 | <scope>provided</scope> |
| 658 | <optional>true</optional> |
| 659 | </dependency> |
| 660 | <dependency> |
| 661 | <groupId>org.osgi</groupId> |
| 662 | <artifactId>osgi_R4_compendium</artifactId> |
| 663 | <version>1.0</version> |
| 664 | <scope>provided</scope> |
| 665 | <optional>true</optional> |
| 666 | </dependency> |
| 667 | <dependency> |
| 668 | <groupId>junit</groupId> |
| 669 | <artifactId>junit</artifactId> |
| 670 | <version>3.8.1</version> |
| 671 | <scope>compile</scope> |
| 672 | <optional>true</optional> |
| 673 | </dependency> |
| 674 | </dependencies> |
| 675 | |
| 676 | </project> |
| 677 | </pre> |
| 678 | </div></div> |
| 679 | |
| 680 | <p>To generate the Eclipse metadata use:</p> |
| 681 | |
| 682 | <div class="code"><div class="codeContent"> |
| 683 | <pre class="code-java">mvn clean <span class="code-keyword">package</span> eclipse:eclipse -Declipse.pde install</pre> |
| 684 | </div></div> |
| 685 | |
| 686 | <p>and you should now be able to import this as an existing Eclipse project.</p> |
| 687 | |
| 688 | <p>FYI: the above POM was generated using the <tt>pax-create-bundle</tt> command from <span class="nobr"><a href="http://www.ops4j.org/projects/pax/construct/index.html" title="Visit page outside Confluence" rel="nofollow">Pax-Construct<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle" border="0" height="7" width="7"></sup></a></span> and then tweaked to demonstrate using the Maven Dependency Plugin to handle embedded jars in Eclipse.</p> |
| 689 | |
| 690 | <p>With the original Pax-Construct generated POM you would simply use:</p> |
| 691 | |
| 692 | <div class="code"><div class="codeContent"> |
| 693 | <pre class="code-java">mvn clean <span class="code-keyword">package</span> pax:eclipse</pre> |
| 694 | </div></div> |
| 695 | |
| 696 | <p>to create the appropriate Eclipse files and manifest, and also |
| 697 | handle any embedded entries. The pax:eclipse goal extends |
| 698 | eclipse:eclipse, and supports the same parameters.</p> |
| 699 | |
| 700 | <h1><a name="MavenBundlePlugin(BND)-Unpackingbundlecontentsto'target/classes'"></a>Unpacking bundle contents to 'target/classes'</h1> |
| 701 | |
| 702 | <p>Once in a while you may create a bundle which contains additional classes to the ones compiled from <tt>src/main/java</tt>, |
| 703 | for example when you embed the classes from another jar. This can |
| 704 | sometimes cause unforeseen problems in Maven, as it will use the output |
| 705 | directory (<tt>target/classes</tt>) rather than the final bundle, when compiling against projects in the same reactor (ie. the same build).</p> |
| 706 | |
| 707 | <p>The easiest way to get around this Maven 'feature' is to unpack the |
| 708 | contents of the bundle to the output directory after the packaging |
| 709 | step, so the additional classes will be found where Maven expects them. |
| 710 | Thankfully there is now an easy option to do this in the bundle-plugin:</p> |
| 711 | |
| 712 | <div class="code"><div class="codeContent"> |
| 713 | <pre class="code-java"><groupId>org.apache.felix</groupId> |
| 714 | <artifactId>maven-bundle-plugin</artifactId> |
| 715 | <extensions><span class="code-keyword">true</span></extensions> |
| 716 | <configuration> |
| 717 | <unpackBundle><span class="code-keyword">true</span></unpackBundle> |
| 718 | <instructions> |
| 719 | <!-- bnd instructions --> |
| 720 | </instructions> |
| 721 | </configuration></pre> |
| 722 | </div></div> |
| 723 | |
| 724 | <h1><a name="MavenBundlePlugin(BND)-UsinganexistingMANIFEST.MFfile"></a>Using an existing MANIFEST.MF file</h1> |
| 725 | |
| 726 | <p>If you have an existing manifest, you can add this to the Bnd instructions, like so:</p> |
| 727 | |
| 728 | <div class="code"><div class="codeContent"> |
| 729 | <pre class="code-java"><_include>src/main/resources/META-INF/MANIFEST.MF</_include> |
| 730 | <Export-Package>org.example.*</Export-Package></pre> |
| 731 | </div></div> |
| 732 | |
| 733 | <p>Bnd will use it when calculating the bundle contents, and will also |
| 734 | copy across all manifest attributes starting with a capital letter.<br> |
| 735 | As shown in the above example, you could use this to include a non-OSGi |
| 736 | manifest which you then customize with extra OSGi attributes.</p> |
| 737 | |
| 738 | <h1><a name="MavenBundlePlugin(BND)-Feedback"></a>Feedback</h1> |
| 739 | |
| 740 | <p>Subscribe to the Felix users mailing list by sending a message to <span class="nobr"><a href="mailto:users-subscribe@felix.apache.org" title="Send mail to users-subscribe@felix.apache.org" rel="nofollow">users-subscribe@felix.apache.org<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/mail_small.gif" alt="" align="absmiddle" border="0" height="12" width="13"></sup></a></span>; after subscribing, email questions or feedback to <span class="nobr"><a href="mailto:users@felix.apache.org" title="Send mail to users@felix.apache.org" rel="nofollow">users@felix.apache.org<sup><img class="rendericon" src="maven-bundle-plugin-bnd_files/mail_small.gif" alt="" align="absmiddle" border="0" height="12" width="13"></sup></a></span>.</p> |
Karl Pauls | f87ac14 | 2007-07-06 22:36:17 +0000 | [diff] [blame] | 741 | </div> |
| 742 | |
Stuart McCulloch | 93de649 | 2007-12-16 15:59:05 +0000 | [diff] [blame] | 743 | </body></html> |