blob: 0bfa4e97228eaf82815b28f00265a4a02a317c0d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!--
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
https://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.
-->
<head>
<title>Apache Felix - </title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
<div class="logo">
<a href="https://felix.apache.org/">
<img border="0" alt="Apache Felix" src="/res/logo.png">
</a>
</div>
<div class="header">
<a href="https://www.apache.org/">
<img border="0" alt="Apache" src="/res/apache.png">
</a>
</div>
</div>
<div class="menu">
<style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
/*
* Hide class="elementid-permalink", except when an enclosing heading
* has the :hover property.
*/
.headerlink, .elementid-permalink {
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
<p><a href="/news.html">News</a> <br />
<a href="/license.html">License</a> <br />
<a href="/downloads.cgi">Downloads</a> <br />
<a href="/documentation.html">Documentation</a> <br />
<a href="/documentation/community/project-info.html">Project Info</a> <br />
<a href="/documentation/community/contributing.html">Contributing</a> <br />
<a href="/sitemap.html">Site Map</a> <br />
<a href="https://www.apache.org/">ASF</a> <br />
<a href="https://www.apache.org/security/">Security</a> <br />
<a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
<a href="https://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
<iframe
src="https://www.apache.org/ads/button.html"
style="border-width:0; float: left"
frameborder="0"
scrolling="no"
width="135"
height="135">
</iframe>
</div>
<div class="main">
<div class="breadcrump" style="font-size: 80%;">
<a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/documentation.html">Documentation</a>
</div>
<h1></h1>
<style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
/*
* Hide class="elementid-permalink", except when an enclosing heading
* has the :hover property.
*/
.headerlink, .elementid-permalink {
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
<h1 id="apache-felix-subproject-documentation">Apache Felix Subproject Documentation<a class="headerlink" href="#apache-felix-subproject-documentation" title="Permanent link">&para;</a></h1>
<h2 id="building-apache-felix">Building Apache Felix<a class="headerlink" href="#building-apache-felix" title="Permanent link">&para;</a></h2>
<p>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.</p>
<p>Use the below table of subprojects to find the git repository for that subproject, if you want to checkout the <a href="https://github.com/apache/felix-dev.git">main git repository</a> with most subprojects use <code>git clone https://github.com/apache/felix-dev.git</code>, otherwise use the git repository mentioned in the table.</p>
<p>To get started:</p>
<ul>
<li>Most Apache Felix projects use Apache Maven as the build tool. Therefore, download and install the latest Apache Maven 3 release.</li>
<li>Check out or update the git repository (see above).</li>
<li>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.</li>
</ul>
<h2 id="active-subprojects">Active subprojects<a class="headerlink" href="#active-subprojects" title="Permanent link">&para;</a></h2>
<table class="table">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Source</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://github.com/apache/felix-atomos">Atomos</a></td>
<td>An OSGi module connector that enables loading bundles in a variety of environments, such as, jlink image, native-image, Android and flat class path.</td>
<td><a href="https://github.com/apache/felix-atomos">source</a></td>
</tr>
<tr>
<td><a href="https://github.com/apache/felix-dev/tree/master/configadmin">Config Admin</a></td>
<td>An implementation of the <a href="https://osgi.org/specification/osgi.cmpn/7.0.0/service.cm.html">OSGi Configuration Admin service specification</a> for managing bundle configuration properties.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/configadmin">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-dependency-manager.html">Dependency Manager</a></td>
<td>An API-based component model to simplify OSGi-based development.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/dependencymanager">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-event-admin.html">Event Admin</a></td>
<td>An implementation of the OSGi Event Admin service specification for event-based communication.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/eventadmin">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-file-install.html">File Install</a></td>
<td>A simple, directory-based management agent for managing bundle deployment.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/fileinstall">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-framework.html">Framework</a></td>
<td>An implementation of the OSGi R7 core framework.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/framework">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-framework-security.html">Framework Security</a></td>
<td></td>
<td><a href="https://github.com/apache/felix-dev/tree/master/framework.security">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-gogo.html">Gogo</a></td>
<td>An advanced shell for interacting with OSGi frameworks.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/gogo">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-healthchecks.html">Health Checks</a></td>
<td>An extensible framework to monitor the status of the OSGi container at runtime.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/healthcheck">source</a></td>
</tr>
<tr>
<td><a href="https://github.com/apache/felix-dev/tree/master/http">HTTP Service</a></td>
<td>An implementation of the <a href="https://osgi.org/specification/osgi.cmpn/7.0.0/service.http.whiteboard.html">OSGi HTTP Whiteboard</a> and <a href="https://osgi.org/specification/osgi.cmpn/7.0.0/service.http.html">Http Service specification</a>.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/http">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-inventory.html">Inventory Printer</a></td>
<td>A simple and extensible framework to retrieve inventory information about applications running in an OSGi Framework.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/inventory">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-ipojo.html">iPOJO</a></td>
<td>A sophisticated service-oriented component model to simplify OSGi-based development.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/ipojo">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-log.html">Log</a></td>
<td>A simple, memory-based implementation of the OSGi Log service specification.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/log">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-logback.html">Logback</a></td>
<td>Apache Felix Logback is a small integration of the <a href="https://logback.qos.ch/">Logback</a> backend with OSGi.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/logback">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-maven-bundle-plugin-bnd.html">Maven Bundle Plugin</a></td>
<td>A Maven plugin to simplify building bundles.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/tools/maven-bundle-plugin">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-metatype-service.html">Metatype</a></td>
<td>An implementation of the OSGi Metatype service to describe types needed by bundles.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/shell">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-osgi-bundle-repository.html">OSGi Bundle Repository</a></td>
<td>A bundle repository service to simplify discovering and deploying bundles and their dependencies.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/org.osgi.service.obr">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-preferences-service.html">Preferences Service</a></td>
<td>An implementation of the OSGi Preferences service specification for storing settings and preferences.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/preferences">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-remote-shell.html">Remote Shell</a></td>
<td>A remote, text-based interface to the Apache Felix Shell.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/shell.remote">source</a></td>
</tr>
<tr>
<td><a href="https://github.com/apache/felix-dev/tree/master/scr">Service Component Runtime</a></td>
<td>An implementation of the <a href="https://osgi.org/specification/osgi.cmpn/7.0.0/service.component.html">OSGi Declarative Services specification</a> providing a service-oriented component model to simplify OSGi-based development.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/scr">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-shell.html">Shell</a></td>
<td>A very simple shell service implemented as a bundle for interacting with an OSGi framework instance.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/shell">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-shell-tui.html">Shell TUI</a></td>
<td>A simple, text-based interface to the Apache Felix Shell.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/shell.tui">source</a></td>
</tr>
<tr>
<td><a href="subprojects/apache-felix-web-console.html">Web Console</a></td>
<td>A simple tool to inspect and manage OSGi framework instances using your favorite Web Browser.</td>
<td><a href="https://github.com/apache/felix-dev/tree/master/webconsole">source</a></td>
</tr>
</tbody>
</table>
<h2 id="maintenance">Maintenance<a class="headerlink" href="#maintenance" title="Permanent link">&para;</a></h2>
<p>The following projects are in maintenance mode meaning there is no active development anymore.</p>
<ul>
<li><a href="subprojects/apache-felix-autoconf.html">Auto Configuration</a></li>
<li><a href="subprojects/apache-felix-commons.html">Commons</a></li>
<li><a href="subprojects/apache-felix-deployment-admin.html">Deployment Admin</a></li>
<li><a href="subprojects/apache-felix-jaas.html">JAAS Support</a></li>
<li><a href="subprojects/apache-felix-lightweight-http-service.html">Lightweight HTTP Service</a></li>
<li><a href="subprojects/apache-felix-manifest-generator-mangen.html">Manifest Generator (mangen)</a></li>
<li><a href="subprojects/apache-felix-maven-obr-plugin.html">Maven OBR Plugin</a></li>
<li><a href="subprojects/apache-felix-maven-osgi-plugin.html">Maven OSGi Plugin</a></li>
<li><a href="subprojects/apache-felix-maven-scr-plugin.html">Maven SCR Plugin</a></li>
<li><a href="subprojects/mosgi-managed-osgi-framework.html">MOSGi Managed OSGi framework</a></li>
<li><a href="subprojects/apache-felix-osgi-core.html">OSGi Core</a></li>
<li><a href="subprojects/apache-felix-script-console-plugin.html">Script Console Plugin</a></li>
<li><a href="subprojects/apache-felix-serialization-framework.html">Serialization Framework</a></li>
<li><a href="subprojects/apache-felix-upnp.html">UPnP</a></li>
<li><a href="subprojects/apache-felix-user-admin.html">User Admin</a></li>
</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1876629 by tjwatson on Thu, 16 Apr 2020 18:38:37 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
logo are trademarks of The Apache Software Foundation. All other marks mentioned
may be trademarks or registered trademarks of their respective owners.
</div>
</div>
</body>
</html>