You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by mp...@apache.org on 2002/11/16 18:36:44 UTC
cvs commit: jakarta-turbine-2/xdocs/services index.xml navigation.xml db-service.xml
mpoeschl 2002/11/16 09:36:44
Modified: xdocs building.xml features.xml getting-started.xml
j2ee-integration.xml navigation.xml
xdocs/services db-service.xml
Added: xdocs/howto index.xml navigation.xml
xdocs/services index.xml navigation.xml
Removed: xdocs howtos.xml services.xml
Log:
doc updates
- add subnavigations for services and howtos
- fix some broken links
- remove some old stuff
Revision Changes Path
1.2 +0 -7 jakarta-turbine-2/xdocs/building.xml
Index: building.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/building.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- building.xml 16 Aug 2001 05:10:07 -0000 1.1
+++ building.xml 16 Nov 2002 17:36:44 -0000 1.2
@@ -25,12 +25,5 @@
</ol>
</p>
</section>
- <section name="Torque">
- <p>
- For instructions on building Torque, see
- <a href="howto/torque-howto.html">this document</a>.
- </p>
- </section>
-
</body>
</document>
1.2 +2 -5 jakarta-turbine-2/xdocs/features.xml
Index: features.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/features.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- features.xml 16 Aug 2001 05:10:07 -0000 1.1
+++ features.xml 16 Nov 2002 17:36:44 -0000 1.2
@@ -28,7 +28,7 @@
<p>
<strong>All of these features have been made possible thanks to the over
-30 developers (and growing all the time!) who have <a href="contributors.html">
+30 developers (and growing all the time!) who have <a href="team-list.html">
contributed</a> to Turbine over the last 2+ years.</strong>
</p>
@@ -43,9 +43,6 @@
<li>
Single Entry Point Servlet model for optimal security and control</li>
<li>
- Singleton based Database Connection Pool (JDBC) with built in support
- for all of the major databases</li>
- <li>
ParameterParsing for GET/POST/PATH_INFO</li>
<li>
Event based Action handling!</li>
@@ -99,7 +96,7 @@
Integration with JavaMail and Velocity/WebMacro to allow you to send
processed Velocity templates as email!</li>
<li>
- Built using Ant</li>
+ Built using Maven</li>
<li>
Initial application development WAR archive creation tool using Ant</li>
<li>
1.3 +1 -25 jakarta-turbine-2/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/getting-started.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- getting-started.xml 17 Feb 2002 05:12:20 -0000 1.2
+++ getting-started.xml 16 Nov 2002 17:36:44 -0000 1.3
@@ -34,7 +34,6 @@
</section>
<section name="Code Organization">
-
<p>
Turbine can be used in three different ways depending on what you need.
You can choose to only use one way or choose to use all three. It is up
@@ -105,13 +104,11 @@
well as many other commonly used web application tools.
</li>
</ul>
-
</section>
<section name="Standalone Usage">
-
<p>
-Turbine can be easily used on its own. In order to do so, all you need
+Turbine can be easily used on its own. In order to do so, all you need
to do is something like this before you attempt to make a call to Turbine
based code:
</p>
@@ -129,25 +126,6 @@
object. For more information, please see the javadoc for the
TurbineConfig object.
</p>
-
-</section>
-
-<section name="Generating the Turbine Javadocs">
-<p>
-To generate the Javadocs for Turbine check out Turbine from CVS,
-cd to the 'build' directory and execute the <strong>javadocs</strong> target:
-
-</p>
-
-<source>
-cd jakarta-turbine/build
-ant javadocs
-</source>
-
-<p>
-The javadocs will be generated in the ../docs/apidocs directory.
-</p>
-
</section>
<section name="Further Questions and Comments">
@@ -157,7 +135,5 @@
</p>
</section>
-
</body>
</document>
-
1.3 +5 -4 jakarta-turbine-2/xdocs/j2ee-integration.xml
Index: j2ee-integration.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/j2ee-integration.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- j2ee-integration.xml 27 Mar 2002 18:53:13 -0000 1.2
+++ j2ee-integration.xml 16 Nov 2002 17:36:44 -0000 1.3
@@ -98,7 +98,7 @@
<td>
<p>
Turbine provides support for using and working with XML. Again, nothing
-preventing you from using XML within Turbine or even sending XML out
+preventing you from using XML within Turbine or even sending XML out
of Turbine.
</p>
</td>
@@ -109,7 +109,8 @@
<p>
Turbine provides good support for working with JDBC through the <a
href="http://share.whichever.com/village/">Village API</a>, the <a
-href="howto/torque-howto.html">Torque Object Relational Tool</a> and its connection
+href="http://jakarta.apache.org/turbine/torque/user-guide.html">
+Torque Object Relational Tool</a> and its connection
pooling facilities. The connection pool is not yet fully J2EE
"compatible" in that it does not support DataSources. However, at some
point we may choose to implement that. Note, again, Turbine does not
@@ -170,10 +171,10 @@
<p>
On the other hand, you don't need to write any code to use declarative
container managed security. You can restrict access to the Turbine
-servlet with the usual web.xml magic. If you wish to use programmatic
+servlet with the usual web.xml magic. If you wish to use programmatic
container managed security code, there is relatively very little code to write.
You need to create your own SecureScreens (probably extending VelocityScreen)
-and SecureActions that contained code that calls the <code>HttpServletRequest
+and SecureActions that contained code that calls the <code>HttpServletRequest
getUserPrincipal</code> and <code>isUserInRole</code> methods.
above.
</p>
1.3 +2 -2 jakarta-turbine-2/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 14 Nov 2002 23:24:19 -0000 1.2
+++ navigation.xml 16 Nov 2002 17:36:44 -0000 1.3
@@ -29,8 +29,8 @@
<item name="J2EE Integration" href="/j2ee-integration.html"/>
<item name="Model 2+1" href="/model2+1.html"/>
<item name="Pull MVC Model" href="/pullmodel.html"/>
- <item name="Services" href="/services.html"/>
- <item name="Howtos" href="/howtos.html"/>
+ <item name="Services" href="/services/index.html"/>
+ <item name="Howtos" href="/howto/index.html"/>
</menu>
<menu name="Development">
1.1 jakarta-turbine-2/xdocs/howto/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Turbine</title>
<author email="jason@zenplex.com">Jason van Zyl</author>
</properties>
<body>
<section name="Howtos">
<p>
<ul>
<li><a href="howto/action-event-howto.html">Action Events Howto</a></li>
<li><a href="howto/extend-user-howto.html">Extend User Howto</a></li>
<li><a href="howto/jboss-howto.html">JBoss Howto</a></li>
<li><a href="howto/jsp-howto.html">JSP Howto</a></li>
<li><a href="howto/intake-howto.html">Intake Howto</a></li>
<li><a href="howto/pullmodel-howto.html">Pull Model Howto</a></li>
<li><a href="howto/python-howto.html">Python Howto</a></li>
<li><a href="howto/security-howto.html">Security Howto</a></li>
<li><a href="howto/url-rewriting-howto.html">URL rewriting Howto</a></li>
<li><a href="howto/velocity-site-howto.html">Velocity Site Howto</a></li>
<li><a href="howto/context-howto.html">Velocity Context Howto</a></li>
<li><a href="howto/webmacro-site-howto.html">Webmacro Site Howto</a></li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-turbine-2/xdocs/howto/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Turbine"
href="http://jakarta.apache.org/turbine/">
<title>Turbine</title>
<body>
<links>
<item name="Turbine" href="http://jakarta.apache.org/turbine/"/>
<item name="Turbine-2" href="http://jakarta.apache.org/turbine/turbine-2/"/>
<item name="Turbine-3" href="http://jakarta.apache.org/turbine/turbine-3/"/>
<item name="Torque" href="http://jakarta.apache.org/turbine/torque/"/>
<item name="Fulcrum" href="http://jakarta.apache.org/turbine/fulcrum/"/>
<item name="TDK" href="http://jakarta.apache.org/turbine/tdk/"/>
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
<item name="JCS" href="http://jakarta.apache.org/turbine/jcs/"/>
</links>
<menu name="Essentials">
<item name="Overview" href="/index.html"/>
<item name="Features" href="/features.html"/>
<item name="Specification" href="/fsd.html"/>
<item name="Getting Started" href="/getting-started.html"/>
<item name="Changes" href="/changes.html"/>
</menu>
<menu name="Documentation">
<item name="Core Schema" href="/turbine-schema.html"/>
<item name="J2EE Integration" href="/j2ee-integration.html"/>
<item name="Model 2+1" href="/model2+1.html"/>
<item name="Pull MVC Model" href="/pullmodel.html"/>
<item name="Services" href="/services/index.html"/>
<item name="Howtos" href="/howto/index.html">
<item name="Action Events Howto" href="/howto/action-event-howto.html"/>
<item name="Extend User Howto" href="/howto/extend-user-howto.html"/>
<item name="JBoss Howto" href="/howto/jboss-howto.html"/>
<item name="JSP Howto" href="/howto/jsp-howto.html"/>
<item name="Intake Howto" href="/howto/intake-howto.html"/>
<item name="Pull Model Howto" href="/howto/pullmodel-howto.html"/>
<item name="Python Howto" href="/howto/python-howto.html"/>
<item name="Security Howto" href="/howto/security-howto.html"/>
<item name="URL rewriting Howto" href="/howto/url-rewriting-howto.html"/>
<item name="Velocity Site Howto" href="/howto/velocity-site-howto.html"/>
<item name="Velocity Context Howto" href="/howto/context-howto.html"/>
<item name="Webmacro Site Howto" href="/howto/webmacro-site-howto.html"/>
</item>
</menu>
<menu name="Development">
<item name="Project Map" href="/project-map.html"/>
<item name="Proposals" href="/proposals.html"/>
<item name="Todo" href="/todo.html"/>
</menu>
</body>
</project>
1.2 +2 -0 jakarta-turbine-2/xdocs/services/db-service.xml
Index: db-service.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/db-service.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- db-service.xml 16 Aug 2001 05:10:43 -0000 1.1
+++ db-service.xml 16 Nov 2002 17:36:44 -0000 1.2
@@ -11,6 +11,8 @@
<section name="DB Service">
<p>
+<b>This service is deprecated. It is just a facade for Torque.</b>
+<br/>
'DB Service' includes two services:
<ul>
<li>PoolBrokerService - provides database connection pooling</li>
1.1 jakarta-turbine-2/xdocs/services/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Turbine Services</title>
<author email="criley@ekmail.com">Cameron Riley</author>
<author email="jvanzyl@apache.org">Jason van Zyl</author>
<author email="jon@latchkey.com">Jon S. Stevens</author>
</properties>
<body>
<section name="Turbine Services">
<p>
Services are singletons within the Turbine Framework which have
pluggable implementation, and are capable of participating in the
Turbine startup and shutdown. As Services are Singletons, there is
only one instance of each service in the system. Memory or connections
are allocated once only and the internal state is common to all
requesting clients. Services can access ServletConfig at system
startup time to process relative paths and similar functionality, they
can also access RunData on the first Turbine doGet execution to get
the environment Turbine is operating under and with. Services can also
initialize themselves before they are requested by the client for the
first time. A Service that is never used will not allocate resources to
itself. A Service can also execute actions upon the system being
shutdown, such as closing open connections. The Singleton pattern also
allows for the Services to be accessed from anywhere within your code.
</p>
<p>
The Life Cycle of a Service begins with the Services constructor. A Service
does not do much in it's contructor. Especially it should not allocate any
costly resources like large memory structure, DB or Network connections, etc.
The Service may be in the properties file, but unless a client using the
application needs the Service in question, there is no point starting the
Service.
</p>
<p>
The services available with Turbine can be found in the
org.apache.turbine.services package. <strong>Please note that the
[TODO]'s below simply mean that these services need more complete
documentation, it does not mean that they are still waiting to be
implemented.</strong>
</p>
<ul>
<li>
<a href="services/assemblerbroker-service.html">Assembler Broker Service</a>
<br/>
Is the Service which allows assemblers such as Screens, Actions, Layout and
Scheduled Jobs to be loaded.
</li>
<li>
<a href="services/cache-service.html">Cache Service</a>
<br/>
Provides a persistant Object Storage mechanism within your application.
</li>
<li>
<a href="services/castor-service.html">Castor Service</a>
<br/>
Castor is a OR tool that is supported by Turbine.
</li>
<li>
<a href="services/component-service.html">Component Service</a>
<br/>
Initializes external components which implement the lifecycle interface, e.g. Torque und Fulcrum.
</li>
<li>
<a href="services/db-service.html">DB Service (deprecated)</a>
<br/>
Is a common front end to all database systems.
This service also provides the brokers for Connection Pooling and Database Map Objects.
</li>
<li>
<a href="services/factory-service.html">Factory Service</a>
<br/>
A Service for the instantiation of objects with either the specified loaders or
default class loaders.
</li>
<li>
<a href="services/freemarker-service.html">FreeMarker Service</a>
<br/>
The FreeMarker Service is the set of classes that process FreeMarker
files inside the Turbine Layout/Navigations and Screen structure.
</li>
<li>
<a href="services/intake-service.html">Intake Service</a>
<br/>
A service that provides input validation along with a standard
parameter naming framework.
</li>
<li>
<a href="services/jsp-service.html">JSP Service</a>
<br/>
The JSP Service is the set of classes that process JSP files inside the
Turbine Layout/Navigations and Screen structure.
</li>
<li>
<a href="services/localization-service.html">Localization Service</a>
<br/>
The single point of access to all localization resources.
</li>
<li>
<a href="services/logging-service.html">Logging Service</a>
<br/>
The default Loggin implementation for Turbine, logging can be either
through an explicite getLogger() method or by standard printing methods
such as info or debug.
</li>
<li>
<a href="services/mimetype-service.html">MimeType Service</a>
<br/>
The service maintains the mappings between MIME types and corresponding file
name extensions as well as between locales and character encoding.
</li>
<li>
<a href="services/naming-service.html">Naming Service</a>
<br/>
Provides JNDI naming contexts.
</li>
<li>
<a href="services/pool-service.html">Pool Service</a>
<br/>
A service for the pooling of instantiated Objects, allowing for the recycling
and disposal of Objects in the pool.
</li>
<li>
<a href="services/pull-service.html">Pull Service</a>
<br/>
Manages the creation of application tools that are available to all templates
in a Turbine application. The tools can have global scope, request scope, session
scope or persistant scope within your application.
</li>
<li>
<a href="services/resources-service.html">Resources Service</a>
<br/>
<b>[TO DO (Configuration)]</b> The Resources Service is the set of classes and
the functionality that allows for the reading and acccessing data
from within properties files.
</li>
<li>
<a href="services/rundata-service.html">RunData Service</a>
<br/>
Is the Service which manages the higher level operations surrounding
requests and responses.
</li>
<li>
<a href="services/scheduler-service.html">Scheduler Service</a>
<br/>
This service manages the schedule queue giving Cron like functionality.
The ScheduledJob can be stored in a database or a properties file.
</li>
<li>
<a href="services/security-service.html">Security Service</a>
<br/>
<b>[TO DO]</b> A service for the management of Users, Groups, Roles and Permissions
in the system, allowing for those Objects to interact with either
Database or LDAP backends. The service also allows for the security to be managed
without a backend.
</li>
<li>
<a href="services/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="services/template-service.html">Template Service</a>
<br/>
<b>[TO DO]</b> The Service for the mapping of templates to their
screens and actions.
</li>
<li>
<a href="services/uniqueid-service.html">Unique ID Service</a>
<br/>
Allows for the creation of Context unique and pseudo random identifiers.
</li>
<li>
<a href="services/upload-service.html">Upload Service</a>
<br/>
This service manages multipart/form-data POST requests, storing them
temporarily in memory or locally. The resultant Objects can be manipulated through
a FileItem Object.
</li>
<li>
<a href="services/velocity-service.html">Velocity Service</a>
<br/>
<b>[TO DO]</b> The service for the processing of Velocity Templates from within
the Turbine Layout/Navigations and Screen structure.
</li>
<li>
<a href="services/webmacro-service.html">WebMacro Service</a>
<br/>
<b>[TO DO]</b> The service for the processing of WebMacro Templates from within
Turbine Layout/Navigations and Screen structure.
</li>
<li>
<a href="services/xmlrpc-service.html">XML-RPC Service</a>
<br/>
This service manages xml-rpc calls to a remote Server.
</li>
<li>
<a href="services/xslt-service.html">XSLT Service</a>
<br/>
The service which is used to transform XML with an XSLT stylesheet.
</li>
</ul>
<p>
For more information on the Services Package, view the package.html Package
Documentation in the Javadocs or in Turbine CVS.
</p>
</section>
</body>
</document>
1.1 jakarta-turbine-2/xdocs/services/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Turbine"
href="http://jakarta.apache.org/turbine/">
<title>Turbine</title>
<body>
<links>
<item name="Turbine" href="http://jakarta.apache.org/turbine/"/>
<item name="Turbine-2" href="http://jakarta.apache.org/turbine/turbine-2/"/>
<item name="Turbine-3" href="http://jakarta.apache.org/turbine/turbine-3/"/>
<item name="Torque" href="http://jakarta.apache.org/turbine/torque/"/>
<item name="Fulcrum" href="http://jakarta.apache.org/turbine/fulcrum/"/>
<item name="TDK" href="http://jakarta.apache.org/turbine/tdk/"/>
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
<item name="JCS" href="http://jakarta.apache.org/turbine/jcs/"/>
</links>
<menu name="Essentials">
<item name="Overview" href="/index.html"/>
<item name="Features" href="/features.html"/>
<item name="Specification" href="/fsd.html"/>
<item name="Getting Started" href="/getting-started.html"/>
<item name="Changes" href="/changes.html"/>
</menu>
<menu name="Documentation">
<item name="Core Schema" href="/turbine-schema.html"/>
<item name="J2EE Integration" href="/j2ee-integration.html"/>
<item name="Model 2+1" href="/model2+1.html"/>
<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="Cache Service" href="/services/cache-service.html"/>
<item name="Castor Service" href="/services/castor-service.html"/>
<item name="Component Service" href="/services/component-service.html"/>
<item name="DB Service (deprecated)" href="/services/db-service.html"/>
<item name="Factory Service" href="/services/factory-service.html"/>
<item name="FreeMarker Service" href="/services/freemarker-service.html"/>
<item name="Intake Service" href="/services/intake-service.html"/>
<item name="JSP Service" href="/services/jsp-service.html"/>
<item name="Localization Service" href="/services/localization-service.html"/>
<item name="Logging Service" href="/services/logging-service.html"/>
<item name="MimeType Service" href="/services/mimetype-service.html"/>
<item name="Naming Service" href="/services/naming-service.html"/>
<item name="Pool Service" href="/services/pool-service.html"/>
<item name="Pull Service" href="/services/pull-service.html"/>
<item name="Resources Service" href="/services/resources-service.html"/>
<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="Servlet Service" href="/services/servlet-service.html"/>
<item name="Template Service" href="/services/template-service.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"/>
<item name="WebMacro Service" href="/services/webmacro-service.html"/>
<item name="XML-RPC Service" href="/services/xmlrpc-service.html"/>
<item name="XSLT Service" href="/services/xslt-service.html"/>
</item>
<item name="Howtos" href="/howto/index.html"/>
</menu>
<menu name="Development">
<item name="Project Map" href="/project-map.html"/>
<item name="Proposals" href="/proposals.html"/>
<item name="Todo" href="/todo.html"/>
</menu>
</body>
</project>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>