[hornetq-commits] JBoss hornetq SVN: r12206 - trunk/hornetq-core/src/main/java/org/hornetq/core/config.
do-not-reply at jboss.org
do-not-reply at jboss.org
Mon Feb 27 10:05:24 EST 2012
Author: borges
Date: 2012-02-27 10:05:24 -0500 (Mon, 27 Feb 2012)
New Revision: 12206
Modified:
trunk/hornetq-core/src/main/java/org/hornetq/core/config/Configuration.java
Log:
improve javadocs.
Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/config/Configuration.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/config/Configuration.java 2012-02-27 15:05:01 UTC (rev 12205)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/config/Configuration.java 2012-02-27 15:05:24 UTC (rev 12206)
@@ -29,20 +29,20 @@
import org.hornetq.spi.core.logging.LogDelegateFactory;
/**
- *
+ *
* A Configuration is used to configure HornetQ servers.
- *
+ *
* @author <a href="mailto:tim.fox at jboss.com">Tim Fox</a>
*
*/
public interface Configuration extends Serializable
{
// General attributes -------------------------------------------------------------------
-
-
+
+
/** To be used on dependency management on the application server */
String getName();
-
+
/** To be used on dependency management on the application server */
void setName(String name);
@@ -59,8 +59,8 @@
void setClustered(boolean clustered);
/**
- * Returns whether a backup will auto die when a live server is failing back
- * @return
+ * Returns whether a backup will auto die when a live server is failing back.
+ * @return {@code true} if the backup will stop when the live server restarts
*/
public boolean isAllowAutoFailBack();
@@ -204,7 +204,7 @@
* Sets whether this server is manageable using JMX or not.
*/
void setJMXManagementEnabled(boolean enabled);
-
+
/**
* Returns the domain used by JMX MBeans (provided JMX management is enabled).
* <br>
@@ -214,7 +214,7 @@
/**
* Sets the domain used by JMX MBeans (provided JMX management is enabled).
- *
+ *
* Changing this JMX domain is required if multiple HornetQ servers are run inside
* the same JVM and all servers are using the same MBeanServer.
*/
@@ -477,12 +477,12 @@
* Sets the file system directory used to store bindings.
*/
void setBindingsDirectory(String dir);
-
+
/** The max number of concurrent reads allowed on paging.
- *
+ *
* Default = 5 */
int getPageMaxConcurrentIO();
-
+
/** The max number of concurrent reads allowed on paging.
* Default = 5 */
void setPageMaxConcurrentIO(int maxIO);
@@ -750,7 +750,7 @@
void setWildcardRoutingEnabled(boolean enabled);
/**
- * Returns the timeout (in milliseconds) after which transactions is removed
+ * Returns the timeout (in milliseconds) after which transactions is removed
* from the resource manager after it was created.
* <br>
* Default value is {@value org.hornetq.core.config.impl.ConfigurationImpl#DEFAULT_TRANSACTION_TIMEOUT}.
@@ -758,7 +758,7 @@
long getTransactionTimeout();
/**
- * Sets the timeout (in milliseconds) after which transactions is removed
+ * Sets the timeout (in milliseconds) after which transactions is removed
* from the resource manager after it was created.
*/
void setTransactionTimeout(long timeout);
@@ -784,7 +784,7 @@
/**
* Sets the sample period to take message counter snapshot.
- *
+ *
* @param period value must be greater than 1000ms
*/
void setMessageCounterSamplePeriod(long period);
@@ -798,13 +798,13 @@
/**
* Sets the maximum number of days kept in memory for message counter.
- *
+ *
* @param maxDayHistory value must be greater than 0
*/
void setMessageCounterMaxDayHistory(int maxDayHistory);
/**
- * Returns the frequency (in milliseconds) to scan transactions to detect which transactions
+ * Returns the frequency (in milliseconds) to scan transactions to detect which transactions
* have timed out.
* <br>
* Default value is {@value org.hornetq.core.config.impl.ConfigurationImpl#DEFAULT_TRANSACTION_TIMEOUT_SCAN_PERIOD}.
@@ -812,13 +812,13 @@
long getTransactionTimeoutScanPeriod();
/**
- * Sets the frequency (in milliseconds) to scan transactions to detect which transactions
+ * Sets the frequency (in milliseconds) to scan transactions to detect which transactions
* have timed out.
*/
void setTransactionTimeoutScanPeriod(long period);
/**
- * Returns the frequency (in milliseconds) to scan messages to detect which messages
+ * Returns the frequency (in milliseconds) to scan messages to detect which messages
* have expired.
* <br>
* Default value is {@value org.hornetq.core.config.impl.ConfigurationImpl#DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD}.
@@ -826,7 +826,7 @@
long getMessageExpiryScanPeriod();
/**
- * Sets the frequency (in milliseconds) to scan messages to detect which messages
+ * Sets the frequency (in milliseconds) to scan messages to detect which messages
* have expired.
*/
void setMessageExpiryScanPeriod(long messageExpiryScanPeriod);
@@ -844,7 +844,7 @@
void setMessageExpiryThreadPriority(int messageExpiryThreadPriority);
/**
- *
+ *
* @return A list of AddressSettings per matching to be deployed to the address settings repository
*/
Map<String, AddressSettings> getAddressesSettings();
@@ -855,35 +855,35 @@
void setAddressesSettings(Map<String, AddressSettings> addressesSettings);
/**
- *
+ *
* @param roles a list of roles per matching
*/
void setSecurityRoles(Map<String, Set<Role>> roles);
/**
- *
+ *
* @return a list of roles per matching
*/
Map<String, Set<Role>> getSecurityRoles();
/**
- *
- * @param
+ *
+ * @param
*/
void setConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs);
/**
- *
- * @return
+ *
+ * @return
*/
List<ConnectorServiceConfiguration> getConnectorServiceConfigurations();
- /*
- * how long to wait before failback occurs on restart
- * */
+ /**
+ * Returns the delay to wait before fail-back occurs on restart.
+ */
long getFailbackDelay();
- /*
- * set the failback delay
- * */
+ /**
+ * Sets the fail-back delay.
+ */
void setFailbackDelay(long delay);
}
More information about the hornetq-commits
mailing list