Add a README describing the framework-7.x branch

Say what this branch is for: the maintenance line for 7.x, for users who need
Java 8 or the OSGi security layer, and where it differs from 8.x on master.
Also say where fixes go (master first, then backported here), that backports
touching code removed or rewritten in 8.x need porting by hand, and why JDK 25
is not in the CI matrix.

The file is under framework/, so it matches the workflow's path filters and
makes CI build the framework on this branch, which the earlier change to the
workflow alone did not.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 file changed
tree: ec6703a2b486117a685e3d26c8cbfdeaf1debb2c
  1. .github/
  2. bundlerepository/
  3. bundlerepository.osgi-ct/
  4. cm.json/
  5. configadmin/
  6. configadmin-plugins/
  7. configurator/
  8. connect/
  9. coordinator/
  10. dependencymanager/
  11. doap/
  12. eventadmin/
  13. examples/
  14. features/
  15. fileinstall/
  16. framework/
  17. framework.security/
  18. framework.tck/
  19. gogo/
  20. healthcheck/
  21. http/
  22. inventory/
  23. ipojo/
  24. log/
  25. log.extension/
  26. main/
  27. main.distribution/
  28. metatype/
  29. pom/
  30. resolver/
  31. rootcause/
  32. scr/
  33. scr-ext-anno/
  34. systemready/
  35. tools/
  36. utils/
  37. webconsole/
  38. webconsole-plugins/
  39. .asf.yaml
  40. .gitignore
  41. check_staged_release.sh
  42. CODE_OF_CONDUCT.md
  43. CONTRIBUTING.md
  44. LICENSE
  45. README.md
  46. stage_existing_artifact.sh
README.md

Apache Felix

The Apache Felix project is a collection of semi-related OSGi sub-projects that build and release individually.

Felix Framework

The flagship project is the Apache Felix Framework which implements the OSGi Core R7 specification. The /framework directory contains the source and build tree for the OSGi-compliant framework implementation.

Directly related projects:

  • main /main* - provides an executable jar that launches the Felix framework.

OSGi Core

OSGi Compendium

Several sub-projects cover various OSGi Compendium specifications such as:

Extra Features

Several projects provide extra features to an OSGi runtime.

  • bundle repository /bundlerepository - Bundle repository service.
  • connect /connect - A service registry that enables OSGi style service registry programs without using an OSGi framework.
  • dependency manager /dependencymanager - A versatile java API, allowing to declaratively register, acquire, and manage dynamic OSGi services.
  • fileinstall /fileinstall* - A utility to automatically install bundles from a directory.
  • gogo /gogo - A command line shell, runtime and set of base commands for interacting with and introspecting an OSGi framework.
  • health checks /healthcheck/* - An extensible framework to monitor the status of the OSGi container at runtime. (contains systemready)
  • inventory /inventory - Provides some mechanisms to get the current state of the system and therefore provides an inventory of the system.
  • ipojo /ipojo - A service component runtime aiming to simplify OSGi application development.
  • jaas support /jaas - Bundle to simplify JAAS usage within OSGi environment.
  • logback /logback - A simple integration of the OSGi R7 Log (1.4) service to Logback backend.
  • OSGi metrics /metrics/osgi - Collecting and publishing metrics related to OSGi applications
  • rootcause /rootcause - Finding the root cause of problems with OSGi declarative services components.
  • utils /utils - Utility classes for OSGi (intended for embedding within other bundles.)
  • webconsole /webconsole* - Web Based Management Console for OSGi Frameworks.
  • and many other OSGi things

Build tools

The /tools directory contains various build tools.

  • maven-bundle-plugin /tools/maven-bundle-plugin - A maven plugin for building OSGi bundles.
  • osgicheck-maven-plugin /tools/osgicheck-maven-plugin - Maven plugin for checking several OSGi aspects of your project.