You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by ab...@apache.org on 2012/06/25 13:26:13 UTC
svn commit: r1353466 - in /incubator/celix/site/trunk: content/celix/
content/celix/subprojects/ templates/
Author: abroekhuis
Date: Mon Jun 25 11:26:11 2012
New Revision: 1353466
URL: http://svn.apache.org/viewvc?rev=1353466&view=rev
Log:
Added subproject documents
Overview of all subproject with some details regarding dependencies and libraries
Added:
incubator/celix/site/trunk/content/celix/subprojects/
incubator/celix/site/trunk/content/celix/subprojects.mdtext
incubator/celix/site/trunk/content/celix/subprojects/dependencymanager.mdtext
incubator/celix/site/trunk/content/celix/subprojects/deviceaccess.mdtext
incubator/celix/site/trunk/content/celix/subprojects/examples.mdtext
incubator/celix/site/trunk/content/celix/subprojects/framework.mdtext
incubator/celix/site/trunk/content/celix/subprojects/hessian.mdtext
incubator/celix/site/trunk/content/celix/subprojects/launcher.mdtext
incubator/celix/site/trunk/content/celix/subprojects/logservice.mdtext
incubator/celix/site/trunk/content/celix/subprojects/logwriter.mdtext
incubator/celix/site/trunk/content/celix/subprojects/remoteserviceadmin.mdtext
incubator/celix/site/trunk/content/celix/subprojects/shell.mdtext
incubator/celix/site/trunk/content/celix/subprojects/shelltui.mdtext
incubator/celix/site/trunk/content/celix/subprojects/utils.mdtext
Modified:
incubator/celix/site/trunk/templates/sidenav.mdtext
Added: incubator/celix/site/trunk/content/celix/subprojects.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,16 @@
+Title: Subprojects
+
+Apache Celix is organized into several subprojects. The following subproject are currently available:
+
+- [Dependency Manager](/celix/subprojects/dependencymanager.html)
+- [Device Access](/celix/subprojects/deviceaccess.html)
+- [Examples](/celix/subprojects/examples.html)
+- [Framework](/celix/subprojects/framework.html)
+- [Hessian](/celix/subprojects/hessian.html)
+- [Launcher](/celix/subprojects/launcher.html)
+- [Log Service](/celix/subprojects/logservice.html)
+- [Log Writer](/celix/subprojects/logwriter.html)
+- [Remote Service Admin](/celix/subprojects/remoteserviceadmin.html)
+- [Shell](/celix/subprojects/shell.html)
+- [Shell TUI](/celix/subprojects/shelltui.html)
+- [Utils](/celix/subprojects/utils.html)
Added: incubator/celix/site/trunk/content/celix/subprojects/dependencymanager.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/dependencymanager.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/dependencymanager.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/dependencymanager.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,21 @@
+Title: Apache Celix Dependency Manager
+
+The Dependency Manager subproject provides an API based method for declaring components and their dependencies.
+Dependencies can be defined as optional or required, and the DM takes care of the component life cycle based on the availability of the dependencies.
+
+Dependencies are injected into the component using callback functions or via a field of a struct.
+
+## Building
+
+To build the Dependency Manager the CMake build option "BUILD_DEPENDENCY_MANAGER" has to be enabled.
+
+## Dependencies
+
+The Dependency Manager depends on the following subprojects:
+
+- Framework
+- Utils
+
+Also the following libraries are required for building and/or using the Dependency Manager subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/deviceaccess.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/deviceaccess.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/deviceaccess.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/deviceaccess.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,22 @@
+Title: Apache Celix Device Access
+
+The Device Access subproject contains a for Celix adapted implementation of the OSGi Compendium Device Access Specification.
+
+The following Device Access properties are used:
+
+- DRIVER_LOCATOR_PATH - Path to the directory containing the driver bundles, defaults to "drivers". The Driver Locator uses this path to find drivers.
+
+## Building
+
+To build Device Access the CMake build option "BUILD_DEVICE_ACCESS" has to be enabled.
+
+## Dependencies
+
+The Device Access depends on the following subprojects:
+
+- Framework
+- Utils
+
+Also the following libraries are required for building and/or using the Device Access subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/examples.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/examples.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/examples.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/examples.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,41 @@
+Title: Apache Celix Examples
+
+The Examples subproject contains several examples showing how Celix and the subprojects can be used.
+
+The following Examples are available:
+
+- Echo Service
+- Hello World
+- Component Testing
+- Mongoose
+- OSGi In Action
+ - Chapter 1 - Greeting Example
+ - Chapter 4 - Correct listener
+ - Chapter 4 - Correct Lookup
+ - Chapter 4 - Paint Example
+- Receiver
+- Sender
+- Whiteboard Example
+
+## Building
+
+To build the Examples the CMake build option "BUILD_EXAMPLES" has to be enabled.
+
+## Dependencies
+
+The Examples depend on the following subprojects:
+
+- Framework
+- Utils
+- Dependency Manager
+- Shell
+- Shell TUI
+- Log Writer
+- Log Service
+
+Also the following libraries are required for building and/or using the Examples subproject:
+
+- Apache Portable Runtime (build and runtime)
+- GTK2 - 2.14 or higher (build and runtime)
+
+ Needed by "Chapter 4 - Paint Example"
Added: incubator/celix/site/trunk/content/celix/subprojects/framework.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/framework.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/framework.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/framework.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,20 @@
+Title: Apache Celix Framework
+
+The Framework is the Celix adaptation of the Core OSGi specification. Where possible it follows the specification,
+but for several parts a specific C solution has been used.
+
+## Building
+
+To build the Framework the CMake build option "BUILD_FRAMEWORK" has to be enabled. Currently the Framework is enabled by default.
+
+## Dependencies
+
+The Framework depends on the following subprojects:
+
+- Utils
+
+Also the following libraries are required for building and/or using the Framework:
+
+- Apache Portable Runtime (build and runtime)
+- ZLib (build and runtime)
+- CUnit (only required for building and running the tests)
\ No newline at end of file
Added: incubator/celix/site/trunk/content/celix/subprojects/hessian.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/hessian.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/hessian.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/hessian.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,14 @@
+Title: Apache Celix Launcher
+
+The Hessian directory contains an independent CMake project. In this project a C based implementation of the Hessian protocol is developed.
+Currently the implementation isn't complete.
+
+## Building
+
+To build the Hessian project create a build directory inside the hessian project root and run "cmake ../source" to generate the make files.
+After this, run "make" to build the hessian code. Run "make test" to run a test executable, results are placed in the "test_results" directory.
+
+## Dependencies
+The following libraries are required for building and/or using the Launcher subproject:
+
+- CUnit (only required for building and running the tests)
Added: incubator/celix/site/trunk/content/celix/subprojects/launcher.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/launcher.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/launcher.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/launcher.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,24 @@
+Title: Apache Celix Launcher
+
+The Launcher subproject contains a generic executable for launching the Framework. The Launcher reads a java properties based configuration file.
+
+The following Framework properties are currently handled by the Launcher:
+
+- cosgi.auto.start.1 - Space delimited list of bundles to install and start when the Launcher/Framework is started. Note: Celix currently has no support for start levels, even though the "1" is meant for this.
+
+The Launcher also passes the entire configuration to the Framework, this makes them available to the bundleContext_getProperty function.
+
+## Building
+
+To build the Launcher the CMake build option "BUILD_LAUNCHER" has to be enabled. Currently the Launcher subproject is enabled by default.
+
+## Dependencies
+
+The Launcher depends on the following subprojects:
+
+- Framework
+- Utils
+
+Also the following libraries are required for building and/or using the Launcher subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/logservice.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/logservice.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/logservice.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/logservice.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,21 @@
+Title: Apache Celix Log Service
+
+The Log Service subproject contains a for Celix adapted implementation of the OSGi Compendium Log Service.
+This is a very simple implementation which only stores the log in memory.
+
+The Log Service can be extended through use of the LogReader service, or by using a LogListener service.
+
+## Building
+
+To build the Log Service the CMake build option "BUILD_LOG_SERVICE" has to be enabled.
+
+## Dependencies
+
+The Log Service depends on the following subprojects:
+
+- Framework
+- Utils
+
+Also the following libraries are required for building and/or using the Log Service subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/logwriter.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/logwriter.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/logwriter.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/logwriter.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,21 @@
+Title: Apache Celix Log Service
+
+The Log Writer subproject contains a component to read/listen to the Log Service and print the Log entries to the console.
+
+
+## Building
+
+To build the Log Writer the CMake build option "BUILD_LOG_WRITER" has to be enabled.
+
+## Dependencies
+
+The Log Writer depends on the following subprojects:
+
+- Framework
+- Utils
+- Log Service
+- Dependency Activator
+
+Also the following libraries are required for building and/or using the Log Writer subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/remoteserviceadmin.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/remoteserviceadmin.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/remoteserviceadmin.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/remoteserviceadmin.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,28 @@
+Title: Apache Celix Remote Service Admin Service
+
+The Remote Service Admin Service subproject contains a for Celix adapted implementation of the OSGi Enterprise Remote Service Admin Service Specification.
+
+The following Remote Service Admin Service properties are used:
+
+- RS_BUNDLE - Path to the directory containing the endpoint bundles, defaults to "rs_bundles".
+The Remote Service Admin uses this path for the endpoint bundles which have to be installed when a remote service is detected (for import or export).
+- RSA_PORT - The port used by the Remote Service Admin HTTP listener.
+
+## Building
+
+To build the Remote Service Admin Service the CMake build option "BUILD_REMOTE_SERVICE_ADMIN" has to be enabled.
+
+## Dependencies
+
+The Remote Service Admin Service depends on the following subprojects:
+
+- Framework
+- Utils
+
+Also the following libraries are required for building and/or using the Remote Service Admin Service subproject:
+
+- Apache Portable Runtime (build and runtime)
+- Apache Portable Runtime Util (build and runtime)
+- Jansson (build and runtime)
+- OpenSLP (build and runtime)
+- cURL (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/shell.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/shell.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/shell.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/shell.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,25 @@
+Title: Apache Celix Shell
+
+The Shell subproject contains a set of commands and a shell to interact with the Framework and its registry.
+With several commando's it is possible to query the Framework registry and Log Service, inspect existing bundles/services, start/stop/update bundles and install/uninstall bundles.
+
+The Shell does not provide a user interface, but only a service to interact with. This approach makes it possible to define multiple frontends, eg textual or graphical.
+
+The Celix Shell follows the Apache Felix Shell implementation (not the Apache Felix Gogo shell).
+
+## Building
+
+To build the Shell the CMake build option "BUILD_SHELL" has to be enabled.
+
+## Dependencies
+
+The Shell depends on the following subprojects:
+
+- Framework
+- Utils
+- Log Service
+
+Also the following libraries are required for building and/or using the Shell subproject:
+
+- Apache Portable Runtime (build and runtime)
+- cURL (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/shelltui.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/shelltui.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/shelltui.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/shelltui.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,20 @@
+Title: Apache Celix Shell TUI
+
+The Shell TUI subproject contains a textual user interface for the Shell Service.
+Through the textual interface commands can be executed, with the results being dumped in the console.
+
+## Building
+
+To build the Shell the CMake build option "BUILD_SHELL" has to be enabled.
+
+## Dependencies
+
+The Shell TUI depends on the following subprojects:
+
+- Framework
+- Utils
+- Shell
+
+Also the following libraries are required for building and/or using the Shell TUI subproject:
+
+- Apache Portable Runtime (build and runtime)
Added: incubator/celix/site/trunk/content/celix/subprojects/utils.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/content/celix/subprojects/utils.mdtext?rev=1353466&view=auto
==============================================================================
--- incubator/celix/site/trunk/content/celix/subprojects/utils.mdtext (added)
+++ incubator/celix/site/trunk/content/celix/subprojects/utils.mdtext Mon Jun 25 11:26:11 2012
@@ -0,0 +1,22 @@
+Title: Apache Celix Utils
+
+The Utils subproject contains several containers/lists used by the different Celix subprojects.
+The following types are available:
+
+- Array List
+- Linked List
+- Hash Map
+
+There are also iterators available for every type.
+
+## Building
+
+To build the Utils the CMake build option "BUILD_UTILS" has to be enabled. Currently the Utils subproject is enabled by default.
+
+## Dependencies
+
+The following libraries are required for building and/or using the Utils subproject:
+
+- Apache Portable Runtime (build and runtime)
+- CUnit (only required for building and running the tests)
+
Modified: incubator/celix/site/trunk/templates/sidenav.mdtext
URL: http://svn.apache.org/viewvc/incubator/celix/site/trunk/templates/sidenav.mdtext?rev=1353466&r1=1353465&r2=1353466&view=diff
==============================================================================
--- incubator/celix/site/trunk/templates/sidenav.mdtext (original)
+++ incubator/celix/site/trunk/templates/sidenav.mdtext Mon Jun 25 11:26:11 2012
@@ -2,6 +2,19 @@
- [About](/celix/celix.html)
- [Celix](/celix/celix.html)
- [Background](/celix/background.html)
+- [Subprojects](/celix/subprojects.html)
+ - [Dependency Manager](/celix/subprojects/dependencymanager.html)
+ - [Device Access](/celix/subprojects/deviceaccess.html)
+ - [Examples](/celix/subprojects/examples.html)
+ - [Framework](/celix/subprojects/framework.html)
+ - [Hessian](/celix/subprojects/hessian.html)
+ - [Launcher](/celix/subprojects/launcher.html)
+ - [Log Service](/celix/subprojects/logservice.html)
+ - [Log Writer](/celix/subprojects/logwriter.html)
+ - [Remote Service Admin](/celix/subprojects/remoteserviceadmin.html)
+ - [Shell](/celix/subprojects/shell.html)
+ - [Shell TUI](/celix/subprojects/shelltui.html)
+ - [Utils](/celix/subprojects/utils.html)
- [Documentation](/celix/documentation.html)
- [Building and Running](/celix/documentation/buildingandrunning.html)
- [Design](/celix/documentation/design.html)