pax_global_header 0000666 0000000 0000000 00000000064 11645647261 0014526 g ustar 00root root 0000000 0000000 52 comment=49a4ec3cdd4fea3e1775e80092a2241b9240d163
maven-bundle-plugin-2.3.5/ 0000775 0000000 0000000 00000000000 11645647261 0015406 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/DEPENDENCIES 0000664 0000000 0000000 00000002156 11645647261 0017163 0 ustar 00root root 0000000 0000000 Apache Felix Bundle Maven Plugin
Copyright 2006-2011 The Apache Software Foundation
This software was developed at the Apache Software Foundation
(http://www.apache.org) and may have dependencies on other
Apache software licensed under Apache License 2.0.
I. Included Third-Party Software
II. Used Third-Party Software
This product uses software developed by Peter Kriens
(http://www.aqute.biz/Code/Bnd)
Copyright 2006-2011 aQute, All rights reserved
Licensed under the Apache License 2.0.
This product uses software developed at
The OSGi Alliance (http://www.osgi.org/).
Copyright 2006-2011 The OSGi Alliance.
Licensed under the Apache License 2.0.
This product uses software developed at
The Apache Software Foundation (http://www.apache.org/).
Licensed under the Apache License 2.0.
This product uses software developed at
The Codehaus (http://www.codehaus.org)
Licensed under the Apache License 2.0.
This product uses software from http://kxml.sourceforge.net.
Copyright (c) 2002-2011, Stefan Haustein, Oberhausen, Rhld., Germany.
Licensed under the BSD License.
III. License Summary
- Apache License 2.0
- BSD License
maven-bundle-plugin-2.3.5/LICENSE 0000664 0000000 0000000 00000026136 11645647261 0016423 0 ustar 00root root 0000000 0000000
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
maven-bundle-plugin-2.3.5/LICENSE.kxml2 0000664 0000000 0000000 00000002107 11645647261 0017447 0 ustar 00root root 0000000 0000000 Copyright (c) 2002,2003, Stefan Haustein, Oberhausen, Rhld., Germany
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
maven-bundle-plugin-2.3.5/NOTICE 0000664 0000000 0000000 00000000341 11645647261 0016310 0 ustar 00root root 0000000 0000000 Apache Felix Bundle Maven Plugin
Copyright 2006-2011 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Licensed under the Apache License 2.0.
maven-bundle-plugin-2.3.5/doc/ 0000775 0000000 0000000 00000000000 11645647261 0016153 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/doc/apache-felix-maven-bundle-plugin-bnd.html 0000664 0000000 0000000 00000207552 11645647261 0026012 0 ustar 00root root 0000000 0000000
Apache Felix - Apache Felix Maven Bundle Plugin (BND)
This plugin for Maven 2 is based on the BND
tool from Peter Kriens. The way BND works is by treating your project
as a big collection of classes (e.g., project code, dependencies, and
the class path). The way you create a bundle with BND is to tell it the
content of the bundle's JAR file as a subset of the available classes.
This plugin wraps BND to make it work specifically with the Maven 2
project structure and to provide it with reasonable default behavior
for Maven 2 projects.
If you have questions about the maven-bundle-plugin please read the FAQ first. If you still have questions you can ask them on the Felix user list.
NOTE: test scoped dependencies are not included in the classpath seen by BND.
Since the 1.4.0 release, this plugin also aims to automate OBR (OSGi
Bundle Repository) management. It helps manage a local OBR for your
local Maven repository, and also supports remote OBRs for bundle
distribution. The plug-in automatically computes bundle capabilities
and requirements, using a combination of Bindex and Maven metadata.
Simple Example
Rather than going straight to a detailed list of plugin features, we
will first look at a simple example of how to use the plugin to give an
immediate flavor. A detailed "how to" will follow.
Assume that we have a simple bundle project that has a pubic API package an several implementation packages, such as:
If we also assume that we have a bundle activator in one of the implementation packages, then the <plugins> section of the POM file for this bundle project would look like this:
The <Export-Package> and <Private-Package> instructions tell the plugin about the contents of the resulting bundle JAR file. The <Export-Package> instruction tells the plugin which of the available packages to copy into the bundle and export, while the <Private-Package> instruction indicates which of the available packages to copy into the bundle but not
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
other bundle manifest headers, they will assume default values which
are described below. One specific behavior to highlight is that the plugin generates the Import-Package
bundle manifest header based on the contents of the bundle, which means
that you generally do not ever need to explicitly specify it yourself.
That's it.
Features
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 above. BND recognizes three types of instructions:
Manifest headers - Any instruction that starts with
a capital letter will appear in the resulting bundle's manifest file;
the value for the header will either be copied, augmented, or generated
by BND depending on the instruction.
Variables - Any instruction starting with a lowercase letter is assumed to be a variable in the form of a name-value pair, such as version=3.0, that can be used for property substitution, but is not copied to the manifest.
Directives
- Any instruction starting with a '-' character is considered to be a
directive that informs BND to perform some special processing and is
not copied to the manifest.
The remainder of this section covers the most important aspects of BND's instructions; for complete details refer to the BND documentation.
Instructions
<Export-Package>
The <Export-Package> instruction is a list of
packages for the bundle to export. These packages are copied into the
resulting bundle JAR file from the available classes (i.e., project
classes, dependencies, and class path); thus, it is possible to include
classes into your bundle that are not associated with source files in
your project. <Export-Package> can be specified with
package patterns using the '*' wildcard. Also, it is possible to
exclude packages using negation by starting the package pattern with
'!'. Thus, non-negated patterns indicate which of the available
packages to include in the bundle, whereas negated patterns indicate
which should not be included in the bundle.
The list of package patterns is ordered and earlier patterns are applied before later patterns. For example, if you specify "org.foo.*,!org.foo.impl" the second pattern has no effect since all org.foo packages have already been selected by the first pattern. Instead, you should specify "!org.foo.impl,org.foo.*", which will export all org.foo packages except org.foo.impl.
Following standard OSGi R4 syntax, package patterns can include both
directives and attributes, which will be copied appropriately into the
generated Export-Package manifest header. Besides explicitly listing
package version attributes, BND will also determine package versions by
examining the source JAR file or from packageinfo files in the package directory.
<Private-Package>
The <Private-Package> instruction is similar in every way to the <Export-Package> instruction, except for the fact that these packages will not
be exported by the bundle. If a package is selected by both the export
and private package headers, then the export takes precedence.
<Include-Resource>
The <Include-Resource> instruction is a list of
arbitrary resources that should be copied into the bundle JAR file. The
specified resources are declared as clauses that can have the following
forms:
For the <Include-Resource> instruction, actual file paths are relative to the pom.xml, while file copy destinations are relative to the root of the resulting bundle JAR file. In the case of assignment or simple forms, the PATH parameter can point to a file or directory. The simple
form will place the resource in the bundle JAR with only the file name,
i.e., without any path component. For example, including src/main/resources/a/b.c will result in a resource b.c in the root of the bundle JAR. If the PATH
points to a directory, the entire directory hierarchy is copied into
the resulting bundle JAR file relative to the specified directory. If a
specific resource must be placed into a subdirectory of the bundle jar,
then use the assignment form, where the first path is the the
destination path (including file name if the resource is a file) and
the second path is the resource to copy. The inline form requires a ZIP or JAR file, which will be completely expanded in the bundle JAR.
If a resource clause is specified inside of "{ ... }" brackets, then
variable substitution will be performed on the resource, where
variables in the resources are denoted with "${ ... }" syntax.
By default the bundle plugin converts the project's Maven resource directories into a single <Include-Resource> instruction. If you specify your own <Include-Resource> instruction, this will replace the generated one. To include the generated list of Maven resources in your own <Include-Resource> instruction just add {maven-resources} to the list and it will be expanded automatically.
<Import-Package>
The <Import-Package> instruction is a list of
packages that are required by the bundle's contained packages. The
default for this header is "*", resulting in importing all referred
packages. This header rarely has to be explicitly specified. However,
in certain cases when there is an unwanted import, such an import can
be removed by using a negation package pattern. The package patterns
work in the same way as for <Export-Package>, which means they are ordered. For example, if you wanted to import all packages except org.foo.impl you would specify "!org.foo.impl,*"
Default Behavior
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:
<Bundle-SymbolicName> is computed using the shared Maven2OsgiConverter component, which uses the following algorithm:
Get the symbolic name as groupId + "." + artifactId, with the following exceptions:
if
artifact.getFile is not null and the jar contains a OSGi Manifest with
Bundle-SymbolicName property then that value is returned
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
if artifactId is equal to last section of groupId then groupId is returned. eg. org.apache.maven:maven -> org.apache.maven
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 $(maven-symbolicname) property in case you want to add attributes or directives to it.
<Export-Package>
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'. (before version 2 of the bundleplugin it was based on the symbolic name)
<Private-Package> is now assumed to be the set of packages in your local Java sources (note that any packages in both <Export-Package> and <Private-Package> will be exported). (before version 2 of the bundleplugin it was assumed to be empty by default)
<Import-Package> is assumed to be "*", which imports everything referred to by the bundle content, but not contained in the bundle. Any exported packages are also imported by default, to ensure a consistent class space.
<Include-Resource> is generated from the project's Maven resources, typically "src/main/resources/",
which will copy the specified project directory hierarchy into the
resulting bundle JAR file, mirroring standard Maven behavior.
<Bundle-Version> is assumed to be "${pom.version}" but is normalized to the OSGi version format of "MAJOR.MINOR.MICRO.QUALIFIER", for example "2.1-SNAPSHOT" would become "2.1.0.SNAPSHOT".
<Bundle-Name> is assumed to be "${pom.name}".
<Bundle-Description> is assumed to be "${pom.description}".
<Bundle-License> is assumed to be "${pom.licenses}".
<Bundle-Vendor> is assumed to be "${pom.organization.name}".
<Bundle-DocURL> is assumed to be "${pom.organization.url}".
Since the plugin creates bundles for OSGi R4, it hard-codes Bundle-ManifestVersion
to be '2'. Additionally, it generates imports for every export to
ensure package substitutability, which is very important when working
with collaborating services. It is possible to override any of these
values (except Bundle-ManifestVersion) just by specifying the desired value in the plugin configuration section of the POM file.
Detailed "How To"
Get Maven2
The first step in the process of using the plugin is downloading and
installing the latest version of the Maven2 runtime. The latest Maven2
release and instuctions for getting started with Maven2 can be found at
the Maven website.
Using the Plugin
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:
There are two main things to note: (1) the <packaging>
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).
Real-World Example
Consider this more real-world example using Felix' Log Service
implementation. The Log Service project is comprised of a single
package: org.apache.felix.log.impl. It has a dependency on
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:
Notice that the <Export-Package> instruction
specifies that the bundle exports the Log Service package, even though
this package is not contained in the bundle project. By declaring this,
the plugin will copy the Log Service package into the resulting bundle
JAR file. This is useful in this case because now the bundle can
resolve without having to download the entire compendium bundle. The
resulting manifest for the Log Service bundle looks like this (notice
how the imports/exports automatically have version information
associated with them, which was obtained from packageinfo files in the
source packages):
Manifest-Version: 1
Bundle-License: http://www.apache.org/licenses/LICENSE-2.0.txt
Bundle-Activator: org.apache.felix.log.impl.Activator
Import-Package: org.osgi.framework;version=1.3, org.osgi.service.log;v
ersion=1.3
Include-Resource: src/main/resources
Export-Package: org.osgi.service.log;uses:=org.osgi.framework;version=
1.3
Bundle-Version: 0.8.0.SNAPSHOT
Bundle-Name: Apache Felix Log Service
Bundle-Description: This bundle provides an implementation of the OSGi
R4 Log service.
Private-Package: org.apache.felix.log.impl
Bundle-ManifestVersion: 2
Export-Service: org.osgi.service.log.LogService,org.osgi.service.log.L
ogReaderService
Bundle-SymbolicName: org.apache.felix.log
The resulting bundle JAR file has the following content (notice how
the LICENSE and NOTICE files were automatically copied from the src/main/resources/ directory of the project):
Adding OSGi metadata to existing projects without changing the packaging type
If you want to keep your project packaging type (for example "jar") but would like to add OSGi metadata
you can use the manifest goal to generate a bundle manifest. The maven-jar-plugin can then be used to
add this manifest to the final artifact. For example:
If you want to use packaging types other than "jar" and "bundle" then you also need to enable support
for them in the bundleplugin configuration, for example if you want to use the plugin with WAR files:
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.
Using the SVN client of your choice, checkout the maven-bundle-plugin project.
$ svn co http://svn.apache.org/repos/asf/felix/trunk/bundleplugin
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.
$ mvn install
Goals
The maven-bundle-plugin also provides additional functionality via
some Maven goals. Command-line execution of a goal is performed as
follows:
mvn org.apache.felix:maven-bundle-plugin:GOAL
Where GOAL is one of the following:
bundle - build an OSGi bundle jar for the current project
configuration options:
manifestLocation defaults to ${project.build.outputDirectory}/META-INF
unpackBundle unpack bundle contents to output directory, defaults to false
excludeDependencies 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 excludeDependencies as Embed-Dependency.
classifier attach bundle to the project using the given classifier
supportedProjectTypes defaults to "jar","bundle"
bundleall - build OSGi bundle jars for all transitive dependencies
configuration options:
wrapImportPackage defaults to "*"
supportedProjectTypes defaults to "jar","bundle"
wrap - as above, but limited to the first level of dependencies
configuration options:
wrapImportPackage defaults to "*"
supportedProjectTypes defaults to "jar","bundle"
manifest - create an OSGi manifest for the current project
configuration options:
manifestLocation defaults to ${project.build.outputDirectory}/META-INF
supportedProjectTypes defaults to "jar","bundle"
install - adds the current bundle project to the local OBR
configuration options:
obrRepository path to local OBR, defaults to <local-maven-repository>/repository.xml
supportedProjectTypes defaults to "jar","bundle"
More GOALs are available in the 1.4.0 release:
ant - create an Ant build script to rebuild the bundle
install-file - adds a local bundle file to the local OBR
configuration options:
obrRepository path to local OBR, defaults to <local-maven-repository>/repository.xml
groupId Maven groupId for the bundle, taken from pomFile if given
artifactId Maven artifactId for the bundle, taken from pomFile if given
version Maven version for the bundle, taken from pomFile if given
packaging Maven packaging type for the bundle, taken from pomFile if given
classifier Maven classifier type, defaults to none
pomFile optional Pom file describing the bundle
file bundle file, defaults to the bundle from the local Maven repository
obrXml optional additional properties for the bundle
deploy - adds the current bundle project to a remote OBR
configuration options:
remoteOBR name of remote OBR, defaults to NONE (which means no remote OBR deployment)
obrRepository used when the remoteOBR name is blank, defaults to repository.xml
prefixUrl optional public URL prefix for the remote repository
bundleUrl optional public URL where the bundle has been deployed
altDeploymentRepository alternative remote repository, id::layout::url
obrDeploymentRepository optional OBR specific deployment repository.
ignoreLock ignore remote locking when updating the OBR
supportedProjectTypes defaults to "jar","bundle"
deploy-file - adds a local bundle file to a remote OBR
configuration options:
remoteOBR name of remote OBR, defaults to an empty string
obrRepository used when the remoteOBR name is blank, defaults to repository.xml
repositoryId optional repository id, used to lookup authentication settings
url remote repository transport URL, like
scpexe://host/path/to/obr
bundleUrl public URL of deployed bundle, like
http://www.foo.org/bundles/foo.jar
groupId Maven groupId for the bundle, taken from pomFile if given
artifactId Maven artifactId for the bundle, taken from pomFile if given
version Maven version for the bundle, taken from pomFile if given
packaging Maven packaging type for the bundle, taken from pomFile if given
classifier Maven classifier type, defaults to none
pomFile optional Pom file describing the bundle
file bundle file, defaults to the bundle from the local Maven repository
obrXml optional additional properties for the bundle
ignoreLock ignore remote locking when updating the OBR
clean - cleans the local OBR, removing missing bundles
configuration options:
obrRepository path to local OBR, defaults to <local-maven-repository>/repository.xml
remoteOBR name of remote OBR, defaults to NONE (which means no remote cleaning)
obrRepository used when the remoteOBR name is blank, defaults to repository.xml
prefixUrl optional public URL prefix for the remote repository
altDeploymentRepository alternative remote repository, id::layout::url
obrDeploymentRepository optional OBR specific deployment repository.
ignoreLock ignore remote locking when updating the OBR
There are also new instructions available from the underlying BND
tool, which continues to be improved independently; for the latest see BND documentation.
The default goal bundle will be initialized by setting the <packaging> entry to "bundle".
The following features are only available from version 1.2.0 onwards
Embedding dependencies
The Maven Bundle Plugin supports embedding of selected project dependencies inside the bundle by using the <Embed-Dependency> instruction:
The plugin uses the <Embed-Dependency> instruction to transform the project dependencies into <Include-Resource> and <Bundle-ClassPath>
clauses, which are then appended to the current set of instructions and
passed onto BND. If you want the embedded dependencies to be at the
start or middle of <Include-Resource> or <Bundle-ClassPath> then you can use {maven-dependencies}, which will automatically expand to the relevant clauses.
The MATCH section accepts alternatives, separated by |, and can be negated by using ! at the beginning of the MATCH. Use * to represent zero or more unknown characters and ? to represent a single unknown character. There is no need to escape the . character inside MATCH. The first MATCH in a clause will filter against the artifactId.
some examples:
<!-- embed all compile and runtime scope dependencies --><Embed-Dependency>*;scope=compile|runtime</Embed-Dependency><!-- embed any dependencies with artifactId junit and scope runtime --><Embed-Dependency>junit;scope=runtime</Embed-Dependency><!-- inline all non-pom dependencies, except those with scope runtime --><Embed-Dependency>*;scope=!runtime;type=!pom;inline=true</Embed-Dependency><!-- embed all compile and runtime scope dependencies, except those with artifactIds in the given list --><Embed-Dependency>*;scope=compile|runtime;inline=false;artifactId=!cli|lang|runtime|tidy|jsch</Embed-Dependency><!-- inline contents of selected folders from all dependencies --><Embed-Dependency>*;inline=images/**|icons/**</Embed-Dependency>
By default matched dependencies are embedded in the bundle as artifactId-version.jar. This behaviour can be modified using the following instructions:
<Embed-StripVersion>true</Embed-StripVersion> - removes the version from the file (ie. artifactId.jar)
<Embed-StripGroup>false</Embed-StripGroup> - adds the groupId as a subdirectory (ie. groupId/artifactId-version.jar)
<Embed-Directory>directory</Embed-Directory> - adds a subdirectory (ie. directory/artifactId-version.jar)
Normally the plugin only checks direct dependencies, but this can be
changed to include the complete set of transitive dependencies with the
following option:
<Embed-Transitive>true</Embed-Transitive>
If you want a dependency inlined instead of embedded add the inline=true. For example to inline all compile and runtime scoped dependencies use:
If you embed a dependency with <Embed-Dependency>, and your <Export-Package> or <Private-Package> instructions match packages inside the embedded jar, you will see some duplication inside the bundle. This is because the <Export-Package> and <Private-Package>
instructions will result in classes being inlined in the bundle, even
though they also exist inside the embedded jar. If you want to export
packages from an embedded dependency without such duplication then you
can either inline the dependency, or use a new BND instruction called <_exportcontents>.
<_exportcontents> behaves just like Export-Package, except it doesn't change the content of the bundle, just what content should be exported.
OBR integration
The latest Maven Bundle Plugin automatically updates the local OBR
repository.xml file during the install phase, using a default location
of:
<LOCAL-MAVEN-REPOSITORY>/repository.xml
You can configure the location of the OBR repository by using the command line:
mvn clean install -DobrRepository=<PATH_TO_OBR>
or in the configuration section for the maven-bundle-plugin in your Maven POM:
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:
<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>
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
<resource>
<directory>.</directory>
<includes>
<include>plugin.xml</include>
</includes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>1.2.1</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}.internal.*,${bundle.namespace}.*;version="${pom.version}"</Export-Package>
<Private-Package>${bundle.namespace}.internal.*</Private-Package>
<Bundle-Activator>${bundle.namespace}.internal.ExampleActivator</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>
and you should now be able to import this as an existing Eclipse project.
FYI: the above POM was generated using the pax-create-bundle command from Pax-Construct and then tweaked to demonstrate using the Maven Dependency Plugin to handle embedded jars in Eclipse.
With the original Pax-Construct generated POM you would simply use:
mvn clean package pax:eclipse
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.
Unpacking bundle contents to 'target/classes'
Once in a while you may create a bundle which contains additional classes to the ones compiled from src/main/java,
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 (target/classes) rather than the final bundle, when compiling against projects in the same reactor (ie. the same build).
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:
Bnd will use it when calculating the bundle contents, and will also
copy across all manifest attributes starting with a capital letter.
As shown in the above example, you could use this to include a non-OSGi
manifest which you then customize with extra OSGi attributes.
The following features are only available from version 1.4.0 onwards
bundle:ant
The ant goal creates a customized build.xml Ant script along with a collection of BND instructions and properties, taken from the current project and stored in maven-build.bnd. You also need to run ant:ant to create the standard Ant support tasks to download Maven dependencies and perform compilation, etc.
The customized Ant script uses the BND tool to rebuild the bundle,
so any source changes should be reflected in the (re)generated manifest.
Example:
mvn ant:ant bundle:ant
ant clean package
bundle:install-file
The install-file goal updates the local OBR with the details of a bundle from the local filesystem.
configuration:
obrRepository path to local OBR, defaults to <local-maven-repository>/repository.xml
groupId Maven groupId for the bundle, taken from pomFile if given
artifactId Maven artifactId for the bundle, taken from pomFile if given
version Maven version for the bundle, taken from pomFile if given
packaging Maven packaging type for the bundle, taken from pomFile if given
classifier Maven classifier type, defaults to none
pomFile optional Pom file describing the bundle
file bundle file, defaults to the bundle from the local Maven repository
obrXml optional additional properties for the bundle
The deploy goal updates the remote OBR with the details of
the deployed bundle from the local Maven repository. The remote OBR is
found by querying the <distributionManagement> section of the project, unless -DaltDeploymentRepository is set. See http://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html for more details about these particular settings.
(If the project has an obr.xml file somewhere in its resources, then it will be automatically detected and applied.)
configuration:
remoteOBR name of remote OBR, defaults to NONE (which means no remote OBR deployment)
obrRepository used when the remoteOBR name is blank, defaults to repository.xml
altDeploymentRepository alternative remote repository, id::layout::url
ignoreLock ignore remote locking when updating the OBR
This goal is part of the "bundle" packaging lifecycle, but is disabled by default - to enable just set the remoteOBR parameter.
bundle:deploy-file
The deploy-file goal updates the remote OBR with the details of a deployed bundle from the local filesystem. The remote OBR is found using the -DrepositoryId and -Durl parameters. See http://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html for more details about these particular settings.
You can use the -DbundleUrl parameter to give the public location of the deployed bundle, which may differ from the remote OBR location.
configuration:
remoteOBR name of remote OBR, defaults to an empty string
obrRepository used when the remoteOBR name is blank, defaults to repository.xml
repositoryId optional repository id, used to lookup authentication settings
url remote repository transport URL, like
scpexe://host/path/to/obr
bundleUrl public URL of deployed bundle, like
http://www.foo.org/bundles/foo.jar
groupId Maven groupId for the bundle, taken from pomFile if given
artifactId Maven artifactId for the bundle, taken from pomFile if given
version Maven version for the bundle, taken from pomFile if given
packaging Maven packaging type for the bundle, taken from pomFile if given
classifier Maven classifier type, defaults to none
pomFile optional Pom file describing the bundle
file bundle file, defaults to the bundle from the local Maven repository
obrXml optional additional properties for the bundle
ignoreLock ignore remote locking when updating the OBR
Sometimes you would like to clean your local OBR because it contains
bundles that are no longer in your local Maven repository. This case
often occurs when artifacts were deleted manually. The
maven-bundle-plugin provides a simple goal to check for missing
bundles, and remove them from the local OBR.
configuration:
obrRepository path to local OBR, defaults to <local-maven-repository>/repository.xml
Example:
mvn bundle:clean
Concurrent updates
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 -DignoreLock to the command-line (or add <ignoreLock>true<ignoreLock> to the configuration section of your Pom).
FTP protocol
Not all protocols are supported by Maven out of the box. For example the ftp protocol requires the wagon-ftp component. To enable the ftp protocol add this to your Pom:
Description: Provides a maven plugin that supports creating an OSGi bundle
from the contents of the compilation classpath along with its
resources and dependencies. Plus a zillion other features.
The plugin uses the Bnd tool (http://www.aqute.biz/Code/Bnd)
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: JTidy is a Java port of HTML Tidy, a HTML syntax checker and pretty printer. Like its non-Java cousin, JTidy can be used as a tool for cleaning up malformed and faulty HTML. In addition, JTidy provides a DOM parser for real-world HTML.
Description: xml-commons provides an Apache-hosted set of DOM, SAX, and
JAXP interfaces for use in other xml-based projects. Our hope is that we
can standardize on both a common version and packaging scheme for these
critical XML standards interfaces to make the lives of both our developers
and users easier. The External Components portion of xml-commons contains
interfaces that are defined by external standards organizations. For DOM,
that's the W3C; for SAX it's David Megginson and sax.sourceforge.net; for
JAXP it's Sun.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Provides a manager component which will process a given Throwable instance through a set of diagnostic
sub-components, and return a String message with user-friendly information about the error and possibly
how to fix it.
Description: This library is used to not only read Maven project object model files, but to assemble inheritence
and to retrieve remote models as required.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
Description: Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.
All files contained in this JAR are licensed under the Apache
2.0 license, unless noted differently in their source (see
swing2swt).: aQute Bundle Tool Library
This Maven 2 plugin is based on the BND tool from Peter Kriens. The way BND works is by treating your project as a big collection of classes (e.g., project code, dependencies, and the class path). The way you create a bundle with BND is to tell it the content of the bundle's JAR file as a subset of the available classes. This plugin wraps BND to make it work specifically with the Maven 2 project structure and to provide it with reasonable default behavior for Maven 2 projects.
Goals Overview
General Information about the goals.
bundle:bundle Create an OSGi bundle from Maven project. (life-cycle goal)
bundle:install Installs bundle details in the local OBR repository. (life-cycle goal)
bundle:deploy Deploys bundle details to a remote OBR repository. (life-cycle goal)
bundle:index Index the content of a maven repository using OBR.
bundle:install-file Installs bundle details in the local OBR repository. (command-line goal)
bundle:deploy-file Deploys bundle details to a remote OBR repository. (command-line goal)
bundle:clean Clean a local OBR repository by finding and removing missing resources.
bundle:remote-clean Clean a remote OBR repository by finding and removing missing resources.
bundle:ant Generate Ant script to create the bundle. (you should run ant:ant first)
Usage
General instructions on how to use the Maven Bundle Plugin can be found on the wiki page. Some more specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the Apache Felix developers guide.
Examples
To provide you with better understanding on some usages of the Maven Bundle Plugin, you can take a look into the following examples:
Typically the licenses listed for the project are that of the project itself, and not of dependencies.
Project License
The Apache Software License, Version 2.0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Deprecated. The wrap goal is no longer supported and may be removed in a future
release
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven
2.0
JDK
1.5
Memory
No minimum requirement.
Disk Space
No minimum requirement.
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>2.3.5</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>2.3.5</version>
</plugin>
...
</plugins>
</build>
...
</project>
This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
Provides a maven plugin that supports creating an OSGi bundle
from the contents of the compilation classpath along with its
resources and dependencies. Plus a zillion other features.
The plugin uses the Bnd tool (http://www.aqute.biz/Code/Bnd)
This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.
To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password)
$ svn commit --username your-username -m "A message"
Access from behind a firewall
For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection:
The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.)
There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created.
Example: Edit the 'servers' file and add something like:
A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.
The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.
Members
There are no developers working on this project.
Contributors
There are no contributors listed for this project. Please check back again later.
1package org.apache.felix.bundleplugin;
234/*5 * Licensed to the Apache Software Foundation (ASF) under one6 * or more contributor license agreements. See the NOTICE file7 * distributed with this work for additional information8 * regarding copyright ownership. The ASF licenses this file9 * to you under the Apache License, Version 2.0 (the10 * "License"); you may not use this file except in compliance11 * with the License. You may obtain a copy of the License at12 *13 * http://www.apache.org/licenses/LICENSE-2.014 *15 * Unless required by applicable law or agreed to in writing,16 * software distributed under the License is distributed on an17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY18 * KIND, either express or implied. See the License for the19 * specific language governing permissions and limitations20 * under the License.21 */2223import java.io.File;
2425import org.apache.maven.plugin.testing.stubs.ArtifactStub;
26import org.codehaus.plexus.PlexusTestCase;
272829/**30 * Common methods for bundle plugin testing31 * 32 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>33 * @version $Id: AbstractBundlePluginTest.html 1143000 2011-07-05 11:50:48Z mcculls $34 */35publicabstractclassAbstractBundlePluginTestextends PlexusTestCase
36 {
3738protected ArtifactStub getArtifactStub()
39 {
40 ArtifactStub artifact = new ArtifactStub();
41 artifact.setGroupId( "group" );
42 artifact.setArtifactId( "artifact" );
43 artifact.setVersion( "1.0" );
44return artifact;
45 }
464748protected File getTestBundle()
49 {
50 String osgiBundleFileName = "org.apache.maven.maven-model_2.1.0.SNAPSHOT.jar";
51return getTestFile( getBasedir(), "src/test/resources/" + osgiBundleFileName );
52 }
5354 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import java.io.FileOutputStream;
23import java.io.OutputStream;
24import java.util.Iterator;
25import java.util.Map;
26import java.util.Properties;
2728import org.apache.maven.plugin.MojoExecutionException;
29import org.apache.maven.project.MavenProject;
30import org.codehaus.plexus.util.FileUtils;
31import org.codehaus.plexus.util.IOUtil;
32import org.codehaus.plexus.util.StringUtils;
3334import aQute.lib.osgi.Builder;
35import aQute.lib.osgi.Jar;
363738/**39 * Generate Ant script to create the bundle (you should run ant:ant first).40 *41 * @goal ant42 * @requiresDependencyResolution test43 * @description generate Ant script to create the bundle44 */45publicclassAntPluginextendsBundlePlugin46 {
47staticfinal String BUILD_XML = "/build.xml";
48staticfinal String BUILD_BND = "/maven-build.bnd";
495051protectedvoid execute( MavenProject currentProject, Map originalInstructions, Properties properties,
52 Jar[] classpath ) throws MojoExecutionException
53 {
54final String artifactId = getProject().getArtifactId();
55final String baseDir = getProject().getBasedir().getPath();
5657try58 {
59// assemble bundle as usual, but don't save it - this way we have all the instructions we need60 Builder builder = buildOSGiBundle( currentProject, originalInstructions, properties, classpath );
61 Properties bndProperties = builder.getProperties();
6263// cleanup and remove all non-strings from the builder properties64for ( Iterator i = bndProperties.values().iterator(); i.hasNext(); )
65 {
66if ( !( i.next() instanceof String ) )
67 {
68 i.remove();
69 }
70 }
7172// save the BND generated bundle to the same output directory that maven uses73 bndProperties.setProperty( "-output", "${maven.build.dir}/${maven.build.finalName}.jar" );
7475 OutputStream out = new FileOutputStream( baseDir + BUILD_BND );
76 bndProperties.store( out, " Merged BND Instructions" );
77 IOUtil.close( out );
7879// modify build template80 String buildXml = IOUtil.toString( getClass().getResourceAsStream( BUILD_XML ) );
81 buildXml = StringUtils.replace( buildXml, "BND_VERSION", builder.getVersion() );
82 buildXml = StringUtils.replace( buildXml, "ARTIFACT_ID", artifactId );
8384 FileUtils.fileWrite( baseDir + BUILD_XML, buildXml );
8586// cleanup...87 builder.close();
88 }
89catch ( Exception e )
90 {
91thrownew MojoExecutionException( "Problem creating Ant script", e );
92 }
9394 getLog().info( "Wrote Ant bundle project for " + artifactId + " to " + baseDir );
95 }
96 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license3 * agreements. See the NOTICE file distributed with this work for additional information regarding4 * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the5 * "License"); you may not use this file except in compliance with the License. You may obtain a6 * copy of the License at7 * 8 * http://www.apache.org/licenses/LICENSE-2.09 * 10 * Unless required by applicable law or agreed to in writing, software distributed under the License11 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express12 * or implied. See the License for the specific language governing permissions and limitations under13 * the License.14 */15package org.apache.felix.bundleplugin;
161718import java.util.Collection;
19import java.util.HashMap;
20import java.util.HashSet;
21import java.util.Iterator;
22import java.util.Map;
23import java.util.Set;
2425import org.apache.maven.artifact.Artifact;
262728/**29 * Information result of the bundling process 30 * 31 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>32 * @version $Id: BundleInfo.html 1143000 2011-07-05 11:50:48Z mcculls $33 */34publicclassBundleInfo35 {
36/**37 * {@link Map} < {@link String}, {@link Set} < {@link Artifact} > >38 * Used to check for duplicated exports. Key is package name and value list of artifacts where it's exported.39 */40private Map m_exportedPackages = new HashMap();
414243publicvoid addExportedPackage( String packageName, Artifact artifact )
44 {
45 Set artifacts = ( Set ) getExportedPackages().get( packageName );
46if ( artifacts == null )
47 {
48 artifacts = new HashSet();
49 m_exportedPackages.put( packageName, artifacts );
50 }
51 artifacts.add( artifact );
52 }
535455protected Map getExportedPackages()
56 {
57return m_exportedPackages;
58 }
596061/**62 * Get a list of packages that are exported in more than one bundle.63 * Key is package name and value list of artifacts where it's exported.64 * @return {@link Map} < {@link String}, {@link Set} < {@link Artifact} > >65 */66public Map getDuplicatedExports()
67 {
68 Map duplicatedExports = new HashMap();
6970for ( Iterator it = getExportedPackages().entrySet().iterator(); it.hasNext(); )
71 {
72 Map.Entry entry = ( Map.Entry ) it.next();
73 Set artifacts = ( Set ) entry.getValue();
74if ( artifacts.size() > 1 )
75 {
76/* remove warnings caused by different versions of same artifact */77 Set artifactKeys = new HashSet();
7879 String packageName = ( String ) entry.getKey();
80for ( Iterator it2 = artifacts.iterator(); it2.hasNext(); )
81 {
82 Artifact artifact = ( Artifact ) it2.next();
83 artifactKeys.add( artifact.getGroupId() + "." + artifact.getArtifactId() );
84 }
8586if ( artifactKeys.size() > 1 )
87 {
88 duplicatedExports.put( packageName, artifacts );
89 }
90 }
91 }
9293return duplicatedExports;
94 }
959697publicvoid merge( BundleInfo bundleInfo )
98 {
99for ( Iterator it = bundleInfo.getExportedPackages().entrySet().iterator(); it.hasNext(); )
100 {
101 Map.Entry entry = ( Map.Entry ) it.next();
102 String packageName = ( String ) entry.getKey();
103 Collection artifacts = ( Collection ) entry.getValue();
104105 Collection artifactsWithPackage = ( Collection ) getExportedPackages().get( packageName );
106if ( artifactsWithPackage == null )
107 {
108 artifactsWithPackage = new HashSet();
109 getExportedPackages().put( packageName, artifactsWithPackage );
110 }
111 artifactsWithPackage.addAll( artifacts );
112 }
113 }
114 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import java.util.Collection;
23import java.util.HashSet;
2425import org.apache.maven.plugin.MojoExecutionException;
2627import aQute.libg.header.OSGiHeader;
282930/**31 * Exclude selected dependencies from the classpath passed to BND.32 * 33 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>34 */35publicfinalclassDependencyExcluderextendsAbstractDependencyFilter36 {
37/**38 * Excluded artifacts.39 */40privatefinal Collection m_excludedArtifacts;
414243publicDependencyExcluder( Collection dependencyArtifacts )
44 {
45super( dependencyArtifacts );
4647 m_excludedArtifacts = new HashSet();
48 }
495051publicvoid processHeaders( String excludeDependencies ) throws MojoExecutionException
52 {
53 m_excludedArtifacts.clear();
5455if ( null != excludeDependencies && excludeDependencies.length() > 0 )
56 {
57 processInstructions( OSGiHeader.parseHeader( excludeDependencies ) );
58 }
59 }
606162 @Override
63protectedvoid processDependencies( String tag, String inline, Collection dependencies )
64 {
65 m_excludedArtifacts.addAll( dependencies );
66 }
676869public Collection getExcludedArtifacts()
70 {
71return m_excludedArtifacts;
72 }
73 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import java.io.File;
23import java.io.FileNotFoundException;
24import java.io.IOException;
25import java.util.Map;
26import java.util.Properties;
2728import org.apache.maven.plugin.MojoExecutionException;
29import org.apache.maven.plugin.MojoFailureException;
30import org.apache.maven.project.MavenProject;
3132import aQute.lib.osgi.Jar;
333435/**36 * Generate BND instructions for this project37 * 38 * @goal instructions39 * @requiresDependencyResolution test40 * @threadSafe41 */42publicclassInstructionsPluginextendsBundlePlugin43 {
44protectedvoid execute( MavenProject project, Map instructions, Properties properties, Jar[] classpath )
45throws MojoExecutionException
46 {
47if ( dumpInstructions == null )
48 {
49 dumpInstructions = new File( getBuildDirectory(), "instructions.bnd" );
50 }
5152try53 {
54 addMavenInstructions( project, getOSGiBuilder( project, instructions, properties, classpath ) );
55 }
56catch ( FileNotFoundException e )
57 {
58thrownew MojoExecutionException( "Cannot find " + e.getMessage(), e );
59 }
60catch ( IOException e )
61 {
62thrownew MojoExecutionException( "Error trying to generate instructions", e );
63 }
64catch ( MojoFailureException e )
65 {
66 getLog().error( e.getLocalizedMessage() );
67thrownew MojoExecutionException( "Error(s) found in instructions", e );
68 }
69catch ( Exception e )
70 {
71 getLog().error( "An internal error occurred", e );
72thrownew MojoExecutionException( "Internal error in maven-bundle-plugin", e );
73 }
74 }
75 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import org.apache.maven.archiver.MavenArchiveConfiguration;
23import org.apache.maven.project.MavenProject;
24import org.codehaus.plexus.component.configurator.converters.composite.ObjectWithFieldsConverter;
25import org.codehaus.plexus.component.configurator.converters.lookup.ConverterLookup;
26import org.codehaus.plexus.component.configurator.converters.lookup.DefaultConverterLookup;
27import org.codehaus.plexus.component.configurator.expression.DefaultExpressionEvaluator;
28import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
29import org.codehaus.plexus.configuration.PlexusConfiguration;
30import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
31import org.codehaus.plexus.util.xml.Xpp3Dom;
323334/**35 * Provide access to the archive configuration from the jar plugin36 * 37 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>38 */39publicfinalclassJarPluginConfiguration40 {
41publicstatic MavenArchiveConfiguration getArchiveConfiguration( MavenProject project )
42 {
43 MavenArchiveConfiguration archiveConfig = new MavenArchiveConfiguration();
4445try46 {
47 ObjectWithFieldsConverter converter = new ObjectWithFieldsConverter();
48 ClassLoader loader = JarPluginConfiguration.class.getClassLoader();
49 ExpressionEvaluator evaluator = new DefaultExpressionEvaluator();
50 ConverterLookup converters = new DefaultConverterLookup();
5152 PlexusConfiguration settings = null;
5354try55 {
56// first look for bundle specific archive settings57 settings = getPluginConfiguration( project, "org.apache.felix", "maven-bundle-plugin" );
58 settings = settings.getChild( "archive" );
59 }
60catch ( Exception e )
61 {
62 }
6364// if it's empty fall back to the jar archive settings65if ( null == settings || settings.getChildCount() == 0 )
66 {
67 settings = getCorePluginConfiguration( project, "jar" );
68 settings = settings.getChild( "archive" );
69 }
7071 converter.processConfiguration( converters, archiveConfig, loader, settings, evaluator, null );
72 }
73catch ( Exception e )
74 {
75// ignore and return empty configuration...76 }
7778return archiveConfig;
79 }
808182privatestatic PlexusConfiguration getCorePluginConfiguration( MavenProject project, String pluginName )
83 {
84return getPluginConfiguration( project, "org.apache.maven.plugins", "maven-" + pluginName + "-plugin" );
85 }
868788privatestatic PlexusConfiguration getPluginConfiguration( MavenProject project, String groupId, String artifactId )
89 {
90 Xpp3Dom pluginConfig = project.getGoalConfiguration( groupId, artifactId, null, null );
9192returnnew XmlPlexusConfiguration( pluginConfig );
93 }
94 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import aQute.lib.osgi.Builder;
232425/**26 * Extension of {@link aQute.lib.osgi.Builder} to handle package versions27 * 28 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>29 */30publicfinalclassPackageVersionAnalyzerextends Builder
31 {
32/*33 * Remove META-INF subfolders from exports and set package versions to bundle version.34 */35/*36 public Map analyzeBundleClasspath( Jar dot, Map bundleClasspath, Map contained, Map referred, Map uses )37 throws IOException38 {39 Map classSpace = super.analyzeBundleClasspath( dot, bundleClasspath, contained, referred, uses );40 String bundleVersion = getProperty( BUNDLE_VERSION );41 for ( Iterator it = contained.entrySet().iterator(); it.hasNext(); )42 {43 Map.Entry entry = ( Map.Entry ) it.next();4445 // remove packages under META-INF46 String packageName = ( String ) entry.getKey();47 if ( packageName.startsWith( "META-INF." ) )48 {49 it.remove();50 }5152 // set package versions to bundle version values53 if ( bundleVersion != null )54 {55 Map values = ( Map ) entry.getValue();56 if ( values.get( "version" ) == null )57 {58 values.put( "version", bundleVersion );59 }60 }61 }62 return classSpace;63 }64 */65 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import java.util.LinkedHashMap;
23import java.util.Map;
2425import org.apache.maven.plugin.AbstractMojo;
26import org.apache.maven.plugin.MojoExecutionException;
27import org.apache.maven.plugin.MojoFailureException;
28import org.apache.maven.project.MavenProject;
29import org.apache.maven.shared.osgi.DefaultMaven2OsgiConverter;
30import org.apache.maven.shared.osgi.Maven2OsgiConverter;
313233/**34 * @goal cleanVersions35 * @description clean OSGi versions36 * @threadSafe37 */38publicclassVersionCleanerPluginextends AbstractMojo
39 {
4041/**42 * The BND instructions for the bundle.43 *44 * @parameter45 */46private Map versions = new LinkedHashMap();
4748/**49 * The Maven project.50 *51 * @parameter expression="${project}"52 * @required53 * @readonly54 */55private MavenProject project;
5657private Maven2OsgiConverter maven2OsgiConverter = new DefaultMaven2OsgiConverter();
585960public Maven2OsgiConverter getMaven2OsgiConverter()
61 {
62return maven2OsgiConverter;
63 }
646566publicvoid setMaven2OsgiConverter( Maven2OsgiConverter maven2OsgiConverter )
67 {
68this.maven2OsgiConverter = maven2OsgiConverter;
69 }
707172publicvoid execute() throws MojoExecutionException, MojoFailureException
73 {
74for ( Object key : versions.keySet() )
75 {
76 String name = ( String ) key;
77 String version = ( String ) versions.get( key );
78 String osgi = maven2OsgiConverter.getVersion( version );
79 project.getProperties().put( name, osgi );
80 }
81 }
82 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.bundleplugin;
202122import org.apache.maven.plugin.MojoExecutionException;
232425/**26 * @goal wrap27 * @phase package28 * @requiresDependencyResolution test29 * @description build an OSGi bundle jar for direct dependencies30 * @deprecated The wrap goal is no longer supported and may be removed in a future release31 */32 @Deprecated
33publicfinalclassWrapPluginextendsBundleAllPlugin34 {
35publicvoid execute() throws MojoExecutionException
36 {
37 getLog().warn( "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" );
38 getLog().warn( "! The wrap goal is no longer supported and may be removed in a future release !" );
39 getLog().warn( "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" );
4041BundleInfo bundleInfo = bundleAll( getProject(), 1 );
42 logDuplicatedPackages( bundleInfo );
43 }
44 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.obrplugin;
202122import java.io.File;
2324import org.apache.maven.artifact.Artifact;
25import org.apache.maven.artifact.factory.ArtifactFactory;
26import org.apache.maven.plugin.AbstractMojo;
27import org.apache.maven.plugin.MojoExecutionException;
28import org.apache.maven.project.MavenProject;
293031/**32 * Base class for the command-line install-file and deploy-file goals.33 * 34 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>35 */36publicabstractclassAbstractFileMojoextends AbstractMojo
37 {
38/**39 * GroupId of the bundle. Retrieved from POM file if specified.40 *41 * @parameter expression="${groupId}"42 */43private String groupId;
4445/**46 * ArtifactId of the bundle. Retrieved from POM file if specified.47 *48 * @parameter expression="${artifactId}"49 */50private String artifactId;
5152/**53 * Version of the bundle. Retrieved from POM file if specified.54 *55 * @parameter expression="${version}"56 */57private String version;
5859/**60 * Packaging type of the bundle. Retrieved from POM file if specified.61 *62 * @parameter expression="${packaging}"63 */64private String packaging;
6566/**67 * Classifier type of the bundle. Defaults to none.68 *69 * @parameter expression="${classifier}"70 */71private String classifier;
7273/**74 * Location of an existing POM file.75 *76 * @parameter expression="${pomFile}"77 */78private File pomFile;
7980/**81 * Bundle file, defaults to the artifact in the local Maven repository.82 *83 * @parameter expression="${file}"84 */85protected File file;
8687/**88 * Optional XML file describing additional requirements and capabilities.89 * 90 * @parameter expression="${obrXml}"91 */92protected String obrXml;
9394/**95 * Component factory for Maven artifacts96 * 97 * @component98 */99private ArtifactFactory m_factory;
100101102/**103 * @return project based on command-line settings, with bundle attached104 * @throws MojoExecutionException105 */106public MavenProject getProject() throws MojoExecutionException
107 {
108final MavenProject project;
109if ( pomFile != null && pomFile.exists() )
110 {
111 project = PomHelper.readPom( pomFile );
112113 groupId = project.getGroupId();
114 artifactId = project.getArtifactId();
115 version = project.getVersion();
116 packaging = project.getPackaging();
117 }
118else119 {
120 project = PomHelper.buildPom( groupId, artifactId, version, packaging );
121 }
122123if ( groupId == null || artifactId == null || version == null || packaging == null )
124 {
125thrownew MojoExecutionException( "Missing group, artifact, version, or packaging information" );
126 }
127128 Artifact bundle = m_factory.createArtifactWithClassifier( groupId, artifactId, version, packaging, classifier );
129 project.setArtifact( bundle );
130131return project;
132 }
133 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.obrplugin;
202122import java.net.URI;
232425/**26 * this class is used to store some user information about configuration of the plugin.27 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>28 *29 */30publicclassConfig31 {
32privateboolean m_pathRelative; // use relative or absolute path in repository.xml33privateboolean m_remoteFile; // deploy file on remote server34private URI m_remoteBundle; // public address of deployed bundle353637/**38 * constructor: set default configuration: use relative path and don't upload file.39 */40publicConfig()
41 {
42// default configuration43 m_pathRelative = true;
44 m_remoteFile = false;
45 m_remoteBundle = null;
46 }
474849/**50 * @param value enable to use relative path51 */52publicvoid setPathRelative( boolean value )
53 {
54 m_pathRelative = value;
55 }
565758/**59 * @param value enable when uploading60 */61publicvoid setRemoteFile( boolean value )
62 {
63 m_remoteFile = value;
64 }
656667/**68 * @param value public address of deployed bundle69 */70publicvoid setRemoteBundle( URI value )
71 {
72 m_remoteBundle = value;
73 }
747576/**77 * @return true if plugin uses relative path, else false78 */79publicboolean isPathRelative()
80 {
81return m_pathRelative;
82 }
838485/**86 * @return true if the file will be uploaded, else false87 */88publicboolean isRemoteFile()
89 {
90return m_remoteFile;
91 }
929394/**95 * @return public address of deployed bundle96 */97public URI getRemoteBundle()
98 {
99return m_remoteBundle;
100 }
101 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.obrplugin;
202122import java.io.File;
23import java.io.FileNotFoundException;
24import java.io.FileReader;
25import java.io.IOException;
26import java.io.Reader;
2728import org.apache.maven.model.Model;
29import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
30import org.apache.maven.plugin.MojoExecutionException;
31import org.apache.maven.project.MavenProject;
32import org.codehaus.plexus.util.IOUtil;
33import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
343536/**37 * Maven POM helper methods.38 * 39 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>40 */41publicfinalclassPomHelper42 {
43publicstatic MavenProject readPom( File pomFile ) throws MojoExecutionException
44 {
45 Reader reader = null;
4647try48 {
49 reader = new FileReader( pomFile );
50 MavenXpp3Reader modelReader = new MavenXpp3Reader();
51returnnew MavenProject( modelReader.read( reader ) );
52 }
53catch ( FileNotFoundException e )
54 {
55thrownew MojoExecutionException( "Error reading specified POM file: " + e.getMessage(), e );
56 }
57catch ( IOException e )
58 {
59thrownew MojoExecutionException( "Error reading specified POM file: " + e.getMessage(), e );
60 }
61catch ( XmlPullParserException e )
62 {
63thrownew MojoExecutionException( "Error reading specified POM file: " + e.getMessage(), e );
64 }
65finally66 {
67 IOUtil.close( reader );
68 }
69 }
707172publicstatic MavenProject buildPom( String groupId, String artifactId, String version, String packaging )
73 {
74 Model model = new Model();
7576 model.setModelVersion( "4.0.0" );
77 model.setGroupId( groupId );
78 model.setArtifactId( artifactId );
79 model.setVersion( version );
80 model.setPackaging( packaging );
8182returnnew MavenProject( model );
83 }
84 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.felix.obrplugin;
202122import org.w3c.dom.Node;
23import org.w3c.dom.NodeList;
242526/**27 * Provide XML helper methods to support pre-Java5 runtimes28 * 29 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>30 */31publicclassXmlHelper32 {
33/**34 * based on public Java5 javadoc of org.w3c.dom.Node.getTextContent method35 */36publicstatic String getTextContent( Node node )
37 {
38switch ( node.getNodeType() )
39 {
40case Node.ELEMENT_NODE:
41case Node.ATTRIBUTE_NODE:
42case Node.ENTITY_NODE:
43case Node.ENTITY_REFERENCE_NODE:
44case Node.DOCUMENT_FRAGMENT_NODE:
45return mergeTextContent( node.getChildNodes() );
46case Node.TEXT_NODE:
47case Node.CDATA_SECTION_NODE:
48case Node.COMMENT_NODE:
49case Node.PROCESSING_INSTRUCTION_NODE:
50return node.getNodeValue();
51case Node.DOCUMENT_NODE:
52case Node.DOCUMENT_TYPE_NODE:
53case Node.NOTATION_NODE:
54default:
55returnnull;
56 }
57 }
585960/**61 * based on the following quote from public Java5 javadoc of org.w3c.dom.Node.getTextContent method:62 * 63 * "concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and64 * PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children"65 */66privatestatic String mergeTextContent( NodeList nodes )
67 {
68 StringBuffer buf = new StringBuffer();
69for ( int i = 0; i < nodes.getLength(); i++ )
70 {
71 Node n = nodes.item( i );
72final String text;
7374switch ( n.getNodeType() )
75 {
76case Node.COMMENT_NODE:
77case Node.PROCESSING_INSTRUCTION_NODE:
78 text = null;
79break;
80default:
81 text = getTextContent( n );
82break;
83 }
8485if ( text != null )
86 {
87 buf.append( text );
88 }
89 }
90return buf.toString();
91 }
929394/**95 * based on public Java5 javadoc of org.w3c.dom.Node.setTextContent method96 */97publicstaticvoid setTextContent( Node node, final String text )
98 {
99while ( node.hasChildNodes() )
100 {
101 node.removeChild( node.getFirstChild() );
102 }
103104if ( text != null && text.length() > 0 )
105 {
106 Node textNode = node.getOwnerDocument().createTextNode( text );
107 node.appendChild( textNode );
108 }
109 }
110 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.maven.shared.osgi;
202122/**23 * Exception while reading the manifest. Encapsulates an IOException to make it runtime24 * 25 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>26 * @version $Id: ManifestReadingException.html 1143000 2011-07-05 11:50:48Z mcculls $27 */28publicclassManifestReadingExceptionextends RuntimeException
29 {
3031publicManifestReadingException()
32 {
33super();
34 }
353637publicManifestReadingException( String message, Throwable cause )
38 {
39super( message, cause );
40 }
414243publicManifestReadingException( String message )
44 {
45super( message );
46 }
474849publicManifestReadingException( Throwable cause )
50 {
51super( cause );
52 }
53 }
1/*2 * Licensed to the Apache Software Foundation (ASF) under one3 * or more contributor license agreements. See the NOTICE file4 * distributed with this work for additional information5 * regarding copyright ownership. The ASF licenses this file6 * to you under the Apache License, Version 2.0 (the7 * "License"); you may not use this file except in compliance8 * with the License. You may obtain a copy of the License at9 *10 * http://www.apache.org/licenses/LICENSE-2.011 *12 * Unless required by applicable law or agreed to in writing,13 * software distributed under the License is distributed on an14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY15 * KIND, either express or implied. See the License for the16 * specific language governing permissions and limitations17 * under the License.18 */19package org.apache.maven.shared.osgi;
202122import org.apache.maven.artifact.Artifact;
232425/**26 * Converter from Maven groupId,artifactId and versions to OSGi Bundle-SymbolicName and version27 * 28 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>29 * @version $Id: Maven2OsgiConverter.html 1143000 2011-07-05 11:50:48Z mcculls $30 */31publicinterface Maven2OsgiConverter
32 {
3334/**35 * Get the OSGi symbolic name for the artifact36 * 37 * @param artifact38 * @return the Bundle-SymbolicName manifest property39 */40 String getBundleSymbolicName( Artifact artifact );
414243 String getBundleFileName( Artifact artifact );
444546/**47 * Convert a Maven version into an OSGi compliant version48 * 49 * @param artifact Maven artifact50 * @return the OSGi version51 */52 String getVersion( Artifact artifact );
535455/**56 * Convert a Maven version into an OSGi compliant version57 * 58 * @param version Maven version59 * @return the OSGi version60 */61 String getVersion( String version );
6263 }
if artifact.getFile is not null and the jar contains a OSGi Manifest with
* Bundle-SymbolicName property then that value is returned
*
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
*
if artifactId is equal to last section of groupId then groupId is returned. eg.
* org.apache.maven:maven -> org.apache.maven
*
if artifactId starts with last section of groupId that portion is removed. eg.
* org.apache.maven:maven-core -> org.apache.maven.core
*
*/
public String getBundleSymbolicName( Artifact artifact )
{
if ( ( artifact.getFile() != null ) && artifact.getFile().isFile() )
{
Analyzer analyzer = new Analyzer();
JarFile jar = null;
try
{
jar = new JarFile( artifact.getFile(), false );
if ( jar.getManifest() != null )
{
String symbolicNameAttribute = jar.getManifest().getMainAttributes()
.getValue( Analyzer.BUNDLE_SYMBOLICNAME );
Map bundleSymbolicNameHeader = analyzer.parseHeader( symbolicNameAttribute );
Iterator it = bundleSymbolicNameHeader.keySet().iterator();
if ( it.hasNext() )
{
return ( String ) it.next();
}
}
}
catch ( IOException e )
{
throw new ManifestReadingException( "Error reading manifest in jar "
+ artifact.getFile().getAbsolutePath(), e );
}
finally
{
if ( jar != null )
{
try
{
jar.close();
}
catch ( IOException e )
{
}
}
}
}
int i = artifact.getGroupId().lastIndexOf( '.' );
if ( ( i < 0 ) && ( artifact.getFile() != null ) && artifact.getFile().isFile() )
{
String groupIdFromPackage = getGroupIdFromPackage( artifact.getFile() );
if ( groupIdFromPackage != null )
{
return groupIdFromPackage;
}
}
String lastSection = artifact.getGroupId().substring( ++i );
if ( artifact.getArtifactId().equals( lastSection ) )
{
return artifact.getGroupId();
}
if ( artifact.getArtifactId().startsWith( lastSection ) )
{
String artifactId = artifact.getArtifactId().substring( lastSection.length() );
if ( Character.isLetterOrDigit( artifactId.charAt( 0 ) ) )
{
return getBundleSymbolicName( artifact.getGroupId(), artifactId );
}
else
{
return getBundleSymbolicName( artifact.getGroupId(), artifactId.substring( 1 ) );
}
}
return getBundleSymbolicName( artifact.getGroupId(), artifact.getArtifactId() );
}
private String getGroupIdFromPackage( File artifactFile )
{
try
{
/* get package names from jar */
Set packageNames = new HashSet();
JarFile jar = new JarFile( artifactFile, false );
Enumeration entries = jar.entries();
while ( entries.hasMoreElements() )
{
ZipEntry entry = ( ZipEntry ) entries.nextElement();
if ( entry.getName().endsWith( ".class" ) )
{
File f = new File( entry.getName() );
String packageName = f.getParent();
if ( packageName != null )
{
packageNames.add( packageName );
}
}
}
jar.close();
/* find the top package */
String[] groupIdSections = null;
for ( Iterator it = packageNames.iterator(); it.hasNext(); )
{
String packageName = ( String ) it.next();
String[] packageNameSections = packageName.split( "\\" + FILE_SEPARATOR );
if ( groupIdSections == null )
{
/* first candidate */
groupIdSections = packageNameSections;
}
else
// if ( packageNameSections.length < groupIdSections.length )
{
/*
* find the common portion of current package and previous selected groupId
*/
int i;
for ( i = 0; ( i < packageNameSections.length ) && ( i < groupIdSections.length ); i++ )
{
if ( !packageNameSections[i].equals( groupIdSections[i] ) )
{
break;
}
}
groupIdSections = new String[i];
System.arraycopy( packageNameSections, 0, groupIdSections, 0, i );
}
}
if ( ( groupIdSections == null ) || ( groupIdSections.length == 0 ) )
{
return null;
}
/* only one section as id doesn't seem enough, so ignore it */
if ( groupIdSections.length == 1 )
{
return null;
}
StringBuffer sb = new StringBuffer();
for ( int i = 0; i < groupIdSections.length; i++ )
{
sb.append( groupIdSections[i] );
if ( i < groupIdSections.length - 1 )
{
sb.append( '.' );
}
}
return sb.toString();
}
catch ( IOException e )
{
/* we took all the precautions to avoid this */
throw new RuntimeException( e );
}
}
public String getBundleFileName( Artifact artifact )
{
return getBundleSymbolicName( artifact ) + "_" + getVersion( artifact.getVersion() ) + ".jar";
}
public String getVersion( Artifact artifact )
{
return getVersion( artifact.getVersion() );
}
public String getVersion( String version )
{
return cleanupVersion( version );
}
/**
* Clean up version parameters. Other builders use more fuzzy definitions of
* the version syntax. This method cleans up such a version to match an OSGi
* version.
*
* @param VERSION_STRING
* @return
*/
static final Pattern FUZZY_VERSION = Pattern.compile( "(\\d+)(\\.(\\d+)(\\.(\\d+))?)?([^a-zA-Z0-9](.*))?",
Pattern.DOTALL );
static public String cleanupVersion( String version )
{
StringBuffer result = new StringBuffer();
Matcher m = FUZZY_VERSION.matcher( version );
if ( m.matches() )
{
String major = m.group( 1 );
String minor = m.group( 3 );
String micro = m.group( 5 );
String qualifier = m.group( 7 );
if ( major != null )
{
result.append( major );
if ( minor != null )
{
result.append( "." );
result.append( minor );
if ( micro != null )
{
result.append( "." );
result.append( micro );
if ( qualifier != null )
{
result.append( "." );
cleanupModifier( result, qualifier );
}
}
else if ( qualifier != null )
{
result.append( ".0." );
cleanupModifier( result, qualifier );
}
else
{
result.append( ".0" );
}
}
else if ( qualifier != null )
{
result.append( ".0.0." );
cleanupModifier( result, qualifier );
}
else
{
result.append( ".0.0" );
}
}
}
else
{
result.append( "0.0.0." );
cleanupModifier( result, version );
}
return result.toString();
}
static void cleanupModifier( StringBuffer result, String modifier )
{
for ( int i = 0; i < modifier.length(); i++ )
{
char c = modifier.charAt( i );
if ( ( c >= '0' && c <= '9' ) || ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || c == '_'
|| c == '-' )
result.append( c );
else
result.append( '_' );
}
}
}
maven-bundle-plugin-2.3.5/src/main/java/org/apache/maven/shared/osgi/ManifestReadingException.java 0000664 0000000 0000000 00000003003 11645647261 0033145 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.shared.osgi;
/**
* Exception while reading the manifest. Encapsulates an IOException to make it runtime
*
* @author Carlos Sanchez
* @version $Id: ManifestReadingException.java 661727 2008-05-30 14:21:49Z bentmann $
*/
public class ManifestReadingException extends RuntimeException
{
public ManifestReadingException()
{
super();
}
public ManifestReadingException( String message, Throwable cause )
{
super( message, cause );
}
public ManifestReadingException( String message )
{
super( message );
}
public ManifestReadingException( Throwable cause )
{
super( cause );
}
}
maven-bundle-plugin-2.3.5/src/main/java/org/apache/maven/shared/osgi/Maven2OsgiConverter.java 0000664 0000000 0000000 00000003473 11645647261 0032103 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.shared.osgi;
import org.apache.maven.artifact.Artifact;
/**
* Converter from Maven groupId,artifactId and versions to OSGi Bundle-SymbolicName and version
*
* @author Carlos Sanchez
* @version $Id: Maven2OsgiConverter.java 661727 2008-05-30 14:21:49Z bentmann $
*/
public interface Maven2OsgiConverter
{
/**
* Get the OSGi symbolic name for the artifact
*
* @param artifact
* @return the Bundle-SymbolicName manifest property
*/
String getBundleSymbolicName( Artifact artifact );
String getBundleFileName( Artifact artifact );
/**
* Convert a Maven version into an OSGi compliant version
*
* @param artifact Maven artifact
* @return the OSGi version
*/
String getVersion( Artifact artifact );
/**
* Convert a Maven version into an OSGi compliant version
*
* @param version Maven version
* @return the OSGi version
*/
String getVersion( String version );
} maven-bundle-plugin-2.3.5/src/main/resources/ 0000775 0000000 0000000 00000000000 11645647261 0021133 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/META-INF/ 0000775 0000000 0000000 00000000000 11645647261 0022273 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/META-INF/plexus/ 0000775 0000000 0000000 00000000000 11645647261 0023613 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/META-INF/plexus/components.xml 0000664 0000000 0000000 00000005506 11645647261 0026530 0 ustar 00root root 0000000 0000000
org.apache.maven.lifecycle.mapping.LifecycleMappingbundleorg.apache.maven.lifecycle.mapping.DefaultLifecycleMappingdefaultorg.apache.maven.plugins:maven-resources-plugin:resourcesorg.apache.maven.plugins:maven-compiler-plugin:compileorg.apache.maven.plugins:maven-resources-plugin:testResourcesorg.apache.maven.plugins:maven-compiler-plugin:testCompileorg.apache.maven.plugins:maven-surefire-plugin:testorg.apache.felix:maven-bundle-plugin:bundle
org.apache.maven.plugins:maven-install-plugin:install,
org.apache.felix:maven-bundle-plugin:install
org.apache.maven.plugins:maven-deploy-plugin:deploy,
org.apache.felix:maven-bundle-plugin:deploy
org.apache.maven.artifact.handler.ArtifactHandlerbundleorg.apache.maven.artifact.handler.DefaultArtifactHandlerbundlefalsejavajartruebundle
maven-bundle-plugin-2.3.5/src/main/resources/SchemaObr.xsd 0000664 0000000 0000000 00000007421 11645647261 0023522 0 ustar 00root root 0000000 0000000
maven-bundle-plugin-2.3.5/src/main/resources/build.xml 0000664 0000000 0000000 00000005351 11645647261 0022760 0 ustar 00root root 0000000 0000000
maven-bundle-plugin-2.3.5/src/main/resources/org/ 0000775 0000000 0000000 00000000000 11645647261 0021722 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/org/apache/ 0000775 0000000 0000000 00000000000 11645647261 0023143 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/org/apache/felix/ 0000775 0000000 0000000 00000000000 11645647261 0024252 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/org/apache/felix/bundleplugin/ 0000775 0000000 0000000 00000000000 11645647261 0026742 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/main/resources/org/apache/felix/bundleplugin/blueprint.xsl 0000664 0000000 0000000 00000016172 11645647261 0031505 0 ustar 00root root 0000000 0000000
Import-Package:org.osgi.service.blueprint;version="[1.0.0,2.0.0)"
maven-bundle-plugin-2.3.5/src/site/ 0000775 0000000 0000000 00000000000 11645647261 0017141 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/site/apt/ 0000775 0000000 0000000 00000000000 11645647261 0017725 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/site/apt/index.apt 0000664 0000000 0000000 00000011023 11645647261 0021537 0 ustar 00root root 0000000 0000000 ------
Introduction
------
Stuart McCulloch
------
2011-06-28
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License. You may obtain a copy of the License at
~~
~~ http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Maven Bundle Plugin
This Maven 2 plugin is based on the {{{http://www.aqute.biz/Bnd/Bnd/}BND}} tool from Peter Kriens. The way BND works is by treating your project as a big collection of classes (e.g., project code, dependencies, and the class path). The way you create a bundle with BND is to tell it the content of the bundle's JAR file as a subset of the available classes. This plugin wraps BND to make it work specifically with the Maven 2 project structure and to provide it with reasonable default behavior for Maven 2 projects.
* Goals Overview
General Information about the goals.
* {{{./bundle-mojo.html}bundle:bundle}} Create an OSGi bundle from Maven project. (life-cycle goal)
* {{{./manifest-mojo.html}bundle:manifest}} Generate an OSGi manifest for this project.
* {{{./cleanVersions-mojo.html}bundle:cleanVersions}} Convert a group of versions to OSGi format.
* {{{./instructions-mojo.html}bundle:instructions}} Generate BND instructions for this project.
* {{{./install-mojo.html}bundle:install}} Installs bundle details in the local OBR repository. (life-cycle goal)
* {{{./deploy-mojo.html}bundle:deploy}} Deploys bundle details to a remote OBR repository. (life-cycle goal)
* {{{./index-mojo.html}bundle:index}} Index the content of a maven repository using OBR.
* {{{./install-file-mojo.html}bundle:install-file}} Installs bundle details in the local OBR repository. (command-line goal)
* {{{./deploy-file-mojo.html}bundle:deploy-file}} Deploys bundle details to a remote OBR repository. (command-line goal)
* {{{./clean-mojo.html}bundle:clean}} Clean a local OBR repository by finding and removing missing resources.
* {{{./remote-clean-mojo.html}bundle:remote-clean}} Clean a remote OBR repository by finding and removing missing resources.
* {{{./ant-mojo.html}bundle:ant}} Generate Ant script to create the bundle. (you should run ant:ant first)
[]
* Usage
General instructions on how to use the Maven Bundle Plugin can be found on the
{{{http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html}wiki page}}.
Some more specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage, please have a look at the
{{{http://felix.apache.org/site/apache-felix-bundle-plugin-faq.html}FAQ}} and feel
free to contact the {{{http://felix.apache.org/site/mailinglists.html}user mailing list}}.
The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{http://www.mail-archive.com/users@felix.apache.org/}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
{{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{http://felix.apache.org/site/development.html}Apache Felix developers guide}}.
* Examples
To provide you with better understanding on some usages of the Maven Bundle Plugin,
you can take a look into the following examples:
* Examples coming soon!
maven-bundle-plugin-2.3.5/src/site/site.xml 0000664 0000000 0000000 00000002437 11645647261 0020635 0 ustar 00root root 0000000 0000000
maven-bundle-plugin-2.3.5/src/test/ 0000775 0000000 0000000 00000000000 11645647261 0017154 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/ 0000775 0000000 0000000 00000000000 11645647261 0020075 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/org/ 0000775 0000000 0000000 00000000000 11645647261 0020664 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/org/apache/ 0000775 0000000 0000000 00000000000 11645647261 0022105 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/ 0000775 0000000 0000000 00000000000 11645647261 0023214 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/ 0000775 0000000 0000000 00000000000 11645647261 0025704 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/AbstractBundlePluginTest.java 0000664 0000000 0000000 00000003313 11645647261 0033463 0 ustar 00root root 0000000 0000000 package org.apache.felix.bundleplugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import org.apache.maven.plugin.testing.stubs.ArtifactStub;
import org.codehaus.plexus.PlexusTestCase;
/**
* Common methods for bundle plugin testing
*
* @author Carlos Sanchez
* @version $Id: AbstractBundlePluginTest.java 616180 2008-01-29 06:22:10Z mcculls $
*/
public abstract class AbstractBundlePluginTest extends PlexusTestCase
{
protected ArtifactStub getArtifactStub()
{
ArtifactStub artifact = new ArtifactStub();
artifact.setGroupId( "group" );
artifact.setArtifactId( "artifact" );
artifact.setVersion( "1.0" );
return artifact;
}
protected File getTestBundle()
{
String osgiBundleFileName = "org.apache.maven.maven-model_2.1.0.SNAPSHOT.jar";
return getTestFile( getBasedir(), "src/test/resources/" + osgiBundleFileName );
}
} maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/BlueprintComponentTest.java 0000664 0000000 0000000 00000007214 11645647261 0033242 0 ustar 00root root 0000000 0000000 /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.felix.bundleplugin;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.jar.Manifest;
import junit.framework.TestCase;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
import org.osgi.framework.Constants;
import aQute.lib.osgi.Builder;
public class BlueprintComponentTest extends TestCase
{
public void testBlueprint() throws Exception
{
MavenProjectStub project = new MavenProjectStub()
{
private final List resources = new ArrayList();
@Override
public void addResource( Resource resource )
{
resources.add( resource );
}
@Override
public List getResources()
{
return resources;
}
@Override
public File getBasedir()
{
return new File( "target/tmp/basedir" );
}
};
project.setGroupId( "group" );
project.setArtifactId( "artifact" );
project.setVersion( "1.1.0.0" );
Resource r = new Resource();
r.setDirectory( new File( "src/test/resources" ).getAbsoluteFile().getCanonicalPath() );
r.setIncludes( Arrays.asList( "**/*.*" ) );
project.addResource( r );
project.addCompileSourceRoot( new File( "src/test/resources" ).getAbsoluteFile().getCanonicalPath() );
ManifestPlugin plugin = new ManifestPlugin();
plugin.setBuildDirectory( "target/tmp/basedir/target" );
plugin.setOutputDirectory( new File( "target/tmp/basedir/target/classes" ) );
Map instructions = new HashMap();
instructions.put( "Test", "Foo" );
instructions.put( "nsh_interface", "foo.bar.Namespace" );
instructions.put( "nsh_namespace", "ns" );
instructions.put( "Export-Service", "p7.Foo;mk=mv" );
instructions.put( "Import-Service", "org.osgi.service.cm.ConfigurationAdmin;availability:=optional" );
Properties props = new Properties();
Builder builder = plugin.buildOSGiBundle( project, instructions, props, plugin.getClasspath( project ) );
Manifest manifest = builder.getJar().getManifest();
String expSvc = manifest.getMainAttributes().getValue( Constants.EXPORT_SERVICE );
String impSvc = manifest.getMainAttributes().getValue( Constants.IMPORT_SERVICE );
assertNotNull( expSvc );
assertNotNull( impSvc );
String impPkg = manifest.getMainAttributes().getValue( Constants.IMPORT_PACKAGE );
List pkgs = Arrays.asList( impPkg.split( "," ) );
for ( int i = 1; i <= 13; i++ )
{
assertTrue( pkgs.contains( "p" + i ) );
}
}
}
maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/BundleAllPluginTest.java 0000664 0000000 0000000 00000011656 11645647261 0032441 0 ustar 00root root 0000000 0000000 package org.apache.felix.bundleplugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.Collections;
import java.util.Map;
import org.apache.maven.plugin.testing.stubs.ArtifactStub;
import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.osgi.DefaultMaven2OsgiConverter;
/**
* Test for {@link BundleAllPlugin}
*
* @author Felix Project Team
*/
public class BundleAllPluginTest extends AbstractBundlePluginTest
{
private BundleAllPlugin plugin;
protected void setUp() throws Exception
{
super.setUp();
init();
}
private void init()
{
plugin = new BundleAllPlugin();
File baseDirectory = new File( getBasedir() );
File buildDirectory = new File( baseDirectory, "target" );
plugin.setBuildDirectory( buildDirectory.getPath() );
File outputDirectory = new File( buildDirectory, "test-classes" );
plugin.setOutputDirectory( outputDirectory );
plugin.setMaven2OsgiConverter( new DefaultMaven2OsgiConverter() );
}
public void testSnapshotMatch()
{
ArtifactStub artifact = getArtifactStub();
String bundleName;
artifact.setVersion( "2.1-SNAPSHOT" );
bundleName = "group.artifact_2.1.0.20070207_193904_2.jar";
assertTrue( plugin.snapshotMatch( artifact, bundleName ) );
artifact.setVersion( "2-SNAPSHOT" );
assertFalse( plugin.snapshotMatch( artifact, bundleName ) );
artifact.setArtifactId( "artifactx" );
artifact.setVersion( "2.1-SNAPSHOT" );
assertFalse( plugin.snapshotMatch( artifact, bundleName ) );
}
public void testNoReBundling() throws Exception
{
File testFile = getTestFile( "target/test-classes/org.apache.maven.maven-model_1.0.0.0.jar" );
if ( testFile.exists() )
{
testFile.delete();
}
ArtifactStub artifact = new ArtifactStub();
artifact.setGroupId( "group" );
artifact.setArtifactId( "artifact" );
artifact.setVersion( "1.0.0.0" );
MavenProject project = new MavenProjectStub();
project.setGroupId( artifact.getGroupId() );
project.setArtifactId( artifact.getArtifactId() );
project.setVersion( artifact.getVersion() );
project.setArtifact( artifact );
project.setArtifacts( Collections.EMPTY_SET );
project.setDependencyArtifacts( Collections.EMPTY_SET );
File bundleFile = getTestFile( "src/test/resources/org.apache.maven.maven-model_2.1.0.SNAPSHOT.jar" );
artifact.setFile( bundleFile );
BundleInfo bundleInfo = plugin.bundle( project );
Map exports = bundleInfo.getExportedPackages();
String[] packages = new String[]
{ "org.apache.maven.model.io.jdom", "org.apache.maven.model" };
for ( int i = 0; i < packages.length; i++ )
{
assertTrue( "Bundle info does not contain a package that it is exported in the manifest: " + packages[i],
exports.containsKey( packages[i] ) );
}
assertFalse( "Bundle info contains a package that it is not exported in the manifest",
exports.containsKey( "org.apache.maven.model.io.xpp3" ) );
}
// public void testRewriting()
// throws Exception
// {
//
// MavenProjectStub project = new MavenProjectStub();
// project.setArtifact( getArtifactStub() );
// project.getArtifact().setFile( getTestBundle() );
// project.setDependencyArtifacts( Collections.EMPTY_SET );
// project.setVersion( project.getArtifact().getVersion() );
//
// File output = new File( plugin.getBuildDirectory(), plugin.getBundleName( project ) );
// boolean delete = output.delete();
//
// plugin.bundle( project );
//
// init();
// try
// {
// plugin.bundle( project );
// fail();
// }
// catch ( RuntimeException e )
// {
// // expected
// }
// }
}
maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/BundlePluginTest.java 0000664 0000000 0000000 00000017044 11645647261 0032005 0 ustar 00root root 0000000 0000000 package org.apache.felix.bundleplugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.Map;
import java.util.Properties;
import java.util.TreeMap;
import org.apache.maven.model.Organization;
import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.osgi.DefaultMaven2OsgiConverter;
import aQute.lib.osgi.Analyzer;
import aQute.lib.osgi.Builder;
import aQute.lib.osgi.Jar;
/**
* Test for {@link BundlePlugin}.
*
* @author Felix Project Team
*/
public class BundlePluginTest extends AbstractBundlePluginTest
{
private BundlePlugin plugin;
protected void setUp() throws Exception
{
super.setUp();
plugin = new BundlePlugin();
plugin.setMaven2OsgiConverter( new DefaultMaven2OsgiConverter() );
plugin.setBuildDirectory( "." );
plugin.setOutputDirectory( new File( "." ) );
}
public void testConvertVersionToOsgi()
{
String osgiVersion;
osgiVersion = plugin.convertVersionToOsgi( "2.1.0-SNAPSHOT" );
assertEquals( "2.1.0.SNAPSHOT", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2.1-SNAPSHOT" );
assertEquals( "2.1.0.SNAPSHOT", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2-SNAPSHOT" );
assertEquals( "2.0.0.SNAPSHOT", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2" );
assertEquals( "2.0.0", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2.1" );
assertEquals( "2.1.0", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2.1.3" );
assertEquals( "2.1.3", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "2.1.3.4" );
assertEquals( "2.1.3.4", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "4aug2000r7-dev" );
assertEquals( "0.0.0.4aug2000r7-dev", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "1.1-alpha-2" );
assertEquals( "1.1.0.alpha-2", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "1.0-alpha-16-20070122.203121-13" );
assertEquals( "1.0.0.alpha-16-20070122_203121-13", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "1.0-20070119.021432-1" );
assertEquals( "1.0.0.20070119_021432-1", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "1-20070119.021432-1" );
assertEquals( "1.0.0.20070119_021432-1", osgiVersion );
osgiVersion = plugin.convertVersionToOsgi( "1.4.1-20070217.082013-7" );
assertEquals( "1.4.1.20070217_082013-7", osgiVersion );
}
public void testReadExportedModules() throws Exception
{
File osgiBundleFile = getTestBundle();
assertTrue( osgiBundleFile.exists() );
MavenProject project = new MavenProjectStub();
project.setGroupId( "group" );
project.setArtifactId( "artifact" );
project.setVersion( "1.1.0.0" );
// PackageVersionAnalyzer analyzer = new PackageVersionAnalyzer();
Builder analyzer = new Builder();
Jar jar = new Jar( "name", osgiBundleFile );
analyzer.setJar( jar );
analyzer.setClasspath( new Jar[]
{ jar } );
analyzer.setProperty( Analyzer.EXPORT_PACKAGE, "*" );
analyzer.calcManifest();
assertEquals( 3, analyzer.getExports().size() );
analyzer.close();
}
public void testTransformDirectives() throws Exception
{
Map instructions = new TreeMap();
instructions.put( "a", "1" );
instructions.put( "-a", "2" );
instructions.put( "_a", "3" );
instructions.put( "A", "3" );
instructions.put( "_A", "1" );
instructions.put( "_b", "4" );
instructions.put( "b", "6" );
instructions.put( "_B", "6" );
instructions.put( "-B", "5" );
instructions.put( "B", "4" );
instructions.put( "z", null );
instructions.put( "_z", null );
Map transformedInstructions = BundlePlugin.transformDirectives( instructions );
assertEquals( "1", transformedInstructions.get( "a" ) );
assertEquals( "3", transformedInstructions.get( "-a" ) );
assertEquals( null, transformedInstructions.get( "_a" ) );
assertEquals( "3", transformedInstructions.get( "A" ) );
assertEquals( "1", transformedInstructions.get( "-A" ) );
assertEquals( null, transformedInstructions.get( "_A" ) );
assertEquals( null, transformedInstructions.get( "_b" ) );
assertEquals( "4", transformedInstructions.get( "-b" ) );
assertEquals( "6", transformedInstructions.get( "b" ) );
assertEquals( null, transformedInstructions.get( "_B" ) );
assertEquals( "6", transformedInstructions.get( "-B" ) );
assertEquals( "4", transformedInstructions.get( "B" ) );
assertEquals( "", transformedInstructions.get( "z" ) );
assertEquals( "", transformedInstructions.get( "-z" ) );
}
public void testDefaultPropertiesIncludeOrganization()
{
final Organization organization = new Organization();
organization.setName( "Example Organization" );
organization.setUrl( "http://example.org" );
// MavenProjectStub.setOrganization(Organization) doesn't do anything, so we have to make it work this way
MavenProject project = new MavenProjectStub()
{
@Override
public Organization getOrganization()
{
return organization;
}
};
project.setGroupId( "group" );
project.setArtifactId( "artifact" );
project.setVersion( "1.1.0.0" );
Properties properties = plugin.getDefaultProperties( project );
assertEquals( organization.getName(), properties.getProperty( "project.organization.name" ) );
assertEquals( organization.getName(), properties.getProperty( "pom.organization.name" ) );
assertEquals( organization.getUrl(), properties.getProperty( "project.organization.url" ) );
assertEquals( organization.getUrl(), properties.getProperty( "pom.organization.url" ) );
}
public void testVersion() throws Exception
{
String cleanupVersion = Builder.cleanupVersion( "0.0.0.4aug2000r7-dev" );
assertEquals( "0.0.0.4aug2000r7-dev", cleanupVersion );
}
public void testPackageInfoDetection() throws Exception
{
MavenProject project = new MavenProjectStub();
project.addCompileSourceRoot( getBasedir() + "/src/test/java" );
String resourcePaths = plugin.getMavenResourcePaths( project );
assertEquals( "org/apache/felix/bundleplugin/packageinfo="
+ "src/test/java/org/apache/felix/bundleplugin/packageinfo", resourcePaths );
}
}
maven-bundle-plugin-2.3.5/src/test/java/org/apache/felix/bundleplugin/packageinfo 0000664 0000000 0000000 00000001460 11645647261 0030077 0 ustar 00root root 0000000 0000000 # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
packageinfo:
version 888
maven-bundle-plugin-2.3.5/src/test/resources/ 0000775 0000000 0000000 00000000000 11645647261 0021166 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/resources/OSGI-INF/ 0000775 0000000 0000000 00000000000 11645647261 0022341 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/resources/OSGI-INF/blueprint/ 0000775 0000000 0000000 00000000000 11645647261 0024345 5 ustar 00root root 0000000 0000000 maven-bundle-plugin-2.3.5/src/test/resources/OSGI-INF/blueprint/bp.xml 0000664 0000000 0000000 00000004372 11645647261 0025476 0 ustar 00root root 0000000 0000000
p7.Foo
maven-bundle-plugin-2.3.5/upgrade_local_poms.sh 0000775 0000000 0000000 00000001372 11645647261 0021607 0 ustar 00root root 0000000 0000000 #!/bin/sh
VERSION=$1
if [ "$VERSION" = "" ]
then
echo "Usage: $0 "
exit
fi
cd ../pom
for POM in `find .. -name .svn -prune -o -name pom.xml -print`
do
mvn "-DprojectFile=$POM" \
"-Dxpath=/project/build/plugins/plugin[artifactId[.='maven-bundle-plugin']]/version" \
"-DnewValue=$VERSION" \
org.apache.maven.plugins:maven-pom-plugin:1.0-SNAPSHOT:alter-by-xpath
mvn "-DprojectFile=$POM" \
"-DskipXPath=/project/build/plugins/plugin[artifactId[.='maven-bundle-plugin']]/version" \
"-Dxpath=/project/build/plugins/plugin[artifactId[.='maven-bundle-plugin']]" \
"-DnewElement=version" "-DnewValue=$VERSION" \
org.apache.maven.plugins:maven-pom-plugin:1.0-SNAPSHOT:add-by-xpath
done
