Author: indika
Date: Tue Mar 2 15:00:35 2010
New Revision: 918063
URL: http://svn.apache.org/viewvc?rev=918063&view=rev
Log:
add some java doc
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolView.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolViewMBean.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationListFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationRepositoryFactory.java
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolView.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolView.java?rev=918063&r1=918062&r2=918063&view=diff
==============================================================================
---
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolView.java
(original)
+++
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolView.java
Tue Mar 2 15:00:35 2010
@@ -24,7 +24,7 @@
/**
- *
+ * Data source connection pool stats collector implementation
*/
public class DBPoolView implements DBPoolViewMBean {
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolViewMBean.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolViewMBean.java?rev=918063&r1=918062&r2=918063&view=diff
==============================================================================
---
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolViewMBean.java
(original)
+++
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/DBPoolViewMBean.java
Tue Mar 2 15:00:35 2010
@@ -21,17 +21,39 @@
import java.util.Map;
/**
- *
+ * MBean for retriving some statistics about the connection pool
*/
public interface DBPoolViewMBean {
-
+ /**
+ * Number of active connections
+ *
+ * @return <code>int</code> Number of active connections
+ */
public int getNumActive();
+ /**
+ * Number of idle connections
+ *
+ * @return <code>int</code> Number of idle connections
+ */
public int getNumIdle();
+ /**
+ * Data source name
+ *
+ * @return <code>String</code> data source name
+ */
public String getName();
+ /**
+ * Connection information as a string
+ *
+ * @return <code>String</code> representing connection information
+ */
public Map getConnectionUsage();
+ /**
+ * reset statistics
+ */
public void reset();
}
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationListFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationListFactory.java?rev=918063&r1=918062&r2=918063&view=diff
==============================================================================
---
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationListFactory.java
(original)
+++
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationListFactory.java
Tue Mar 2 15:00:35 2010
@@ -40,7 +40,7 @@
* Factory method for creating a a DataSourceInformation Collection
*
* @param dsProperties Datasource configuration properties
- * @return A List of DataSourceInformations
+ * @return A List of DataSourceInformation
*/
public static List<DataSourceInformation> createDataSourceInformationList(
Properties dsProperties) {
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationRepositoryFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationRepositoryFactory.java?rev=918063&r1=918062&r2=918063&view=diff
==============================================================================
---
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationRepositoryFactory.java
(original)
+++
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/datasource/factory/DataSourceInformationRepositoryFactory.java
Tue Mar 2 15:00:35 2010
@@ -71,7 +71,7 @@
}
/**
- * Setup an existing datasource inforamtion repository adding the provided
+ * Setup an existing datasource information repository adding the provided
* datasource information.
*
* @param datasourceInformationRepository an existing data source
information repository
