[hornetq-commits] JBoss hornetq SVN: r11704 - trunk/hornetq-core/src/main/java/org/hornetq/core/persistence/impl/journal.

[do-not-reply at jboss.org]

Author: borges
Date: 2011-11-18 05:45:54 -0500 (Fri, 18 Nov 2011)
New Revision: 11704

Modified:
   trunk/hornetq-core/src/main/java/org/hornetq/core/persistence/impl/journal/JournalStorageManager.java
Log:
Add Javadoc documenting class' purpose

Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/persistence/impl/journal/JournalStorageManager.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/persistence/impl/journal/JournalStorageManager.java	2011-11-18 10:45:41 UTC (rev 11703)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/persistence/impl/journal/JournalStorageManager.java	2011-11-18 10:45:54 UTC (rev 11704)
@@ -108,13 +108,17 @@
 import org.hornetq.utils.XidCodecSupport;
 
 /**
- *
- * A JournalStorageManager
- *
+ * Controls access to the journals and other storage files such as the ones used to store pages and
+ * large messages. This class must control writing of any non-transient data, as it is the key point
+ * for synchronizing a replicating backup server.
+ * <p>
+ * Notice that, turning on and off replication (on the live server side) is _mostly_ a matter of
+ * using {@link ReplicatedJournal}s instead of regular {@link JournalImpl}, and sync the existing
+ * data.
+ * <p>
  * @author <a href="mailto:tim.fox at jboss.com">Tim Fox</a>
  * @author <a href="mailto:clebert.suconic at jboss.com">Clebert Suconic</a>
  * @author <a href="jmesnil at redhat.com">Jeff Mesnil</a>
- *
  */
 public class JournalStorageManager implements StorageManager
 {