You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by bu...@apache.org on 2013/06/13 12:43:01 UTC
svn commit: r865542 - in /websites/staging/felix/trunk/content: ./
documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
Author: buildbot
Date: Thu Jun 13 10:43:01 2013
New Revision: 865542
Log:
Staging update by buildbot for felix
Modified:
websites/staging/felix/trunk/content/ (props changed)
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jun 13 10:43:01 2013
@@ -1 +1 @@
-1492616
+1492618
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html Thu Jun 13 10:43:01 2013
@@ -149,15 +149,13 @@
<li>
<p><code><Bundle-SymbolicName></code> is computed using the shared <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-osgi/src/main/java/org/apache/maven/shared/osgi/DefaultMaven2OsgiConverter.java">Maven2OsgiConverter</a> component, which uses the following algorithm:
Get the symbolic name as groupId + "." + artifactId, with the following exceptions:</p>
-</li>
-<li>
-<p>if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName property then that value is returned</p>
-</li>
+<ul>
+<li>if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName property then that value is returned</li>
<li>if groupId has only one section (no dots) and artifact.getFile is not null then the first package name with classes is returned. eg. commons-logging:commons-logging -> org.apache.commons.logging</li>
<li>if artifactId is equal to last section of groupId then groupId is returned. eg. org.apache.maven:maven -> org.apache.maven</li>
-<li>
-<p>if artifactId starts with last section of groupId that portion is removed. eg. org.apache.maven:maven-core -> org.apache.maven.core
-The computed symbolic name is also stored in the <code>$(maven-symbolicname)</code> property in case you want to add attributes or directives to it.</p>
+<li>if artifactId starts with last section of groupId that portion is removed. eg. org.apache.maven:maven-core -> org.apache.maven.core
+The computed symbolic name is also stored in the <code>$(maven-symbolicname)</code> property in case you want to add attributes or directives to it.</li>
+</ul>
</li>
<li>
<p><code><Export-Package></code> is now assumed to be the set of packages in your local Java sources, excluding the default package '.' and any packages containing 'impl' or 'internal'.
@@ -414,56 +412,48 @@ for them in the bundleplugin configurati
<li>
<p><em><code>bundle</code></em> - build an OSGi bundle jar for the current project
configuration options:</p>
-</li>
-<li>
-<p><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</p>
-</li>
+<ul>
+<li><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</li>
<li><em><code>unpackBundle</code></em> unpack bundle contents to output directory, defaults to false</li>
<li><em><code>excludeDependencies</code></em> comma-separated list of dependency artifactIds to exclude from the classpath passed to Bnd, use "true" to exclude everything.
Version 2 of the bundleplugin now supports the same style of filter clauses in <code>excludeDependencies</code> as <code>Embed-Dependency</code>.</li>
<li><em><code>classifier</code></em> attach bundle to the project using the given classifier</li>
-<li>
-<p><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</p>
+<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
+</ul>
</li>
<li>
<p><em><code>bundleall</code></em> - build OSGi bundle jars for all transitive dependencies
configuration options:</p>
-</li>
-<li>
-<p><em><code>wrapImportPackage</code></em> defaults to "*"</p>
-</li>
-<li>
-<p><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</p>
+<ul>
+<li><em><code>wrapImportPackage</code></em> defaults to "*"</li>
+<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
+</ul>
</li>
<li>
<p><em><code>wrap</code></em> - as above, but limited to the first level of dependencies
configuration options:</p>
-</li>
-<li>
-<p><em><code>wrapImportPackage</code></em> defaults to "*"</p>
-</li>
-<li>
-<p><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</p>
+<ul>
+<li><em><code>wrapImportPackage</code></em> defaults to "*"</li>
+<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
+</ul>
</li>
<li>
<p><em><code>manifest</code></em> - create an OSGi manifest for the current project
configuration options:</p>
-</li>
-<li>
-<p><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</p>
-</li>
-<li>
-<p><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</p>
+<ul>
+<li><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</li>
+<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
+</ul>
</li>
<li>
<p><em><code>install</code></em> - adds the current bundle project to the local OBR
configuration options:</p>
-</li>
-<li>
-<p><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></p>
-</li>
+<ul>
+<li><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></li>
<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
</ul>
+</li>
+</ul>
<p>More GOALs are available in the <em>1.4.0</em> release:</p>
<ul>
<li>
@@ -472,10 +462,8 @@ configuration options:</p>
<li>
<p><em><code>install-file</code></em> - adds a local bundle file to the local OBR
configuration options:</p>
-</li>
-<li>
-<p><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></p>
-</li>
+<ul>
+<li><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></li>
<li><em><code>groupId</code></em> Maven groupId for the bundle, taken from <em>pomFile</em> if given</li>
<li><em><code>artifactId</code></em> Maven artifactId for the bundle, taken from <em>pomFile</em> if given</li>
<li><em><code>version</code></em> Maven version for the bundle, taken from <em>pomFile</em> if given</li>
@@ -483,45 +471,33 @@ configuration options:</p>
<li><em><code>classifier</code></em> Maven classifier type, defaults to none</li>
<li><em><code>pomFile</code></em> optional Pom file describing the bundle</li>
<li><em><code>file</code></em> bundle file, defaults to the bundle from the local Maven repository</li>
-<li>
-<p><em><code>obrXml</code></em> optional additional properties for the bundle</p>
+<li><em><code>obrXml</code></em> optional additional properties for the bundle</li>
+</ul>
</li>
<li>
<p><em><code>deploy</code></em> - adds the current bundle project to a remote OBR
configuration options:</p>
-</li>
-<li>
-<p><em><code>remoteOBR</code></em> name of remote OBR, defaults to NONE (which means no remote OBR deployment)</p>
-</li>
+<ul>
+<li><em><code>remoteOBR</code></em> name of remote OBR, defaults to NONE (which means no remote OBR deployment)</li>
<li><em><code>obrRepository</code></em> used when the remoteOBR name is blank, defaults to <code>repository.xml</code></li>
<li><em><code>prefixUrl</code></em> optional public URL prefix for the remote repository</li>
<li><em><code>bundleUrl</code></em> optional public URL where the bundle has been deployed</li>
<li><em><code>altDeploymentRepository</code></em> alternative remote repository, <em>id::layout::url</em></li>
<li><em><code>obrDeploymentRepository</code></em> optional OBR specific deployment repository.</li>
<li><em><code>ignoreLock</code></em> ignore remote locking when updating the OBR</li>
-<li>
-<p><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</p>
+<li><em><code>supportedProjectTypes</code></em> defaults to "jar","bundle"</li>
+</ul>
</li>
<li>
<p><em><code>deploy-file</code></em> - adds a local bundle file to a remote OBR
configuration options:</p>
-</li>
-<li>
-<p><em><code>remoteOBR</code></em> name of remote OBR, defaults to an empty string</p>
-</li>
+<ul>
+<li><em><code>remoteOBR</code></em> name of remote OBR, defaults to an empty string</li>
<li><em><code>obrRepository</code></em> used when the remoteOBR name is blank, defaults to <code>repository.xml</code></li>
<li><em><code>repositoryId</code></em> optional repository id, used to lookup authentication settings</li>
-<li>
-<p><em><code>url</code></em> remote repository transport URL, like</p>
-<p>scpexe://host/path/to/obr</p>
-</li>
-<li>
-<p><em><code>bundleUrl</code></em> public URL of deployed bundle, like</p>
-<p>http://www.foo.org/bundles/foo.jar</p>
-</li>
-<li>
-<p><em><code>groupId</code></em> Maven groupId for the bundle, taken from <em>pomFile</em> if given</p>
-</li>
+<li><em><code>url</code></em> remote repository transport URL, like <code>scpexe://host/path/to/obr</code></li>
+<li><em><code>bundleUrl</code></em> public URL of deployed bundle, like <code>http://www.foo.org/bundles/foo.jar</code></li>
+<li><em><code>groupId</code></em> Maven groupId for the bundle, taken from <em>pomFile</em> if given</li>
<li><em><code>artifactId</code></em> Maven artifactId for the bundle, taken from <em>pomFile</em> if given</li>
<li><em><code>version</code></em> Maven version for the bundle, taken from <em>pomFile</em> if given</li>
<li><em><code>packaging</code></em> Maven packaging type for the bundle, taken from <em>pomFile</em> if given</li>
@@ -529,29 +505,29 @@ configuration options:</p>
<li><em><code>pomFile</code></em> optional Pom file describing the bundle</li>
<li><em><code>file</code></em> bundle file, defaults to the bundle from the local Maven repository</li>
<li><em><code>obrXml</code></em> optional additional properties for the bundle</li>
-<li>
-<p><em><code>ignoreLock</code></em> ignore remote locking when updating the OBR</p>
+<li><em><code>ignoreLock</code></em> ignore remote locking when updating the OBR</li>
+</ul>
</li>
<li>
<p><em><code>clean</code></em> - cleans the local OBR, removing missing bundles
configuration options:</p>
-</li>
-<li>
-<p><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></p>
+<ul>
+<li><em><code>obrRepository</code></em> path to local OBR, defaults to <em><local-maven-repository></em><code>/repository.xml</code></li>
+</ul>
</li>
<li>
<p><em><code>remote-clean</code></em> - cleans a remote OBR, removing missing bundles
configuration options:</p>
-</li>
-<li>
-<p><em><code>remoteOBR</code></em> name of remote OBR, defaults to NONE (which means no remote cleaning)</p>
-</li>
+<ul>
+<li><em><code>remoteOBR</code></em> name of remote OBR, defaults to NONE (which means no remote cleaning)</li>
<li><em><code>obrRepository</code></em> used when the remoteOBR name is blank, defaults to <code>repository.xml</code></li>
<li><em><code>prefixUrl</code></em> optional public URL prefix for the remote repository</li>
<li><em><code>altDeploymentRepository</code></em> alternative remote repository, <em>id::layout::url</em></li>
<li><em><code>obrDeploymentRepository</code></em> optional OBR specific deployment repository.</li>
<li><em><code>ignoreLock</code></em> ignore remote locking when updating the OBR</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 <a href="http://aqute.biz/Code/Bnd">BND documentation</a>.</p>
<p>The default goal <em><code>bundle</code></em> will be initialized by setting the <packaging> entry to "bundle".</p>
<h1 id="the-following-features-are-only-available-from-version-120-onwards">The following features are only available from version 1.2.0 onwards</h1>
@@ -889,14 +865,14 @@ As shown in the above example, you could
<li><em>maven</em> this will create a maven based url such as <code>mvn:groupid/artifactid/version</code></li>
<li>
<p>pattern with the following placeholders:</p>
-</li>
-<li>
-<p><code>%v</code> bundle version</p>
-</li>
+<ul>
+<li><code>%v</code> bundle version</li>
<li><code>%s</code> bundle symbolic name</li>
<li><code>%f</code> file name</li>
<li><code>%p</code> file path</li>
</ul>
+</li>
+</ul>
<h2 id="concurrent-updates">Concurrent updates</h2>
<p>With a remote OBR, several uploads may occur at the same time. However, the remote OBR is centralized in one file, so concurrent modification must be avoided. To achieve this, the plug-in implements a locking system. Each time the plug-in tries to modify the file it sets a file based lock. If it can't take the lock, it will wait and retry. After 3 attempts the upload process fails. To bypass this lock add <code>-DignoreLock</code> to the command-line (or add <code><ignoreLock>true<ignoreLock></code> to the configuration section of your Pom).</p>
<h2 id="ftp-protocol">FTP protocol</h2>
@@ -937,7 +913,7 @@ As shown in the above example, you could
<h1 id="feedback">Feedback</h1>
<p>Subscribe to the Felix users mailing list by sending a message to <a href="mailto:users-subscribe@felix.apache.org">users-subscribe@felix.apache.org</a>; after subscribing, email questions or feedback to <a href="mailto:users@felix.apache.org">users@felix.apache.org</a>.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1492616 by mcculls on Thu, 13 Jun 2013 10:36:38 +0000
+ Rev. 1492618 by mcculls on Thu, 13 Jun 2013 10:42:53 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project