cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vgritse...@apache.org
Subject svn commit: r325970 - in /cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components: ConnectionFactoryImpl.java LoggerImpl.java
Date Mon, 17 Oct 2005 19:48:14 GMT
Author: vgritsenko
Date: Mon Oct 17 12:48:08 2005
New Revision: 325970

URL: http://svn.apache.org/viewcvs?rev=325970&view=rev
Log:
clarify contract in javadoc.

Modified:
    cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/ConnectionFactoryImpl.java
    cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/LoggerImpl.java

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/ConnectionFactoryImpl.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/ConnectionFactoryImpl.java?rev=325970&r1=325969&r2=325970&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/ConnectionFactoryImpl.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/ConnectionFactoryImpl.java
Mon Oct 17 12:48:08 2005
@@ -36,6 +36,22 @@
  * OJB ConnectionFactory implemenation to bridge into the Avalon DataSource
  * connection pooling component defined in the Cocoon configuration.
  *
+ * <p>This class has two faces to it:
+ * <dl>
+ * <dt>Avalon Component</dt>
+ * <dd>Instance of the class created and managed by Avalon container.
+ * When instance is initialized, it looks up datasource components
+ * service selector.</dd>
+ * <dt>OJB Managed Class</dt>
+ * <dd>Instances of the class are created and managed by OJB, as defined
+ * in the OJB <code>repository.xml</code> file. Each OJB managed instance
+ * of the class will have access to the datasource components service
+ * selector initialized by Avalon managed instance of the class.</dd>
+ * </dl>
+ *
+ * It is important that Avalon component is initialized before any access
+ * to OJB API is made.</p>
+ *
  * @author giacomo at apache.org
  * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
  * @version $Id$

Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/LoggerImpl.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/LoggerImpl.java?rev=325970&r1=325969&r2=325970&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/LoggerImpl.java
(original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/ojb/java/org/apache/cocoon/ojb/components/LoggerImpl.java
Mon Oct 17 12:48:08 2005
@@ -26,7 +26,23 @@
 import org.apache.ojb.broker.util.logging.LoggingConfiguration;
 
 /**
- * OJB logger implementation delegating to the Avalon logger
+ * OJB logger implementation delegating to the Avalon logger.
+ *
+ * <p>This class has two faces to it:
+ * <dl>
+ * <dt>Avalon Component</dt>
+ * <dd>Instance of the class created and managed by Avalon container.
+ * When instance is initialized, it obtains logger instance to be used
+ * by OJB.</dd>
+ * <dt>OJB Managed Class</dt>
+ * <dd>Instances of the class are created and managed by OJB, as defined
+ * in the OJB <code>OJB.properties</code> file. Each OJB managed instance
+ * of the class will have access to the logger object initialized
+ * by Avalon managed instance of the class.</dd>
+ * </dl>
+ *
+ * It is important that Avalon component is initialized before any access
+ * to OJB API is made.</p>
  *
  * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
  * @version $Id$



Mime
View raw message