Apache Felix Subproject Documentation

Building Apache Felix

The Felix project is organized into subprojects, where each subproject targets a specific OSGi specification or OSGi-related technology. Most of these projects are in a single git repository, some have moved into separate git repositories.

Use the below table of subprojects to find the git repository for that subproject, if you want to checkout the main git repository with most subprojects use git clone https://github.com/apache/felix-dev.git, otherwise use the git repository mentioned in the table.

To get started:

  • Most Apache Felix projects use Apache Maven as the build tool. Therefore, download and install the latest Apache Maven 3 release.

  • Check out or update the git repository (see above).

  • Go to the sub project you’re interested in and type: "mvn clean install" to build it. If this project is not using Maven, refer to the docs for the subproject on how to build it.

Active subprojects

Name Description Source

Atomos

An OSGi module connector that enables loading bundles in a variety of environments, such as, jlink image, native-image, Android and flat class path.

source

Config Admin

An implementation of the OSGi Configuration Admin service specification for managing bundle configuration properties.

source

Dependency Manager

An API-based component model to simplify OSGi-based development.

source

Event Admin

An implementation of the OSGi Event Admin service specification for event-based communication.

source

File Install

A simple, directory-based management agent for managing bundle deployment.

source

Framework

An implementation of the OSGi R7 core framework.

source

Framework Security

source

Gogo

An advanced shell for interacting with OSGi frameworks.

source

Health Checks

An extensible framework to monitor the status of the OSGi container at runtime.

source

HTTP Service

An implementation of the OSGi HTTP Whiteboard and Http Service specification.

source

Inventory Printer

A simple and extensible framework to retrieve inventory information about applications running in an OSGi Framework.

source

Log

A simple, memory-based implementation of the OSGi Log service specification.

source

Logback

Apache Felix Logback is a small integration of the Logback backend with OSGi.

source

Maven Bundle Plugin

A Maven plugin to simplify building bundles.

source

Metatype

An implementation of the OSGi Metatype service to describe types needed by bundles.

source

OSGi Bundle Repository

A bundle repository service to simplify discovering and deploying bundles and their dependencies.

source

Preferences Service

An implementation of the OSGi Preferences service specification for storing settings and preferences.

source

Remote Shell

A remote, text-based interface to the Apache Felix Shell.

source

Service Component Runtime

An implementation of the OSGi Declarative Services specification providing a service-oriented component model to simplify OSGi-based development.

source

Shell

A very simple shell service implemented as a bundle for interacting with an OSGi framework instance.

source

Shell TUI

A simple, text-based interface to the Apache Felix Shell.

source

Web Console

A simple tool to inspect and manage OSGi framework instances using your favorite Web Browser.

source