svn commit: r465204 - in /incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store: DefaultPersistenceAdapterFactory.java jdbc/JDBCPersistenceAdapter.java

[js...@apache.org]

Author: jstrachan
Date: Wed Oct 18 03:52:34 2006
New Revision: 465204

URL: http://svn.apache.org/viewvc?view=rev&rev=465204
Log:
added better javadoc comments to add better descriptions on the XSD reference

Modified:
    incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java
    incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java

Modified: incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java?view=diff&rev=465204&r1=465203&r2=465204
==============================================================================
--- incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java (original)
+++ incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java Wed Oct 18 03:52:34 2006
@@ -75,6 +75,9 @@
         return journalLogFiles;
     }
 
+    /**
+     * Sets the number of journal log files to use
+     */
     public void setJournalLogFiles(int journalLogFiles) {
         this.journalLogFiles = journalLogFiles;
     }
@@ -84,6 +87,8 @@
     }
 
     /**
+     * Sets the size of the journal log files
+     *
      * @org.apache.xbean.Property propertyEditor="org.apache.activemq.util.MemoryIntPropertyEditor"
      */
     public void setJournalLogFileSize(int journalLogFileSize) {
@@ -102,6 +107,11 @@
         return useJournal;
     }
 
+    /**
+     * Enables or disables the use of the journal. The default is to use the journal
+     *
+     * @param useJournal
+     */
     public void setUseJournal(boolean useJournal) {
         this.useJournal = useJournal;
     }
@@ -144,6 +154,11 @@
         return useQuickJournal;
     }
 
+    /**
+     * Enables or disables the use of quick journal, which keeps messages in the journal and just
+     * stores a reference to the messages in JDBC. Defaults to false so that messages actually reside
+     * long term in the JDBC database.
+     */
     public void setUseQuickJournal(boolean useQuickJournal) {
         this.useQuickJournal = useQuickJournal;
     }
@@ -167,6 +182,9 @@
         return jdbcPersistenceAdapter.isUseDatabaseLock();
     }
 
+    /**
+     * Sets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
+     */
     public void setUseDatabaseLock(boolean useDatabaseLock) {
         jdbcPersistenceAdapter.setUseDatabaseLock(useDatabaseLock);
     }
@@ -175,6 +193,9 @@
         return jdbcPersistenceAdapter.isCreateTablesOnStartup();
     }
 
+    /**
+     * Sets whether or not tables are created on startup
+     */
     public void setCreateTablesOnStartup(boolean createTablesOnStartup) {
         jdbcPersistenceAdapter.setCreateTablesOnStartup(createTablesOnStartup);
     }
@@ -183,6 +204,9 @@
         return journalThreadPriority;
     }
 
+    /**
+     * Sets the thread priority of the journal thread
+     */
     public void setJournalThreadPriority(int journalThreadPriority){
         this.journalThreadPriority=journalThreadPriority;
     }

Modified: incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java?view=diff&rev=465204&r1=465203&r2=465204
==============================================================================
--- incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java (original)
+++ incubator/activemq/trunk/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java Wed Oct 18 03:52:34 2006
@@ -372,6 +372,9 @@
         return cleanupPeriod;
     }
 
+    /**
+     * Sets the number of milliseconds until the database is attempted to be cleaned up for durable topics
+     */
     public void setCleanupPeriod(int cleanupPeriod) {
         this.cleanupPeriod = cleanupPeriod;
     }
@@ -402,6 +405,9 @@
         return createTablesOnStartup;
     }
 
+    /**
+     * Sets whether or not tables are created on startup
+     */
     public void setCreateTablesOnStartup(boolean createTablesOnStartup) {
         this.createTablesOnStartup = createTablesOnStartup;
     }
@@ -410,6 +416,9 @@
         return useDatabaseLock;
     }
 
+    /**
+     * Sets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
+     */
     public void setUseDatabaseLock(boolean useDatabaseLock) {
         this.useDatabaseLock = useDatabaseLock;
     }