You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by se...@apache.org on 2003/09/03 02:51:12 UTC
cvs commit: jakarta-turbine-2/xdocs/services avalon-component-service.xml security-service.xml navigation.xml index.xml component-service.xml
seade 2003/09/02 17:51:12
Modified: xdocs/services security-service.xml navigation.xml index.xml
component-service.xml
Added: xdocs/services avalon-component-service.xml
Log:
Tidy up services doco.
Revision Changes Path
1.5 +8 -0 jakarta-turbine-2/xdocs/services/security-service.xml
Index: security-service.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/security-service.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- security-service.xml 13 Jan 2003 00:13:22 -0000 1.4
+++ security-service.xml 3 Sep 2003 00:51:12 -0000 1.5
@@ -15,6 +15,14 @@
The Security Service is for authenticating users and assigning them roles
and permissions in groups.
</p>
+<p>
+In Turbine 2.3 a replacement for the default DBSecurityService is
+provided that makes it possible to map the security service onto an
+pre existing user structure and much easier to extend the TurbineUser
+table to include additional columns - see <a
+href="torque-Security-service.html"> Torque Security Service</a> for
+configuration details.
+</p>
</section>
1.7 +4 -2 jakarta-turbine-2/xdocs/services/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/navigation.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- navigation.xml 24 Jun 2003 08:16:59 -0000 1.6
+++ navigation.xml 3 Sep 2003 00:51:12 -0000 1.7
@@ -31,6 +31,8 @@
<item name="Pull MVC Model" href="/pullmodel.html"/>
<item name="Services" href="/services/index.html">
<item name="Assembler Broker Service" href="/services/assemblerbroker-service.html"/>
+ <item name="Avalon Component Service" href="/services/avalon-component-service.html"/>
+ <item name="Crypto Service" href="/services/crypto-service.html"/>
<item name="Cache Service" href="/services/cache-service.html"/>
<item name="Component Service" href="/services/component-service.html"/>
<item name="Factory Service" href="/services/factory-service.html"/>
@@ -46,11 +48,11 @@
<item name="RunData Service" href="/services/rundata-service.html"/>
<item name="Scheduler Service" href="/services/scheduler-service.html"/>
<item name="Security Service" href="/services/security-service.html"/>
- <item name="Torque Security Service" href="/services/torque-security-service.html"/>
- <item name="Torque Security Service Schema" href="/services/torque-security-schema.html"/>
<item name="Servlet Service" href="/services/servlet-service.html"/>
<item name="Session Service" href="/services/session-service.html"/>
<item name="Template Service" href="/services/template-service.html"/>
+ <item name="Torque Security Service" href="/services/torque-security-service.html"/>
+ <item name="Torque Security Service Schema" href="/services/torque-security-schema.html"/>
<item name="Unique ID Service" href="/services/uniqueid-service.html"/>
<item name="Upload Service" href="/services/upload-service.html"/>
<item name="Velocity Service" href="/services/velocity-service.html"/>
1.9 +23 -7 jakarta-turbine-2/xdocs/services/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/index.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- index.xml 12 Jan 2003 16:22:48 -0000 1.8
+++ index.xml 3 Sep 2003 00:51:12 -0000 1.9
@@ -7,6 +7,7 @@
<author email="jvanzyl@apache.org">Jason van Zyl</author>
<author email="jon@latchkey.com">Jon S. Stevens</author>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
+ <author email="seade@backstagetech.com.au">Scott Eade</author>
</properties>
<body>
@@ -57,6 +58,13 @@
</li>
<li>
+<a href="avalon-component-service.html">Avalon Component Service</a>
+<br/>
+Initializes external components which implement the Avalon lifecycle
+interface, e.g. Torque.
+</li>
+
+<li>
<a href="crypto-service.html">Crypto Service</a>
<br/>
Provides encryption algorithms like MD5 and SHA message digests as well as old-fashioned Unix crypt.
@@ -71,7 +79,9 @@
<li>
<a href="component-service.html">Component Service</a>
<br/>
-Initializes external components which implement the lifecycle interface, e.g. Torque und Fulcrum.
+Initializes external components which implement the Stratum lifecycle
+interface, e.g. Torque and Fulcrum. Any new components will use the
+Avalon lifecycle and thus the Avalon Component Service.
</li>
<li>
@@ -168,23 +178,29 @@
</li>
<li>
+<a href="servlet-service.html">Servlet Service</a>
+<br/>
+Encapsulates the information provided by the ServletContext API,
+and makes it available from anywhere in the code.
+</li>
+
+<li>
<a href="session-service.html">Session Service</a>
<br/>
Provides access to Session information for the current web context.
</li>
<li>
-<a href="servlet-service.html">Servlet Service</a>
+<a href="template-service.html">Template Service</a>
<br/>
-Encapsulates the information provided by the ServletContext API,
-and makes it available from anywhere in the code.
+The Service for the mapping of templates to their screens and actions.
</li>
<li>
-<a href="template-service.html">Template Service</a>
+<a href="torque-security-service.html">Torque Security Service</a>
<br/>
-<b>[TO DO]</b> The Service for the mapping of templates to their
-screens and actions.
+This is an implementation of a Security Service which uses Torque
+generated peers to access the required security information.
</li>
<li>
1.2 +11 -4 jakarta-turbine-2/xdocs/services/component-service.xml
Index: component-service.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/component-service.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- component-service.xml 24 Jul 2002 15:01:34 -0000 1.1
+++ component-service.xml 3 Sep 2003 00:51:12 -0000 1.2
@@ -14,10 +14,9 @@
org.apache.stratum.lifecycle Interfaces for use with Turbine 2.
</p>
<p>
-Main usage for this are the <a
-href="http://jakarta.apache.org/turbine/torque/">Torque</a> and <a
-href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
-components of the <a
+Main usage for this are the <a href="http://db.apache.org/torque/">
+Torque</a> and <a href="http://jakarta.apache.org/turbine/fulcrum/">
+Fulcrum</a> components of the <a
hef="http://jakarta.apache.org/turbine/">Turbine</a> project.
</p>
@@ -25,6 +24,14 @@
As Turbine-2 now uses the decoupled Torque, you must initialize Torque
at startup. Fulcrum is currently not integrated in Turbine-2.2 but you
can use some services from it.
+</p>
+
+<p>
+As of version 2.3 Turbine now provides an
+<a href="avalon-component-service.html">Avalon Component Service</a>
+that can be used to configure Torque. In future releases additional
+components will be migrated to Avalon components, most likely as part
+of Fulcrum.
</p>
</section>
1.1 jakarta-turbine-2/xdocs/services/avalon-component-service.xml
Index: avalon-component-service.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Turbine Services - Avalon Component Service</title>
<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
<author email="seade@backstagetech.com.au">Scott Eade</author>
</properties>
<body>
<section name="Avalon Component Service">
<p>
The Avalon Component service loads external modules which implement the
<a href="http://avalon.apache.org/">Avalon</a> lifecycle interfaces.
</p>
<p>
The only supported component at this point in time is
<a href="http://db.apache.org/torque/">Torque</a>, though the
<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
components are likely to be migrated to become Avalon components
in the future.
</p>
</section>
<section name="Configuration">
<source><![CDATA[
# -------------------------------------------------------------------
#
# S E R V I C E S
#
# -------------------------------------------------------------------
# Classes for Turbine Services should be defined here.
# Format: services.[name].classname=[implementing class]
#
# To specify properties of a service use the following syntax:
# service.[name].[property]=[value]
services.AvalonComponentService.classname = org.apache.turbine.services.avaloncomponent.TurbineAvalonComponentService
.
.
.
# -------------------------------------------------------------------
#
# A V A L O N C O M P O N E N T S E R V I C E
#
# -------------------------------------------------------------------
# Components implementing the avalon lifecycle interfaces can be
# loaded, configured and initialized by Turbine
# -------------------------------------------------------------------
services.AvalonComponentService.componentConfiguration = /WEB-INF/conf/componentConfiguration.xml
services.AvalonComponentService.componentRoles = /WEB-INF/conf/roleConfiguration.xml
services.AvalonComponentService.lookup = org.apache.torque.avalon.Torque
]]></source>
<p>
In /WEB-INF/conf you should provide componentConfiguration.xml:
</p>
<source><![CDATA[
<componentConfig>
<torque>
<configfile>/WEB-INF/conf/torque.properties</configfile>
</torque>
</componentConfig>
]]></source>
<p>
and roleConfiguration.xml:
</p>
<source><![CDATA[
<role-list>
<role name="org.apache.torque.avalon.Torque"
shorthand="torque"
default-class="org.apache.torque.avalon.TorqueComponent" />
</role-list>
]]></source>
<p>
No changes to torque.properties are required.
</p>
<p>
If all goes well you should see the following in your log file when
Turbine starts up:
</p>
<source><![CDATA[
...INFO...services.BaseServiceBroker - Added Mapping for Service: AvalonComponentService
...INFO...services.BaseServiceBroker - Start Initializing service (early): AvalonComponentService
...INFO...services.avaloncomponent.TurbineAvalonComponentService - Lookup for Component org.apache.torque.avalon.Torque successful
...INFO...services.BaseServiceBroker - Finish Initializing service (early): AvalonComponentService
]]></source>
</section>
<section name="Usage">
<p>
If you plan to use the decoupled Torque in your application, you should
leave the Avalon Component Service configured at all times. It is started at
early startup time. Once it has initialized all the components, there
are no application specific methods or services available.
</p>
</section>
</body>
</document>