jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From edgarp...@apache.org
Subject svn commit: r414712 - /jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java
Date Fri, 16 Jun 2006 00:21:35 GMT
Author: edgarpoce
Date: Thu Jun 15 17:21:35 2006
New Revision: 414712

URL: http://svn.apache.org/viewvc?rev=414712&view=rev
Log:
add documentation

Modified:
    jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java

Modified: jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java?rev=414712&r1=414711&r2=414712&view=diff
==============================================================================
--- jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java (original)
+++ jackrabbit/trunk/jca/src/java/org/apache/jackrabbit/jca/JCARepositoryManager.java Thu
Jun 15 17:21:35 2006
@@ -62,6 +62,12 @@
 
     /**
      * Create repository.
+     *
+     * @param homeDir   The location of the repository.
+     * @param configFile The path to the repository configuration file. If the file is located
on
+     *                   the classpath, the path should be prepended with
+     *                   JCARepositoryManager.CLASSPATH_CONFIG_PREFIX.
+     *
      */
     public RepositoryImpl createRepository(String homeDir, String configFile)
             throws RepositoryException {
@@ -85,6 +91,9 @@
 
     /**
      * Return the reference.
+     * 
+     * @param homeDir   The location of the repository.
+     * @param configFile The path to the repository configuration file.
      */
     private synchronized Reference getReference(String homeDir, String configFile) {
         Reference ref = new Reference(homeDir, configFile);
@@ -116,6 +125,9 @@
 
         /**
          * Configuration file.
+         * 
+         * Configuration files located on the classpath begin with
+         * JCARepositoryManager.CLASSPATH_CONFIG_PREFIX.
          */
         private String configFile;
 
@@ -221,7 +233,10 @@
 	/**
 	 * Try to shutdown the repository only if
 	 * {@link JCARepositoryManager#autoShutdown} is true.
-	 */
+     *
+     * @param homeDir   The location of the repository.
+     * @param configFile The path to the repository configuration file.
+      */
 	public void autoShutdownRepository(String homeDir, String configFile) {
 		if (this.isAutoShutdown()) {
 		    Reference ref = getReference(homeDir, configFile);



Mime
View raw message