sgoeschl 2005/03/02 01:42:05
Modified: yaafi/xdocs/specification container.xml context.xml
lifecycle.xml role.xml
yaafi/xdocs howto.xml index.xml navigation.xml todo.xml
yaafi/xdocs/services servicemanagerservice.xml
Log:
Updated documentation
Revision Changes Path
1.3 +43 -16
jakarta-turbine-fulcrum/yaafi/xdocs/specification/container.xml
Index: container.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/specification/container.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- container.xml 1 Mar 2005 10:54:09 -0000 1.2
+++ container.xml 2 Mar 2005 09:42:05 -0000 1.3
@@ -9,7 +9,7 @@
<body>
- <section name="Container Configuration File">
+ <section name="Container Configuration">
<p>
The Container Configuration File is used to bootstrap the
@@ -21,13 +21,13 @@
<tr>
<th>Item</th>
<th>Datatype</th>
- <th>Optional</th>
+ <th>Cardinality</th>
<th>Description</th>
</tr>
<tr>
<td>containerType</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The type of Avalon container where YAAFI is instantiated,
either "phoenix", "fortress" or "merlin". If no value is
@@ -37,7 +37,7 @@
<tr>
<td>containerClazzName</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The class name of the YAAFI container to be instantiated. This
feature allows to use inheritance for customizing the container
@@ -45,40 +45,67 @@
</td>
</tr>
<tr>
+ <td>componentRoles</td>
+ <td>Tree</td>
+ <td>[0|1]</td>
+ <td>Information about the role configuration file</td>
+ </tr>
+ <tr>
<td>componentRoles/location</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>The location of the component role file</td>
</tr>
<tr>
<td>componentRoles/isEncrypted</td>
- <td>Boolean</td>
- <td>Y</td>
- <td>Is the component role file encrypted?</td>
+ <td>String</td>
+ <td>[0|1]</td>
+ <td>
+ Is the component role file encrypted? The possible
+ values are ["true"|"false"|"auto"]
+ </td>
+ </tr>
+ <tr>
+ <td>componentConfiguration</td>
+ <td>Tree</td>
+ <td>[0|1]</td>
+ <td>Information about the component configuration file</td>
</tr>
<tr>
<td>componentConfiguration/location</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>The location of the component configuration file</td>
</tr>
<tr>
<td>componentConfiguration/isEncrypted</td>
- <td>Boolean</td>
- <td>Y</td>
- <td>Is the component configuration file encrypted?</td>
+ <td>String</td>
+ <td>[0|1]</td>
+ <td>
+ Is the component configuration file encrypted? The possible
+ values are ["true"|"false"|"auto"]
+ </td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>Tree</td>
+ <td>[0|1]</td>
+ <td>Information about the parameters file</td>
</tr>
<tr>
<td>parameters/location</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>The location of the parameters file</td>
</tr>
<tr>
<td>parameters/isEncrypted</td>
- <td>Boolean</td>
- <td>Y</td>
- <td>Is the parameters file encrypted?</td>
+ <td>String</td>
+ <td>[0|1]</td>
+ <td>
+ Is the parameters file encrypted? The possible
+ values are ["true"|"false"|"auto"]
+ </td>
</tr>
</table>
</subsection>
1.3 +1 -1
jakarta-turbine-fulcrum/yaafi/xdocs/specification/context.xml
Index: context.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/specification/context.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- context.xml 1 Mar 2005 10:54:09 -0000 1.2
+++ context.xml 2 Mar 2005 09:42:05 -0000 1.3
@@ -9,7 +9,7 @@
<body>
- <section name="YAAFI Avalon Context">
+ <section name="Avalon Context">
<p>
The components are initialized with an Avalon Context if the
implementation
1.2 +1 -1
jakarta-turbine-fulcrum/yaafi/xdocs/specification/lifecycle.xml
Index: lifecycle.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/specification/lifecycle.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- lifecycle.xml 1 Mar 2005 10:54:09 -0000 1.1
+++ lifecycle.xml 2 Mar 2005 09:42:05 -0000 1.2
@@ -9,7 +9,7 @@
<body>
- <section name="YAAFI Lifecycle Contract">
+ <section name="Lifecycle Contract">
<p>
The following contract is fulfilled by the Avalon YAAFI Container
1.3 +35 -11
jakarta-turbine-fulcrum/yaafi/xdocs/specification/role.xml
Index: role.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/specification/role.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- role.xml 1 Mar 2005 10:54:09 -0000 1.2
+++ role.xml 2 Mar 2005 09:42:05 -0000 1.3
@@ -9,7 +9,7 @@
<body>
- <section name="Role Configuration File">
+ <section name="Role Configuration">
<p>
The Role Configuration File is used to map the services to
@@ -21,13 +21,21 @@
<tr>
<th>Item</th>
<th>Datatype</th>
- <th>Optional</th>
+ <th>Cardinality</th>
<th>Description</th>
</tr>
<tr>
+ <td>role</td>
+ <td>Tree</td>
+ <td>[0..n]</td>
+ <td>
+ Metadata about a service component to be instantiated
+ </td>
+ </tr>
+ <tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The name of the service being used for the lookup. If
no value is defined then <b>[EMAIL PROTECTED]</b> will
@@ -37,7 +45,7 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The shorthand for referencing the section in the Component
Configuration File. If no value is defined then
@@ -47,7 +55,7 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>N</td>
+ <td>1</td>
<td>
The implementation class of the service.
</td>
@@ -55,7 +63,7 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>Boolean</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
Shall the service implementation class be instantiated
during startup of the container or on demand? If no
@@ -65,7 +73,7 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The type of component whereas we currently support "avalon"
only
</td>
@@ -73,7 +81,7 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
The flavour for the given component type either "phoenix",
"fortress",
"merlin", "yaafi". If no value is defined then <b>yaffi</b>
will be used.
@@ -82,15 +90,31 @@
<tr>
<td>[EMAIL PROTECTED]</td>
<td>String</td>
- <td>Y</td>
+ <td>[0|1]</td>
<td>
- A description what the service is actually doing.
+ A description what the service is actually doing.
</td>
</tr>
</table>
</subsection>
- <subsection name="Example">
+ <subsection name="Example 1">
+ <source>
+ <![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<role-list>
+ <role
+
name="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyService"
+ shorthand="SystemPropertyService"
+
default-class="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyServiceImpl"
+ />
+</role-list>
+ ]]>
+ </source>
+ </subsection>
+
+ <subsection name="Example 2">
<source>
<![CDATA[
<?xml version="1.0" encoding="ISO-8859-1"?>
1.4 +1 -1 jakarta-turbine-fulcrum/yaafi/xdocs/howto.xml
Index: howto.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/howto.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- howto.xml 1 Mar 2005 10:54:09 -0000 1.3
+++ howto.xml 2 Mar 2005 09:42:05 -0000 1.4
@@ -74,7 +74,7 @@
</p>
<source>
-container.dispose();
+ServiceContainerFactory.dispose(container);
</source>
</subsection>
1.5 +3 -4 jakarta-turbine-fulcrum/yaafi/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 1 Mar 2005 10:54:09 -0000 1.4
+++ index.xml 2 Mar 2005 09:42:05 -0000 1.5
@@ -42,12 +42,11 @@
<p>
<ul>
<li>a light-weight Avalon container only depending an the
Avalone Framwork libraries</li>
- <li>a container following the Merlin Avalon Framework
contract</li>
- <li>ability to be embedded in other Avalon containers</li>
- <li>ability to run components written for other Avalon
containers</li>
+ <li>a container which can run components written for ECM,
Fortress, Phoenix and Merlin</li>
+ <li>ability to be embedded in other Avalon containers such as
Phoenix</li>
<li>support for automatic reconfiguration for the whole
container or individual services</li>
<li>support for early or on-demand initialization</li>
- <li>support for decryption of configuration files</li>
+ <li>support for encrypted configuration files</li>
</ul>
</p>
</subsection>
1.5 +1 -1 jakarta-turbine-fulcrum/yaafi/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 1 Mar 2005 10:54:09 -0000 1.4
+++ navigation.xml 2 Mar 2005 09:42:05 -0000 1.5
@@ -28,7 +28,7 @@
<item name="Role Configuration"
href="/specification/role.html"/>
<item name="Component Configuration"
href="/specification/component.html"/>
<item name="Avalon Context"
href="/specification/context.html"/>
- <item name="YAAFI Lifecycle Contract"
href="/specification/lifecycle.html"/>
+ <item name="Lifecycle Contract"
href="/specification/lifecycle.html"/>
</item>
<item name="Todo's" href="/todo.html"/>
</menu>
1.4 +27 -0 jakarta-turbine-fulcrum/yaafi/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/todo.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- todo.xml 1 Mar 2005 10:54:09 -0000 1.3
+++ todo.xml 2 Mar 2005 09:42:05 -0000 1.4
@@ -10,6 +10,33 @@
<body>
<section name="TODO">
+
+ <subsection name="Long-term Compatibilty with Fortress">
+ <p>
+ Since Fortress is the only other remaining Avalon container
+ within Jakarta we try to achieve compatibility with Fortress
+ regarding configuration files. The problem is that there is no
+ specification available how the Fortress configuration files
+ look loke ... :-(
+ </p>
+ </subsection>
+
+ <subsection name="Testing the cross-container portabilty">
+ <p>
+ YAAFI actually maps the Avalon context depending on the container
+ flavour of the service component. We still need to test this
+ functionality with Fortress services.
+ </p>
+ </subsection>
+
+ <subsection name="Use URLConnection for InputStreamLocator">
+ <p>
+ Using a URLConnection enables downloading the configuration
+ files from a HTTP server therefore allowing to run a set
+ of application distributed over multiple boxes from a single
+ configuration file.
+ </p>
+ </subsection>
</section>
1.2 +3 -2
jakarta-turbine-fulcrum/yaafi/xdocs/services/servicemanagerservice.xml
Index: servicemanagerservice.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/yaafi/xdocs/services/servicemanagerservice.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- servicemanagerservice.xml 9 Nov 2004 09:49:46 -0000 1.1
+++ servicemanagerservice.xml 2 Mar 2005 09:42:05 -0000 1.2
@@ -30,12 +30,13 @@
<section name="Usage">
<p>
- ServiceManagerService.getServiceManager() returns you an
instance of
+ ServiceManagerServiceImpl.getInstance() returns you an
instance of
ServiceManager which allows to lookup other services.
</p>
<source>
-FOO foo = (FOO) ServiceManagerService.getServiceManager().lookup("FOO");
+ServiceManagerServiceImpl.getInstance().hasService("FOO");
+FOO foo = (FOO) ServiceManagerServiceImpl.getInstance().lookup("FOO");
</source>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
