weaver 2003/08/06 07:00:37
Modified: portal/src/java/org/apache/jetspeed/services/persistence
PersistenceService.java
Log:
Additional documentation added.
Revision Changes Path
1.2 +19 -3
jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/services/persistence/PersistenceService.java
Index: PersistenceService.java
===================================================================
RCS file:
/home/cvs/jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/services/persistence/PersistenceService.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PersistenceService.java 1 Aug 2003 20:10:59 -0000 1.1
+++ PersistenceService.java 6 Aug 2003 14:00:37 -0000 1.2
@@ -56,11 +56,21 @@
import org.apache.fulcrum.Service;
/**
- *
+ * <p>
* PersistenceService
- *
+ * </p>
+ * <p>
* Generic persistence service that uses a plug in architecture to support
* persistence operations. It serves as a common gateway to retreive
+ * and create <code>PersistencePlugins</code>.
+ * </p>
+ * <p>
+ * Plugin configurations are kept in a single xml file,
<code>persistence-plugins.xml</code>
+ * which, for standard Jetspeed deployments, is located in
${JETSPEED_HOME}/WEB-INF/conf.
+ * This value can be changed by changing the
<code>services.PersistenceService.plugin.file</code>
+ * property in ${JETSPEED_HOME}/WEB-INF/conf/jetspeed.properties.
+ * </p>
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Scott T. Weaver</a>
* @version $Id$
*
@@ -95,6 +105,12 @@
*/
PersistencePlugin getPlugin(String name);
+ /**
+ * Creates a plugin based using the confirugration provided.
+ * @param conf PluginConfiguration that will be used to create this plugin
+ * @return PersistencePlugin crated using the provided <code>conf</code>
+ * @throws PluginInitializationException if there is a problem creating the
plugin
+ */
PersistencePlugin createPlugin(PluginConfiguration conf) throws
PluginInitializationException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
