Author: mcculls
Date: Sun Dec 16 07:59:05 2007
New Revision: 604640
URL: http://svn.apache.org/viewvc?rev=604640&view=rev
Log:
Refresh bundleplugin documentation (from main website)
Added:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/apache.png
(with props)
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/logo.png (with
props)
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/mail_small.gif
(with props)
Removed:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/apache-felix-small.png
Modified:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/site.css
Modified: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html?rev=604640&r1=604639&r2=604640&view=diff
==============================================================================
--- felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html (original)
+++ felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html Sun Dec 16
07:59:05 2007
@@ -1,33 +1,33 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html><head><title>Apache Felix</title>
+<html><head><title>Apache Felix - Maven Bundle Plugin (BND)</title>
<link rel="stylesheet" href="maven-bundle-plugin-bnd_files/site.css"
type="text/css" media="all">
- <link rel="stylesheet" href="maven-bundle-plugin-bnd_files/print.html"
type="text/css" media="print">
<meta http-equiv="Content-Type"
content="text/html;charset=UTF-8"></head><body>
- <div class="title">
- <img alt="Logo"
src="maven-bundle-plugin-bnd_files/apache-felix-small.png" align="right">
- </div>
+ <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>
<div class="menu">
- <ul>
- <li><a href="http://cwiki.apache.org/FELIX/index.html";>home</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/news.html";>news</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/status.html";>status</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/license.html";>license</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/downloads.html";>downloads</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/documentation.html";>documentation</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/committers.html";>committers</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/mailinglists.html";>mailing
lists</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/faq.html";>faq</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/roadmap.html";>roadmap</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/sourcecode.html";>source
code</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/codingstandards.html";>coding
standards</a></li>
- <li><a href="http://cwiki.apache.org/FELIX/issuetracking.html";>issue
tracking</a></li>
- <li><a
href="http://cwiki.apache.org/FELIX/dependencies.html";>dependencies</a></li>
- </ul>
- </div>
+<ul>
+ <li><a href="http://felix.apache.org/site/index.html";
title="Index">home</a></li>
+ <li><a href="http://felix.apache.org/site/news.html";
title="news">news</a></li>
+ <li><a href="http://felix.apache.org/site/status.html";
title="status">status</a></li>
+ <li><a href="http://felix.apache.org/site/license.html";
title="license">license</a></li>
+ <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>
+ <li><a href="http://felix.apache.org/site/documentation.html";
title="documentation">documentation</a></li>
+ <li><a href="http://felix.apache.org/site/mailinglists.html";
title="mailinglists">mailing lists</a></li>
+ <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>
+ <li><a href="http://felix.apache.org/site/committers.html";
title="committers">committers</a></li>
+ <li><a href="http://felix.apache.org/site/faq.html";
title="faq">faq</a></li>
+ <li><a href="http://felix.apache.org/site/roadmap.html";
title="roadmap">roadmap</a></li>
+ <li><a href="http://felix.apache.org/site/sourcecode.html";
title="sourcecode">source code</a></li>
+ <li><a href="http://felix.apache.org/site/codingstandards.html";
title="codingstandards">coding standards</a></li>
+ <li><a href="http://felix.apache.org/site/issuetracking.html";
title="issuetracking">issue tracking</a></li>
+ <li><a href="http://felix.apache.org/site/dependencies.html";
title="dependencies">dependencies</a></li>
+ <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>
+ <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>
+ <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>
+</ul> </div>
<div class="main">
<h1><a name="MavenBundlePlugin(BND)-BundlePluginforMaven"></a>Bundle Plugin
for Maven</h1>
@@ -49,6 +49,7 @@
immediate flavor. A detailed "<a href="#MavenBundlePlugin%2528BND%2529-howto"
title="how-to on Maven Bundle Plugin (BND)">how to</a>" will follow.</p>
<p>Assume that we have a simple bundle project that has a pubic API package an
several implementation packages, such as:</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre>org.foo.myproject.api
org.foo.myproject.impl1
@@ -56,7 +57,9 @@
...
</pre>
</div></div>
+
<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>
+
<div class="preformatted"><div class="preformattedContent">
<pre>...
<plugins>
@@ -76,6 +79,7 @@
...
</pre>
</div></div>
+
<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>
export. If the two sets overlap, as they do in the case, then the
export takes precedence. Since we did not specify any values for any
@@ -90,6 +94,7 @@
<p>The BND library underlying the plugin defines instructions to direct
its behavior. For this Maven plugin, these instructions are issued in
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>
+
<ol>
<li><em>Manifest headers</em> - Any instruction that starts with
a capital letter will appear in the resulting bundle's manifest file;
@@ -109,7 +114,6 @@
<h2><a name="MavenBundlePlugin(BND)-Instructions"></a>Instructions</h2>
-
<h3><a
name="MavenBundlePlugin(BND)-{{<ExportPackage>}}"></a><tt><Export-Package></tt></h3>
<p>The <tt><Export-Package></tt> instruction is a list of
@@ -144,6 +148,7 @@
arbitrary resources that should be copied into the bundle JAR file. The
specified resources are declared as clauses that can have the following
forms:</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre>clause ::= assignment | inline | simple
assignment ::= PATH '=' PATH
@@ -151,6 +156,7 @@
inline ::= '@' PATH
</pre>
</div></div>
+
<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>
form will place the resource in the bundle JAR with only the file name,
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>
@@ -182,6 +188,7 @@
<p>To use this plugin, very little information is required by BND. As
part of the Maven integration, the plugin tries to set reasonable
defaults for various instructions. For example:</p>
+
<ul>
<li><tt><Bundle-SymbolicName></tt> is assumed to be
"<tt>${groupId}.${artifactId</tt>}".</li>
<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>
@@ -221,6 +228,7 @@
<p>To use the maven-bundle-plugin, you first need to add the plugin and
some appropriate plugin configuration to your bundle project's POM.
Below is an example of a simple OSGi bundle POM for Maven2:</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre><project>
<modelVersion>4.0.0</modelVersion>
@@ -252,28 +260,14 @@
</plugin> <!-- (2) END -->
</plugins>
</build>
- <repositories>
- <repository> <!-- (3) START -->
- <id>apache.m2.incubator</id>
- <name>Apache M2 Incubator Repository</name>
-
<url>http://people.apache.org/repo/m2-incubating-repository/</url>
- </repository> <!-- (3) END -->
- </repositories>
- <pluginRepositories>
- <pluginRepository> <!-- (4) START -->
- <id>apache.m2.incubator</id>
- <name>Apache M2 Incubator Repository</name>
-
<url>http://people.apache.org/repo/m2-incubating-repository/</url>
- </pluginRepository> <!-- (4) END -->
- </pluginRepositories>
</project>
</pre>
</div></div>
-<p>There are four main things to note: (1) the <tt><packaging></tt>
-specifier must be "bundle", (2) the plugin and configuration must be
+
+<p>There are two main things to note: (1) the <tt><packaging></tt>
+specifier must be "bundle" and (2) the plugin and configuration must be
specified (the configuration section is where you will issue
-instructions to the plugin), and the snapshot repository to resolve
-dependencies (3) and plugins (4).</p>
+instructions to the plugin).</p>
<h2><a name="MavenBundlePlugin(BND)-RealWorldExample"></a>Real-World
Example</h2>
@@ -283,6 +277,7 @@
the core OSGi interfaces as well as a dependency on the compendium OSGi
interfaces for the specific log service interfaces. The following is
its POM file:</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre><project>
<modelVersion>4.0.0</modelVersion>
@@ -324,23 +319,10 @@
</plugin>
</plugins>
</build>
- <repositories>
- <repository>
- <id>apache.m2.incubator</id>
- <name>Apache M2 Incubator Repository</name>
-
<url>http://people.apache.org/repo/m2-incubating-repository/</url>
- </repository>
- </repositories>
- <pluginRepositories>
- <pluginRepository>
- <id>apache.m2.incubator</id>
- <name>Apache M2 Incubator Repository</name>
-
<url>http://people.apache.org/repo/m2-incubating-repository/</url>
- </pluginRepository>
- </pluginRepositories>
</project>
</pre>
</div></div>
+
<p>Notice that the <tt><Export-Package></tt> instruction
specifies that the bundle exports the Log Service package, even though
this package is not contained in the bundle project. By declaring this,
@@ -351,6 +333,7 @@
how the imports/exports automatically have version information
associated with them, which was obtained from packageinfo files in the
source packages):</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre>Manifest-Version: 1
Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt
@@ -371,8 +354,10 @@
Bundle-SymbolicName: org.apache.felix.log
</pre>
</div></div>
+
<p>The resulting bundle JAR file has the following content (notice how
the LICENSE and NOTICE files were automatically copied from the
<tt>src/main/resources/</tt> directory of the project):</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre>META-INF/MANIFEST.MF
LICENSE
@@ -413,22 +398,331 @@
<h2><a name="MavenBundlePlugin(BND)-BuildingthePlugin"></a>Building the
Plugin</h2>
-<p>The plugin is hosted at the Apache Felix incubator project. The
-following steps describe how to build and install the plugin into your
-local Maven2 repository.</p>
+<p>The plugin is hosted at the Apache Felix project. The following
+steps describe how to build and install the plugin into your local
+Maven2 repository.</p>
<p>Using the SVN client of your choice, checkout the maven-bundle-plugin
project.</p>
+
<div class="preformatted"><div class="preformattedContent">
-<pre>$ svn co
http://svn.apache.org/repos/asf/felix/trunk/tools/maven2/maven-bundle-plugin
+<pre>$ svn co http://svn.apache.org/repos/asf/felix/trunk/bundleplugin
</pre>
</div></div>
+
<p>Using Maven2, build and install the maven-bundle-plugin by issuing
the following Maven2 command in the project directory that was created
as a result of the previous step.</p>
+
<div class="preformatted"><div class="preformattedContent">
<pre>$ mvn install
</pre>
</div></div>
+
+<h1><a name="MavenBundlePlugin(BND)-Goals"></a>Goals</h1>
+
+<p>The maven-bundle-plugin also provides additional functionality via
+some Maven goals. Command-line execution of a goal is performed as
+follows:</p>
+
+<div class="preformatted"><div class="preformattedContent">
+<pre>mvn org.apache.felix:maven-bundle-plugin:GOAL
+</pre>
+</div></div>
+
+<p>Where GOAL is one of the following:</p>
+
+<ul>
+ <li><tt>bundle</tt> - build an OSGi bundle jar<br>
+configuration options:
+ <ul>
+ <li><tt>manifestLocation</tt> defaults to
${project.build.outputDirectory}/META-INF</li>
+ <li><tt>unpackBundle</tt> unpack bundle contents to output
directory, defaults to false</li>
+ <li><tt>supportedProjectTypes</tt> defaults to
"jar","bundle"</li>
+ </ul>
+ </li>
+ <li><tt>bundleall</tt> - build an OSGi bundle jar for all transitive
dependencies<br>
+configuration options:
+ <ul>
+ <li><tt>supportedProjectTypes</tt> defaults to
"jar","bundle"</li>
+ </ul>
+ </li>
+ <li><tt>wrap</tt> - as above, but limited to the first level of
dependencies<br>
+configuration options:
+ <ul>
+ <li><tt>supportedProjectTypes</tt> defaults to
"jar","bundle"</li>
+ </ul>
+ </li>
+ <li><tt>manifest</tt> - create an OSGi manifest for the current
project<br>
+configuration options:
+ <ul>
+ <li><tt>manifestLocation</tt> defaults to
${project.build.outputDirectory}/META-INF</li>
+ <li><tt>supportedProjectTypes</tt> defaults to
"jar","bundle"</li>
+ </ul>
+ </li>
+</ul>
+
+
+<p>There are also new instructions available from the underlying BND
+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>
+
+<p>The default goal <tt>bundle</tt> will be initialized by setting the
<packaging> entry to "bundle".</p>
+
+<h1><a name="MavenBundlePlugin(BND)-Embeddingdependencies"></a>Embedding
dependencies</h1>
+
+<p>The Maven Bundle Plugin supports embedding project dependencies into the
built bundle using the <tt><Embed-Dependency></tt> instruction listing
all dependencies in standard Bundle manifest header syntax:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><Embed-Dependency></span>dependencies<span
class="code-tag"></Embed-Dependency></span></pre>
+</div></div>
+
+<p>where:</p>
+
+<div class="preformatted"><div class="preformattedContent">
+<pre>dependencies ::= clause ( ',' clause ) *
+clause ::= MATCH ( ';' attr '=' MATCH | ';inline=true' )
+attr ::= 'groupId' | 'artifactId' | 'version' | 'scope' | 'type' | 'classifier'
+MATCH ::= <globbed regular expressions>
+</pre>
+</div></div>
+
+<p>some examples:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime<span
class="code-tag"></Embed-Dependency></span>
+
+<span class="code-tag"><Embed-Dependency></span>junit;scope=test<span
class="code-tag"></Embed-Dependency></span>
+
+<span
class="code-tag"><Embed-Dependency></span>aopalliance;scope=!test;inline=true<span
class="code-tag"></Embed-Dependency></span></pre>
+</div></div>
+
+<p>By default matched dependencies are embedded in the bundle under as
<tt>artifactId-version.jar</tt>. This behaviour can be modified using the
following instructions:</p>
+
+<ul>
+ <li><tt><Embed-StripVersion>true</Embed-StripVersion></tt>
- removes the version from the file (ie. <em>artifactId.jar</em>)</li>
+ <li><tt><Embed-StripGroup>false</Embed-StripGroup></tt> -
adds the groupId as a subdirectory (ie.
<em>groupId/artifactId-version.jar</em>)</li>
+ <li><tt><Embed-Directory>directory</Embed-Directory></tt> -
adds a subdirectory (ie. <em>directory/artifactId-version.jar</em>)</li>
+</ul>
+
+
+<p>Normally the plugin only checks direct dependencies, but this can be
+changed to include the complete set of transitive dependencies with the
+following option:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><Embed-Transitive></span>true<span
class="code-tag"></Embed-Transitive></span></pre>
+</div></div>
+
+<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>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime;inline=true<span
class="code-tag"></Embed-Dependency></span></pre>
+</div></div>
+
+
+<h1><a name="MavenBundlePlugin(BND)-OBRintegration"></a>OBR integration</h1>
+
+<p>The latest Maven Bundle Plugin automatically updates the local OBR
+repository.xml file during the install phase, using a default location
+of:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-java"><LOCAL-MAVEN-REPOSITORY>/repository.xml</pre>
+</div></div>
+
+<p>You can configure the location of the OBR repository by using the command
line:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-java">mvn clean install
-DobrRepository=<PATH_TO_OBR></pre>
+</div></div>
+
+<p>or in the configuration section for the maven-bundle-plugin in your Maven
POM:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><groupId></span>org.apache.felix<span
class="code-tag"></groupId></span>
+<span class="code-tag"><artifactId></span>maven-bundle-plugin<span
class="code-tag"></artifactId></span>
+<span class="code-tag"><extensions></span>true<span
class="code-tag"></extensions></span>
+<span class="code-tag"><configuration></span>
+ <span class="code-tag"><obrRepository></span>PATH_TO_OBR<span
class="code-tag"></obrRepository></span>
+ <span class="code-tag"><instructions></span>
+ <span class="code-tag"><span class="code-comment"><!-- bnd instructions
--></span></span>
+ <span class="code-tag"></instructions></span>
+<span class="code-tag"></configuration></span></pre>
+</div></div>
+
+<p>to disable OBR installation set the obrRepository to NONE, for example:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-xml"><span
class="code-tag"><groupId></span>org.apache.felix<span
class="code-tag"></groupId></span>
+<span class="code-tag"><artifactId></span>maven-bundle-plugin<span
class="code-tag"></artifactId></span>
+<span class="code-tag"><extensions></span>true<span
class="code-tag"></extensions></span>
+<span class="code-tag"><configuration></span>
+ <span class="code-tag"><obrRepository></span>NONE<span
class="code-tag"></obrRepository></span>
+ <span class="code-tag"><instructions></span>
+ <span class="code-tag"><span class="code-comment"><!-- bnd instructions
--></span></span>
+ <span class="code-tag"></instructions></span>
+<span class="code-tag"></configuration></span></pre>
+</div></div>
+
+
+<h1><a name="MavenBundlePlugin(BND)-Eclipse/PDEintegration"></a>Eclipse/PDE
integration</h1>
+
+<p>It is possible to configure the Maven Bundle Plugin to put the
+bundle manifest where Eclipse/PDE expects it, and use the Maven
+Dependency Plugin to arrange for any embedded dependencies to appear in
+a local directory that matches the Bundle-ClassPath entries. Here is an
+example POM that does this:</p>
+
+<div class="preformatted"><div class="preformattedContent">
+<pre><project>
+
+ <properties>
+ <bundle.symbolicName>org.example</bundle.symbolicName>
+ <bundle.namespace>org.example</bundle.namespace>
+ </properties>
+
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>examples</groupId>
+ <artifactId>org.example</artifactId>
+ <version>1.0-SNAPSHOT</version>
+
+ <name>${bundle.symbolicName} [${bundle.namespace}]</name>
+
+ <packaging>bundle</packaging>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <version>1.1.0-SNAPSHOT</version>
+ <extensions>true</extensions>
+ <!--
+ the following instructions build a simple set of public/private
classes into an OSGi bundle
+ -->
+ <configuration>
+ <manifestLocation>META-INF</manifestLocation>
+ <instructions>
+
<Bundle-SymbolicName>${bundle.symbolicName}</Bundle-SymbolicName>
+ <Bundle-Version>${pom.version}</Bundle-Version>
+ <!--
+ assume public classes are in the top package, and private
classes are under ".internal"
+ -->
+
<Export-Package>${bundle.namespace};version="${pom.version}"</Export-Package>
+
<Private-Package>${bundle.namespace}.internal</Private-Package>
+
<Bundle-Activator>${bundle.namespace}.internal.Activator</Bundle-Activator>
+ <!--
+ embed compile/runtime dependencies using path that matches the
copied dependency folder
+ -->
+
<Embed-Dependency>*;scope=compile|runtime;inline=false</Embed-Dependency>
+ <Embed-Directory>target/dependency</Embed-Directory>
+ <Embed-StripGroup>true</Embed-StripGroup>
+ </instructions>
+ </configuration>
+ </plugin>
+ <plugin>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-dependencies</id>
+ <phase>package</phase>
+ <goals>
+ <goal>copy-dependencies</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>osgi_R4_core</artifactId>
+ <version>1.0</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>osgi_R4_compendium</artifactId>
+ <version>1.0</version>
+ <scope>provided</scope>
+ <optional>true</optional>
+ </dependency>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>compile</scope>
+ <optional>true</optional>
+ </dependency>
+ </dependencies>
+
+</project>
+</pre>
+</div></div>
+
+<p>To generate the Eclipse metadata use:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-java">mvn clean <span class="code-keyword">package</span>
eclipse:eclipse -Declipse.pde install</pre>
+</div></div>
+
+<p>and you should now be able to import this as an existing Eclipse
project.</p>
+
+<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>
+
+<p>With the original Pax-Construct generated POM you would simply use:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-java">mvn clean <span class="code-keyword">package</span>
pax:eclipse</pre>
+</div></div>
+
+<p>to create the appropriate Eclipse files and manifest, and also
+handle any embedded entries. The pax:eclipse goal extends
+eclipse:eclipse, and supports the same parameters.</p>
+
+<h1><a
name="MavenBundlePlugin(BND)-Unpackingbundlecontentsto'target/classes'"></a>Unpacking
bundle contents to 'target/classes'</h1>
+
+<p>Once in a while you may create a bundle which contains additional classes
to the ones compiled from <tt>src/main/java</tt>,
+for example when you embed the classes from another jar. This can
+sometimes cause unforeseen problems in Maven, as it will use the output
+directory (<tt>target/classes</tt>) rather than the final bundle, when
compiling against projects in the same reactor (ie. the same build).</p>
+
+<p>The easiest way to get around this Maven 'feature' is to unpack the
+contents of the bundle to the output directory after the packaging
+step, so the additional classes will be found where Maven expects them.
+Thankfully there is now an easy option to do this in the bundle-plugin:</p>
+
+<div class="code"><div class="codeContent">
+<pre class="code-java"><groupId>org.apache.felix</groupId>
+<artifactId>maven-bundle-plugin</artifactId>
+<extensions><span class="code-keyword">true</span></extensions>
+<configuration>
+ <unpackBundle><span
class="code-keyword">true</span></unpackBundle>
+ <instructions>
+ <!-- bnd instructions -->
+ </instructions>
+</configuration></pre>
+</div></div>
+
+<h1><a name="MavenBundlePlugin(BND)-UsinganexistingMANIFEST.MFfile"></a>Using
an existing MANIFEST.MF file</h1>
+
+<p>If you have an existing manifest, you can add this to the Bnd instructions,
like so:</p>
+
+<div class="code"><div class="codeContent">
+<pre
class="code-java"><_include>src/main/resources/META-INF/MANIFEST.MF</_include>
+<Export-Package>org.example.*</Export-Package></pre>
+</div></div>
+
+<p>Bnd will use it when calculating the bundle contents, and will also
+copy across all manifest attributes starting with a capital letter.<br>
+As shown in the above example, you could use this to include a non-OSGi
+manifest which you then customize with extra OSGi attributes.</p>
+
+<h1><a name="MavenBundlePlugin(BND)-Feedback"></a>Feedback</h1>
+
+<p>Subscribe to the Felix users mailing list by sending a message to <span
class="nobr"><a href="mailto:[EMAIL PROTECTED]" title="Send mail to [EMAIL
PROTECTED]" rel="nofollow">[EMAIL PROTECTED]<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:[EMAIL PROTECTED]"
title="Send mail to [EMAIL PROTECTED]" rel="nofollow">[EMAIL
PROTECTED]<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>
</div>
-</body></html>
+</body></html>
\ No newline at end of file
Added: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/apache.png
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/apache.png?rev=604640&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/apache.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/logo.png
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/logo.png?rev=604640&view=auto
==============================================================================
Binary file - no diff available.
Propchange: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/logo.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/mail_small.gif
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/mail_small.gif?rev=604640&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/mail_small.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/site.css
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/site.css?rev=604640&r1=604639&r2=604640&view=diff
==============================================================================
--- felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/site.css
(original)
+++ felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/site.css Sun Dec
16 07:59:05 2007
@@ -1,19 +1,25 @@
-body { background-color: #ffffff; color: #000000; font-family: Arial,
sans-serif; }
-h1 { font-size: 130% }
-h2 { font-size: 125% }
-h3 { font-size: 120% }
-h4 { font-size: 115% }
-h5 { font-size: 110% }
-h6 { font-size: 105% }
-a { color: #880000 }
-a:visited { color: #880000 }
-a:hover { color: #cc4444 }
-.title { position: absolute; left: 1em; right: 1em; top: 10px; height: 52px; }
-.menu { position: absolute; top: 80px; left: 0.5em; width: 8em; border: solid
1px black; padding-left: 0.5em; padding-right: 0.5em }
-.menu ul { list-style: none; padding-left: 0pt}
-.main { position: absolute; top: 65px; left: 10.5em; right: 1em; }
-.code { background-color: #eeeeee; border: solid 1px black; padding: 0.5em; }
-.code-keyword { color: #880000; }
-.code-quote { color: #008800; }
-.code-object { color: #0000dd; }
-.code-java { margin: 0em; }
\ No newline at end of file
+/* @override http://felix.apache.org/site/media.data/site.css */
+
+body { background-color: #ffffff; color: #3b3b3b; font-family: Tahoma, Arial,
sans-serif; font-size: 10pt; line-height: 140% }
+h1, h2, h3, h4, h5, h6 { font-weight: normal; color: #000000; line-height:
100%; margin-top: 0px}
+h1 { font-size: 200% }
+h2 { font-size: 175% }
+h3 { font-size: 150% }
+h4 { font-size: 140% }
+h5 { font-size: 130% }
+h6 { font-size: 120% }
+a { color: #1980af }
+a:visited { color: #1980af }
+a:hover { color: #1faae9 }
+.title { position: absolute; left: 1px; right: 1px; top:25px; height: 81px;
background: url(http://felix.apache.org/site/media.data/gradient.png) repeat-x;
background-position: bottom; }
+.logo { position: absolute; width: 15em; height: 81px; text-align: center; }
+.header { text-align: right; margin-right: 20pt; margin-top: 30pt;}
+.menu { border-top: 10px solid #f9bb00; position: absolute; top: 107px; left:
1px; width: 15em; bottom: 0px; padding: 0px; background-color: #fcfcfc }
+.menu ul { background-color: #fdf5d9; list-style: none; padding-left: 4em;
margin-top: 0px; padding-top: 2em; padding-bottom: 2em; margin-left: 0px;
color: #4a4a43}
+.menu a { text-decoration: none; color: #4a4a43 }
+.main { position: absolute; border-top: 10px solid #cde0ea; top: 107px; left:
15em; right: 1px; margin-left: 2px; padding-right: 4em; padding-left: 1em;
padding-top: 1em;}
+.code { background-color: #eeeeee; border: solid 1px black; padding: 0.5em }
+.code-keyword { color: #880000 }
+.code-quote { color: #008800 }
+.code-object { color: #0000dd }
+.code-java { margin: 0em }
\ No newline at end of file
