Author: indika
Date: Thu Feb 5 06:14:24 2009
New Revision: 741021
URL: http://svn.apache.org/viewvc?rev=741021&view=rev
Log:
add docs
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceFinder.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepository.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryHelper.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryListener.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationFactory.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationListFactory.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationRepositoryFactory.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationListSerializer.java
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationSerializer.java
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceFinder.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceFinder.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceFinder.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceFinder.java
Thu Feb 5 06:14:24 2009
@@ -32,7 +32,7 @@
*
*/
public class DataSourceFinder {
-
+
private static Log log = LogFactory.getLog(DataSourceFinder.class);
/**
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepository.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepository.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepository.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepository.java
Thu Feb 5 06:14:24 2009
@@ -28,7 +28,7 @@
import java.util.Properties;
/**
- *
+ * Keep and maintain DataSourceInformations
*/
public class DataSourceInformationRepository {
@@ -39,12 +39,22 @@
private DataSourceInformationRepositoryListener listener;
+ /**
+ * Configuring DataSourceInformationRepository
+ *
+ * @param congurationProperties properties to be used for configure
+ */
public void setConfigurationProperties(Properties congurationProperties) {
if (listener != null) {
listener.reConfigure(congurationProperties);
}
}
+ /**
+ * Adding a DataSourceInformation instance
+ *
+ * @param dataSourceInformation DataSourceInformation instance
+ */
public void addDataSourceInformation(DataSourceInformation
dataSourceInformation) {
assertNull(dataSourceInformation, "DataSource information is null");
@@ -55,6 +65,12 @@
}
}
+ /**
+ * Get a existing a DataSourceInformation instance by name
+ *
+ * @param name Name of the DataSourceInformation to be returned
+ * @return DataSourceInformation instance if the are any with given name,
otherwise , returns null
+ */
public DataSourceInformation getDataSourceInformation(String name) {
assertNull(name, "Name of the datasource information instance to be
returned is null");
@@ -62,6 +78,12 @@
return dataSourceInformationMap.get(name);
}
+ /**
+ * Removing a DataSourceInformation instance by name
+ *
+ * @param name Name of the DataSourceInformation to be removed
+ * @return removed DataSourceInformation instance
+ */
public DataSourceInformation removeDataSourceInformation(String name) {
assertNull(name, "Name of the datasource information instance to be
removed is null");
@@ -76,11 +98,21 @@
return information;
}
+ /**
+ * Returns all DataSourceInformations in the repository
+ *
+ * @return List of DataSourceInformations
+ */
public Iterator<DataSourceInformation> getAllDataSourceInformation() {
return dataSourceInformationMap.values().iterator();
}
+ /**
+ * Sets a DataSourceInformationRepositoryListener
+ *
+ * @param listener DataSourceInformationRepositoryListener instance
+ */
public void setRepositoryListener(DataSourceInformationRepositoryListener
listener) {
assertNull(listener, "Provided
'DataSourceInformationRepositoryListener' instance is null");
@@ -92,10 +124,18 @@
this.listener = listener;
}
+ /**
+ * Remove existing DataSourceInformationRepositoryListener
+ */
public void removeRepositoryListener() {
this.listener = null;
}
+ /**
+ * Gets existing DataSourceInformationRepositoryListener
+ *
+ * @return DataSourceInformationRepositoryListener that have been
registered
+ */
public DataSourceInformationRepositoryListener getRepositoryListener() {
return this.listener;
}
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryHelper.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryHelper.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryHelper.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryHelper.java
Thu Feb 5 06:14:24 2009
@@ -29,12 +29,18 @@
import java.util.Properties;
/**
- *
+ * Some help functions related with DataSourceInformationRepository
*/
public class DataSourceInformationRepositoryHelper {
private static final Log log =
LogFactory.getLog(DataSourceInformationRepositoryHelper.class);
+ /**
+ * Initialize and register DataSourceInformationRepository with
AxisConfiguration
+ *
+ * @param axisConfiguration AxisConfiguration instance
+ * @param properties DataSources configuration properties
+ */
public static void
initializeDataSourceInformationRepository(AxisConfiguration axisConfiguration,
Properties
properties) {
@@ -46,6 +52,9 @@
}
if (listener == null) {
+ if (log.isDebugEnabled()) {
+ log.debug("Creating a new
DataSourceInformationRepositoryListener instance ");
+ }
listener = DataSourceRepositoryManager.getInstance();
}
@@ -55,10 +64,20 @@
}
if (repository == null) {
+ if (log.isDebugEnabled()) {
+ log.debug("Initiating a new DataSourceInformationRepository");
+ }
initializeDataSourceInformationRepository(axisConfiguration,
properties, listener);
}
}
+ /**
+ * Initialize and register DataSourceInformationRepository with
AxisConfiguration
+ *
+ * @param axisConfiguration AxisConfiguration instance
+ * @param properties DataSources configuration properties
+ * @param listener DataSourceInformationRepositoryListener
instance
+ */
public static void
initializeDataSourceInformationRepository(AxisConfiguration axisConfiguration,
Properties
properties,
DataSourceInformationRepositoryListener listener) {
@@ -75,6 +94,12 @@
}
}
+ /**
+ * Gets DataSourceInformationRepository that is kept in AxisConfiguration
+ *
+ * @param axisConfiguration AxisConfiguration instance
+ * @return DataSourceInformationRepository instance if there any ,
otherwise null
+ */
public static DataSourceInformationRepository
getDataSourceInformationRepository(
AxisConfiguration axisConfiguration) {
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryListener.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryListener.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryListener.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/DataSourceInformationRepositoryListener.java
Thu Feb 5 06:14:24 2009
@@ -21,13 +21,28 @@
import java.util.Properties;
/**
- *
+ * listen and handle events relating to changes in
DataSourceInformationRepository
*/
public interface DataSourceInformationRepositoryListener {
+ /**
+ * Event when adding a DataSourceInformation
+ *
+ * @param dataSourceInformation Added DataSourceInformation instance
+ */
void addDataSourceInformation(DataSourceInformation dataSourceInformation);
+ /**
+ * Event when removing a DataSourceInformation instance
+ *
+ * @param dataSourceInformation removed DataSourceInformation instance
+ */
void removeDataSourceInformation(DataSourceInformation
dataSourceInformation);
+ /**
+ * Event when re-configuring the DataSourceInformationRepository
+ *
+ * @param confProperties properties used to configure
DataSourceInformationRepository
+ */
void reConfigure(Properties confProperties);
}
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationFactory.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationFactory.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationFactory.java
Thu Feb 5 06:14:24 2009
@@ -72,7 +72,7 @@
handleException(prefix +
DataSourceConfigurationConstants.PROP_DRIVER_CLS_NAME + " cannot be found.");
}
- String url = MiscellaneousUtil.getProperty(properties,
+ String url = MiscellaneousUtil.getProperty(properties,
prefix + DataSourceConfigurationConstants.PROP_URL, null);
if (url == null) {
handleException(prefix + DataSourceConfigurationConstants.PROP_URL
+ " cannot be found.");
@@ -249,7 +249,7 @@
information.addProperty(prefix +
DataSourceConfigurationConstants.PROP_PROVIDER_PORT,
MiscellaneousUtil.getProperty(
properties, prefix +
DataSourceConfigurationConstants.PROP_PROVIDER_PORT, null));
-
+
return information;
}
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationListFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationListFactory.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationListFactory.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationListFactory.java
Thu Feb 5 06:14:24 2009
@@ -29,12 +29,18 @@
import java.util.Properties;
/**
- *
+ * Contains Factory method that use to create List of DataSourceInformations -
a DataSourceInformation Collection
*/
public class DataSourceInformationListFactory {
private static final Log log =
LogFactory.getLog(DataSourceInformationListFactory.class);
+ /**
+ * Factory method for creating a a DataSourceInformation Collection
+ *
+ * @param dsProperties Datasource configuration properties
+ * @return A List of DataSourceInformations
+ */
public static List<DataSourceInformation>
createDataSourceInformationList(Properties dsProperties) {
final List<DataSourceInformation> dataSourceInformations = new
ArrayList<DataSourceInformation>();
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationRepositoryFactory.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationRepositoryFactory.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationRepositoryFactory.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/factory/DataSourceInformationRepositoryFactory.java
Thu Feb 5 06:14:24 2009
@@ -27,15 +27,29 @@
import java.util.Properties;
/**
- *
+ * Contains Factory methods that use to create DataSourceInformationRepository
*/
public class DataSourceInformationRepositoryFactory {
+ /**
+ * Factory method to create a DataSourceInformationRepository
+ * Use 'DataSourceRepositoryManager' as RepositoryListener
+ *
+ * @param properties DataSource properties
+ * @return DataSourceInformationRepository instance
+ */
public static DataSourceInformationRepository
createDataSourceInformationRepository(Properties properties) {
return createDataSourceInformationRepository(properties,
DataSourceRepositoryManager.getInstance());
}
+ /**
+ * Factory method to create a DataSourceInformationRepository
+ *
+ * @param properties DataSource properties
+ * @param listener DataSourceInformationRepositoryListener
+ * @return DataSourceInformationRepository instance
+ */
public static DataSourceInformationRepository
createDataSourceInformationRepository(
Properties properties, DataSourceInformationRepositoryListener
listener) {
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationListSerializer.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationListSerializer.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationListSerializer.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationListSerializer.java
Thu Feb 5 06:14:24 2009
@@ -25,10 +25,16 @@
import java.util.Properties;
/**
- *
+ * Serializes a list of DataSourceInformation into a properties
*/
public class DataSourceInformationListSerializer {
+ /**
+ * Serializes a list of DataSourceInformation into a properties
+ *
+ * @param dataSourceInformationList A list of DataSourceInformation
+ * @return DataSource configuration properties
+ */
public static Properties serialize(List<DataSourceInformation>
dataSourceInformationList) {
final Properties properties = new Properties();
StringBuffer dataSources = new StringBuffer();
Modified:
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationSerializer.java
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationSerializer.java?rev=741021&r1=741020&r2=741021&view=diff
==============================================================================
---
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationSerializer.java
(original)
+++
synapse/trunk/java/modules/utils/src/main/java/org/apache/synapse/commons/util/datasource/serializer/DataSourceInformationSerializer.java
Thu Feb 5 06:14:24 2009
@@ -24,10 +24,16 @@
import java.util.Properties;
/**
- *
+ * Serialize a DataSourceInformation to a Properties
*/
public class DataSourceInformationSerializer {
+ /**
+ * Serialize a DataSourceInformation to a Properties
+ *
+ * @param information DataSourceInformation instance
+ * @return DataSource configuration properties
+ */
public static Properties serialize(DataSourceInformation information) {
final Properties properties = new Properties();
