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 2001/06/19 23:51:55 UTC
cvs commit: jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator TemplateSessionValidator.java
mpoeschl 01/06/19 14:51:55
Modified: src/java/org/apache/turbine/services/db
TurbineDatabaseService.java DatabaseService.java
TurbineDB.java
src/java/org/apache/turbine/services
InstantiationException.java
InitializationException.java TurbineServices.java
src/java/org/apache/turbine/modules/actions/sessionvalidator
TemplateSessionValidator.java
Log:
fixe some javadoc warnings
Revision Changes Path
1.2 +2 -2 jakarta-turbine/src/java/org/apache/turbine/services/db/TurbineDatabaseService.java
Index: TurbineDatabaseService.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/db/TurbineDatabaseService.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TurbineDatabaseService.java 2001/06/14 14:39:18 1.1
+++ TurbineDatabaseService.java 2001/06/19 21:51:48 1.2
@@ -71,7 +71,7 @@
import org.apache.turbine.util.db.pool.DBConnection;
/**
- * Turbine's default implmentation of {@link DatabaseBrokerService}.
+ * Turbine's default implementation of {@link DatabaseService}.
*
* @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
* @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
@@ -80,7 +80,7 @@
* @author <a href="mailto:magnus@handtolvur.is">Magn�s ��r Torfason</a>
* @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
* @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: TurbineDatabaseService.java,v 1.1 2001/06/14 14:39:18 jvanzyl Exp $
+ * @version $Id: TurbineDatabaseService.java,v 1.2 2001/06/19 21:51:48 mpoeschl Exp $
*/
public class TurbineDatabaseService
extends BaseService
1.2 +22 -5 jakarta-turbine/src/java/org/apache/turbine/services/db/DatabaseService.java
Index: DatabaseService.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/db/DatabaseService.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DatabaseService.java 2001/06/14 14:39:17 1.1
+++ DatabaseService.java 2001/06/19 21:51:48 1.2
@@ -61,13 +61,30 @@
import org.apache.turbine.util.db.adapter.DB;
/**
- * This service manages {@link org.apache.turbine.util.db.map.DatabaseMap}
- * objects used throughout a Turbine application. It provides single point
- * of access to a pool of maps, assuring that every client will access
- * the same instance of DatabaseMap object.
+ * This service provides database connection pooling and manages
+ * {@link org.apache.turbine.util.db.map.DatabaseMap} objects used throughout
+ * a Turbine application.
+ * It provides single point of access to a pool of maps, assuring that every
+ * client will access the same instance of DatabaseMap object.
*
+ * The service can manage a number of connection pools. Each pool is related
+ * to a specific database, identified by it's driver class name, url, username
+ * and password. The pools may be defined in TurbineResources.properties
+ * file, or created at runtime using
+ * {@link #registerPool(String,String,String,String,String)} method.
+ *
+ * <p> You can use {@link #getConnection(String)} to acquire a
+ * {@link org.apache.turbine.util.db.pool.DBConnection} object, which in
+ * turn can be used to create <code>java.sql.Statement</code> objects.
+ *
+ * <p>When you are done using the <code>DBConnection</code> you <strong>must</strong>
+ * return it to the pool using {@link #releaseConnection(DBConnection)} method.
+ * This method call is often placed in <code>finally</code> clause of a <code>try /
+ * catch</code> statement, to ensure that the connection is always returned
+ * to the pool.<br>
+ *
* @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: DatabaseService.java,v 1.1 2001/06/14 14:39:17 jvanzyl Exp $
+ * @version $Id: DatabaseService.java,v 1.2 2001/06/19 21:51:48 mpoeschl Exp $
*/
public interface DatabaseService extends Service
{
1.10 +4 -6 jakarta-turbine/src/java/org/apache/turbine/services/db/TurbineDB.java
Index: TurbineDB.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/db/TurbineDB.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- TurbineDB.java 2001/06/14 14:39:18 1.9
+++ TurbineDB.java 2001/06/19 21:51:49 1.10
@@ -61,11 +61,9 @@
import org.apache.turbine.services.TurbineServices;
/**
- * This class provides a common front end to all database - related
- * services in Turbine. Currently these are {@link PoolBrokerService} and
- * {@link MapBrokerService}. This class contains static methods that you
- * can call to access the methods of system's configured service
- * implementations.
+ * This class provides a common front end to the DatabaseService in Turbine.
+ * This class contains static methods that you can call to access the methods
+ * of system's configured service implementations.
* <p>
* Assuming that your TurbineResources.properties file is setup correctly, the
* sample code below demonstrates the right way to get and release a database
@@ -95,7 +93,7 @@
* </pre></code></blockquote>
*
* @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: TurbineDB.java,v 1.9 2001/06/14 14:39:18 jvanzyl Exp $
+ * @version $Id: TurbineDB.java,v 1.10 2001/06/19 21:51:49 mpoeschl Exp $
*/
public abstract class TurbineDB
{
1.8 +1 -2 jakarta-turbine/src/java/org/apache/turbine/services/InstantiationException.java
Index: InstantiationException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/InstantiationException.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- InstantiationException.java 2001/03/06 06:11:47 1.7
+++ InstantiationException.java 2001/06/19 21:51:51 1.8
@@ -63,8 +63,7 @@
*
* @author <a href="mailto:burton@apache.org">Kevin Burton</a>
* @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: InstantiationException.java,v 1.7 2001/03/06 06:11:47 chrise Exp $
- * @see org.apache.turbine.services.Initable
+ * @version $Id: InstantiationException.java,v 1.8 2001/06/19 21:51:51 mpoeschl Exp $
*/
public class InstantiationException
extends TurbineRuntimeException
1.7 +2 -4 jakarta-turbine/src/java/org/apache/turbine/services/InitializationException.java
Index: InitializationException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/InitializationException.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- InitializationException.java 2001/03/06 06:11:47 1.6
+++ InitializationException.java 2001/06/19 21:51:51 1.7
@@ -57,13 +57,11 @@
import org.apache.turbine.util.TurbineException;
/**
- * Thrown by <code>Initable</code> class in case of initialization
- * problems.
+ * Thrown in case of initialization problems.
*
* @author <a href="mailto:burton@apache.org">Kevin Burton</a>
* @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: InitializationException.java,v 1.6 2001/03/06 06:11:47 chrise Exp $
- * @see org.apache.turbine.services.Initable
+ * @version $Id: InitializationException.java,v 1.7 2001/06/19 21:51:51 mpoeschl Exp $
*/
public class InitializationException
extends TurbineException
1.30 +2 -5 jakarta-turbine/src/java/org/apache/turbine/services/TurbineServices.java
Index: TurbineServices.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/TurbineServices.java,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- TurbineServices.java 2001/06/14 15:06:09 1.29
+++ TurbineServices.java 2001/06/19 21:51:52 1.30
@@ -70,7 +70,7 @@
* @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a>
* @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
- * @version $Id: TurbineServices.java,v 1.29 2001/06/14 15:06:09 jvanzyl Exp $
+ * @version $Id: TurbineServices.java,v 1.30 2001/06/19 21:51:52 mpoeschl Exp $
*/
public class TurbineServices
extends BaseServiceBroker
@@ -117,10 +117,7 @@
*
* <p> Note that this way you will receive a 'collapsed' version
* of your resources - multiple entries with the same key will
- * have only one value stored. Use the {@link #getConfiguration}
- * or {@link #getResources} method to take advantage of the capabilities
- * of the {@link org.apache.turbine.services.resources.TurbineResources}
- * class.
+ * have only one value stored.
*
* @param name The name of the service.
* @return Properties of requested Service.
1.7 +3 -3 jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSessionValidator.java
Index: TemplateSessionValidator.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/modules/actions/sessionvalidator/TemplateSessionValidator.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TemplateSessionValidator.java 2001/06/19 01:41:16 1.6
+++ TemplateSessionValidator.java 2001/06/19 21:51:54 1.7
@@ -63,16 +63,16 @@
/**
* SessionValidator for use with the Template Service, the
* TemplateSessionValidator is virtually identical to the
- * TemplateSecureValidator except that it does not tranfer to the
+ * TemplateSecureSessionValidator except that it does not tranfer to the
* login page when it detects a null user (or a user not logged in).
*
* <p>The Template Service requires a different Session Validator
* because of the way it handles screens.
*
- * @see TemplateSecureValidator
+ * @see TemplateSecureSessionValidator
* @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
* @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
- * @version $Id: TemplateSessionValidator.java,v 1.6 2001/06/19 01:41:16 jon Exp $
+ * @version $Id: TemplateSessionValidator.java,v 1.7 2001/06/19 21:51:54 mpoeschl Exp $
*/
public class TemplateSessionValidator extends SessionValidator
{
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org