This is an automated email from the ASF dual-hosted git repository. djencks pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/felix-antora-site.git
commit ddb481c452fc0214017687488bde0c44fcce8b4e Author: David Jencks <[email protected]> AuthorDate: Sun Jul 11 15:36:15 2021 -0700 remove commons doc (unmaintained) --- modules/ROOT/pages/documentation/subprojects.adoc | 2 +- .../subprojects/apache-felix-commons.adoc | 152 --------------------- .../creating-bundles-using-bnd.adoc | 88 ------------ 3 files changed, 1 insertion(+), 241 deletions(-) diff --git a/modules/ROOT/pages/documentation/subprojects.adoc b/modules/ROOT/pages/documentation/subprojects.adoc index d44b765..67301bd 100644 --- a/modules/ROOT/pages/documentation/subprojects.adoc +++ b/modules/ROOT/pages/documentation/subprojects.adoc @@ -119,7 +119,7 @@ The following projects are no longer maintained and are not documented in this s The last documentation may be found in the https://github.com/apache/felix-site-pub/tree/last-cms repository. * https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-autoconf.html[Auto Configuration] -* xref:documentation/subprojects/apache-felix-commons.adoc[Commons] +* https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-commons.html[Commons] * xref:documentation/subprojects/apache-felix-deployment-admin.adoc[Deployment Admin] * xref:documentation/subprojects/apache-felix-jaas.adoc[JAAS Support] * xref:documentation/subprojects/apache-felix-lightweight-http-service.adoc[Lightweight HTTP Service] diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-commons.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-commons.adoc deleted file mode 100644 index f24389b..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-commons.adoc +++ /dev/null @@ -1,152 +0,0 @@ -= Apache Felix Commons - -== Purpose - -Apache Felix Commons is a community effort to create OSGi bundle ("bundlized") versions of popular third-party open-source libraries. -Today, OSGi developers must create bundles out of third-party libraries within their own development communities. -The purpose of Felix Commons is to avoid duplicating the effort of bundle creation by sharing these bundlized artifacts. -Our hope is that over time, the original developers of the third-party libraries can use these bundlized libraries to learn how to add OSGi metadata to their project artifacts and to become comfortable with the overall non-invasive process. -Felix Commons is thus a large "project" of POMs where each bundle POM simply has a dependency on the library it wants to convert. -The Felix Maven Bundle Plugin will then convert the dependency automatically and the bundle will be available via existing Maven infrastructure. - -This web page will be used to document who is doing what and to provide pointers to more information. - -== How Can I Help? - -If you have libraries you have turned into bundles, then you can offer to contribute them. -Additionally, you may request that a certain bundle be created. -If you wish to submit a POM file for a specific library, you can attach it to a http://issues.apache.org/jira/browse/Felix[Felix JIRA issue] under the "Felix Commons" component. -For Apache purposes, contributing a bundle POM is the same as contributing code. - -== Getting Started - -In most cases, creating bundlized versions of a library is as simple as creating a POM file for the library using Felix' new xref:documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.adoc[Maven Bundle Plugin]. -The OSGi headers are non-intrusive. -A JAR can be made in such a way that it runs on the Classpath as well as a bundle in an OSGi framework. -In short you: - -. Set the groupId to: `<groupId>org.apache.felix.commons</groupId>` -. Append "-osgi" to the name of the artifact: `<artifactId>FOO-osgi</artifactId>` -. Set the "packaging" to use the Maven Bundle Plugin: `<packaging>bundle</packaging>` -. Set any configuration options in the xref:documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.adoc[Maven Bundle Plugin]. - -We recommend you read the longer xref:documentation/subprojects/apache-felix-commons/creating-bundles-using-bnd.adoc[steps for converting a library to a bundle]. - -== Contributions - -|=== -| Library | Version | Description | Contributor | Grant OK | Committed - -| cglib -| 2.0.2 -| CGLib -| Felix Meschberger -| Yes -| Yes - -| commons-beanutils -| 1.7.0 -| BeanUtils -| Felix Meschberger -| Yes -| Yes - -| commons-codec -| 1.2 -| Codec -| Felix Meschberger -| Yes -| Yes - -| commons-configuration -| 1.3 -| Configuration -| Felix Meschberger -| Yes -| Yes - -| commons-digester -| 1.8 -| Digester -| Felix Meschberger -| Yes -| Yes - -| commons-el -| 1.0 -| EL -| Felix Meschberger -| Yes -| Yes - -| commons-fileupload -| 1.1.1 -| FileUpload -| Felix Meschberger -| Yes -| Yes - -| commons-httpclient -| 3.0.1 -| Client-side HTTP. -| Felix Meschberger -| Yes -| Yes - -| commons-io -| 1.3 -| IO -| Felix Meschberger -| Yes -| Yes - -| commons-lang -| 2.2 -| Lang -| Felix Meschberger -| Yes -| Yes - -| antlr -| 2.7.6 -| Parser generator. -| John Conlon -| Yes -| Yes - -| commons-collections -| 3.2 -| Data structures for collections. -| John Conlon -| Yes -| Yes - -| jzlib -| 1.0.7 -| Data compression library. -| John Conlon -| Yes -| Yes - -| commons-email -| 1.0 -| An API for sending email. -| Felix Meschberger -| Yes -| Yes -|=== - -== Supporting Libraries - -These are projects that have expressed support for the Felix Commons initiative and that are working directly within their respective projects to support OSGi. - -| Project | Description | Supporter(s) | More Information | |--|--|--|--| | Spring | | Adrian Colyer, Andy Piper | http://www.springframework.org/osgi[Spring-OSGi] | | SLF4J | | Ceki Gülcü | http://www.slf4j.org/[SLF4J] | | Logback | | Ceki Gülcü | http://logback.qos.ch/[Logback] | | MINA | NIO framework | Trustin Lee | http://issues.apache.org/jira/browse/DIRMINA-27[DIRMINA-27] | | HTTP Client | Client-side HTTP. -| Roland Weber | https://issues.apache.org/jira/browse/HTTPCLIENT-639[HTTPCLIENT-639] | | Apache OFBiz | Enterprise automation. -| Christopher Snow | http://mail-archives.apache.org/mod_mbox/incubator-felix-dev/200704.mbox/%[email protected]%3e[Mailing list archives] | | Jetty | Servlet engine. -| Jan Bartel | Jetty 6.1.5 and onwards uses the 'maven-bundle-plugin'.| - -== Similar Efforts - -Eclipse Orbit - http://www.eclipse.org/orbit/ \{quote} ... -will provide a repository of bundled versions of third party libraries that are approved for use in one or more Eclipse projects. -\{quote} diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-commons/creating-bundles-using-bnd.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-commons/creating-bundles-using-bnd.adoc deleted file mode 100644 index 3e0c312..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-commons/creating-bundles-using-bnd.adoc +++ /dev/null @@ -1,88 +0,0 @@ -= Creating Bundles Using BND - -== Purpose - -Provide the list of steps required to create a library bundle by wrapping the library jar using bnd (http://bnd.bndtools.org/). - -== Steps - -. Use bnd to analyze the library jar (e.g., java -jar bnd-0.0.jar print path/to/FOO.jar) -. At the bottom of the bnd output, look for "Unresolved references to ..." which identify package dependencies. -If found, a. -Identifiy the library jars that provide the missing packages b. -Recursively use this process on each dependency -. Create a directory that will be the project directory for the bundle (e.g., mkdir FOO-osgi) -. Copy the template pom.xml file to the bundle's project directory -. Edit the pom.xml file to tailor it for the library jar. -Specifically, a. -change artifactId b. -verify description c. -change version d. -change FOO's library jar dependency (groupId, artifactId) e. -add any other dependencies (from step 2b) f. -change Export-Package g. -change Private-Package or delete it if it's not needed h. -All packages listed in step 1 should be in either Export-Package or Private-Package. -Use the library's javadoc to identify the exported packages. -The remaining packages should be private. -. Run "mvn package" to in the project directory to create the bundle -. Use bnd to verify the bundle's contents (e.g., java -jar bnd-0.0.jar print target/FOO-osgi-VERSION.jar) -. Run "mvn install" to install the bundle in the local repository - -== Example POM - -[source,xml] ----- -<project - xmlns="http://maven.apache.org/POM/4.0.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - - <modelVersion>4.0.0</modelVersion> - <groupId>org.apache.felix.commons</groupId> - <artifactId>FOO-osgi</artifactId> - <name>${pom.artifactId} bundle</name> - <description> - This bundle simply wraps FOO-${pom.version}.jar. - </description> - <version>X.Y</version> - <packaging>bundle</packaging> - - <organization> - <name>Apache Felix Project</name> - <url>http://felix.apache.org/</url> - </organization> - - <dependencies> - <dependency> - <groupId>FOO</groupId> - <artifactId>FOO</artifactId> - <version>${pom.version}</version> - </dependency> - </dependencies> - - <build> - <plugins> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <extensions>true</extensions> - <configuration> - <instructions> - <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName> - <Export-Package>FOO</Export-Package> - <Private-Package>FOO.impl</Private-Package> - </instructions> - </configuration> - </plugin> - </plugins> - </build> - -</project> ----- - -== Resources - -Bnd - Bundle Tool http://bnd.bndtools.org/ - -Bundle Plugin for Maven http://felix.apache.org/site/maven-bundle-plugin-bnd.html
