You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by bd...@apache.org on 2011/04/25 06:06:05 UTC
svn commit: r1096402 - in
/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs:
bundle.xml different.xml index.xml similar.xml site.xml
Author: bdube
Date: Mon Apr 25 04:06:04 2011
New Revision: 1096402
URL: http://svn.apache.org/viewvc?rev=1096402&view=rev
Log:
Add documentation, fix typo
Added:
forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/bundle.xml
Modified:
forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/different.xml
forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/index.xml
forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/similar.xml
forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/site.xml
Added: forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/bundle.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/bundle.xml?rev=1096402&view=auto
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/bundle.xml (added)
+++ forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/bundle.xml Mon Apr 25 04:06:04 2011
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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
+
+ http://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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Forrest Bundles</title>
+ </header>
+ <body>
+ <section id="overview">
+ <title>Anatomy of a Forrest bundle</title>
+ <p>
+ A forrest-osgi plugin is nothing more than a bundle, and a
+ bundle is simply a JAR file with OSGi metadata added to the
+ manifest. Forrest bundles are assembled from JAR files using
+ the bnd Ant task. See the <a href="ext:bnd">bnd tool</a> for
+ more information. The bndwrap task is also available as an
+ option, but bnd seems to be less lenient and leads to fast
+ discovery of build problems.
+ </p>
+ <p>
+ The bnd task is given the name of a file,
+ <code>log4j.bnd</code> for example, which controls how bnd
+ operates. There are also options given directly as attributes
+ to the bnd task within the Ant file.
+ </p>
+ <p>
+ The assembled bundles are gathered together in the
+ <code>bundle</code> directory, from which the launcher
+ installs them in the framework and starts them.
+ </p>
+ <p>
+ Some dependencies of forrest-osgi come in the form of bundles,
+ ready for OSGi. These are found in <code>lib/bundle</code>,
+ which are copied to <code>bundle</code> as part of the build
+ process.
+ </p>
+ </section>
+ <section id="implementation">
+ <title>Implementation choices</title>
+ <p>
+ There are several implementation choices available for an
+ OSGi-driven Forrest given the way the framework handles
+ bundles. Forrest plugins can be discovered by the use of
+ custom manifest headers; they can announce their presence by
+ publishing a service; they can bind to a published service and
+ register their existence through that service. There are many
+ choices available.
+ </p>
+ </section>
+ </body>
+</document>
Modified: forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/different.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/different.xml?rev=1096402&r1=1096401&r2=1096402&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/different.xml (original)
+++ forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/different.xml Mon Apr 25 04:06:04 2011
@@ -34,14 +34,15 @@
<p>
The build process involves a pair of Ant scripts at the top
level and another script for each plugin. The main process is
- defined in <code>build.xml</code> and plugin bundles inherit
- from <code>master.xml</code>. <code>$FORREST_HOME</code>
- should point to the top of this whiteboard experiment,
- <code>.../whiteboard/forrest-osgi</code>. The
- default Ant target in <code>build.xml</code> will build the
- launcher as well as all plugin bundles. The Ant script assumes
- you have changed the environment variable
- <code>$FORREST_HOME</code> as described.
+ defined in <code>build.xml</code> and <a
+ href="site:more/bundle">plugin bundles</a> inherit from
+ <code>master.xml</code>. <code>$FORREST_HOME</code> should
+ point to the top of this whiteboard experiment,
+ <code>.../whiteboard/forrest-osgi</code>. The default Ant
+ target in <code>build.xml</code> will build the launcher as
+ well as all plugin bundles. The Ant script assumes you have
+ changed the environment variable <code>$FORREST_HOME</code> as
+ described.
</p>
</section>
<section id="run">
@@ -81,6 +82,10 @@
mechanism needs improvement.
</p>
<p>
+ See the page on <a href="site:more/bundle">bundles</a> for
+ more.
+ </p>
+ <p>
For the request <code>http://localhost:8080/index.html</code>,
the HTML output plugin is selected based on the request
itself. The local content object is searched for
Modified: forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/index.xml?rev=1096402&r1=1096401&r2=1096402&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/index.xml (original)
+++ forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/index.xml Mon Apr 25 04:06:04 2011
@@ -29,7 +29,7 @@
document transformation services based on modular OSGi™
concepts. This particular experiment uses the Apache
Felix™ framework, but with slight modification the
- implementation can be fraework provider-agnostic.
+ implementation can be framework provider-agnostic.
</p>
<p>
There are many ways to leverage OSGi in a project like this
Modified: forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/similar.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/similar.xml?rev=1096402&r1=1096401&r2=1096402&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/similar.xml (original)
+++ forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/similar.xml Mon Apr 25 04:06:04 2011
@@ -34,8 +34,9 @@
<title>Plugins in forrest-osgi</title>
<p>
forrest-osgi maintains the concept of plugins. Plugins map
- nicely to the OSGi™ concept of bundles, which embody the
- missing modularity of the Java™ platform.
+ nicely to the OSGi™ concept of <a
+ href="site:more/bundle">bundles</a>, which embody the missing
+ modularity of the Java™ platform.
</p>
<p>
However, not every bundle in the system maps conceptually to a
@@ -44,6 +45,10 @@
candidate as a container for a Forrest plugin, but it is not
limited to this use.
</p>
+ <p>
+ See the page on <a href="site:more/bundle">bundles</a> for
+ more.
+ </p>
</section>
<section id="content">
<title>Content and transformation</title>
Modified: forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/site.xml?rev=1096402&r1=1096401&r2=1096402&view=diff
==============================================================================
--- forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/site.xml (original)
+++ forrest/trunk/whiteboard/forrest-osgi/docs/src/documentation/content/xdocs/site.xml Mon Apr 25 04:06:04 2011
@@ -44,10 +44,12 @@ See http://forrest.apache.org/docs/linki
<similar label="Similarities" href="similar.html" />
<different label="Differences" href="different.html" />
<contribute label="Contribute" href="contribute.html" />
+ <bundle label="Bundles" href="bundle.html" />
</more>
<external-refs>
<forrest href="http://forrest.apache.org/">
<linking href="docs/linking.html" />
</forrest>
+ <bnd href="http://www.aqute.biz/Bnd/Bnd" />
</external-refs>
</site>