[jboss-svn-commits] JBL Code SVN: r29134 - labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/common.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Sep 1 06:13:37 EDT 2009
Author: jhalliday
Date: 2009-09-01 06:13:37 -0400 (Tue, 01 Sep 2009)
New Revision: 29134
Modified:
labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/common/RecoveryEnvironmentBean.java
Log:
Added EnvironmentBean javadoc. JBTM-596
Modified: labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/common/RecoveryEnvironmentBean.java
===================================================================
--- labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/common/RecoveryEnvironmentBean.java 2009-09-01 08:51:46 UTC (rev 29133)
+++ labs/jbosstm/trunk/ArjunaCore/arjuna/classes/com/arjuna/ats/arjuna/common/RecoveryEnvironmentBean.java 2009-09-01 10:13:37 UTC (rev 29134)
@@ -61,120 +61,258 @@
@FullPropertyName(name = "com.arjuna.ats.internal.arjuna.recovery.listener.timeoutsocket")
private boolean timeoutSocket = false;
- // public static final String PERIODIC_RECOVERY_PERIOD = "com.arjuna.ats.arjuna.recovery.periodicRecoveryPeriod" ;
+ /**
+ * Returns the interval between recovery scans, in seconds.
+ *
+ * Default: 120 seconds
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.periodicRecoveryPeriod
+ *
+ * @return the recovery scan period, in seconds.
+ */
public int getPeriodicRecoveryPeriod()
{
return periodicRecoveryPeriod;
}
+ /**
+ * Sets the interval between recovery scans, in seconds.
+ *
+ * @param periodicRecoveryPeriod the recovery scan period, in seconds.
+ */
public void setPeriodicRecoveryPeriod(int periodicRecoveryPeriod)
{
this.periodicRecoveryPeriod = periodicRecoveryPeriod;
}
-// public static final String RECOVERY_BACKOFF_PERIOD = "com.arjuna.ats.arjuna.recovery.recoveryBackoffPeriod" ;
+ /**
+ * Returns the interval between recovery phases within a recovery scan, in seconds.
+ *
+ * Default: 10 seconds
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.recoveryBackoffPeriod
+ *
+ * @return the interval between recovery phases, in seconds.
+ */
public int getRecoveryBackoffPeriod()
{
return recoveryBackoffPeriod;
}
+ /**
+ * Sets the interval between recovery phases, in seconds.
+ *
+ * @param recoveryBackoffPeriod the interval between recovery scan phases, in seconds.
+ */
public void setRecoveryBackoffPeriod(int recoveryBackoffPeriod)
{
this.recoveryBackoffPeriod = recoveryBackoffPeriod;
}
-// public static final String RECOVERY_MANAGER_LISTENER = "com.arjuna.ats.arjuna.recovery.recoveryListener";
+ /**
+ * Returns true if the recovery system should listen on a network socket.
+ *
+ * Default: true
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.recoveryListener
+ *
+ * @return true for network recovery, false for local JVM only use.
+ */
public boolean isRecoveryListener()
{
return recoveryListener;
}
+ /**
+ * Sets if the recovery system should listen on a network socket or not.
+ *
+ * @param recoveryListener true for network use, false for local JVM only.
+ */
public void setRecoveryListener(boolean recoveryListener)
{
this.recoveryListener = recoveryListener;
}
-// public static final String RECOVERY_MANAGER_PORT = "com.arjuna.ats.arjuna.recovery.recoveryPort";
+ /**
+ * Returns the network port number on which the recovery listener should bind.
+ *
+ * Default: 0
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.recoveryPort
+ *
+ * @return the port number for recovery listener.
+ */
public int getRecoveryPort()
{
return recoveryPort;
}
+ /**
+ * Sets the network port number on which the recovery listener should bind.
+ *
+ * @param recoveryPort the port number for the recovery listener.
+ */
public void setRecoveryPort(int recoveryPort)
{
Utility.validatePortRange(recoveryPort);
this.recoveryPort = recoveryPort;
}
-// public static final String RECOVERY_MANAGER_ADDRESS = "com.arjuna.ats.arjuna.recovery.recoveryAddress";
+ /**
+ * Returns the hostname on which the recovery listener shoud bind.
+ *
+ * Default: "localhost"
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.recoveryAddress
+ *
+ * @return the hostname on which the recovery system will listen.
+ */
public String getRecoveryAddress()
{
return recoveryAddress;
}
+ /**
+ * Sets the hostname on which the recovery listener should bind.
+ *
+ * @param recoveryAddress the hostname on which the recovery system will listen.
+ */
public void setRecoveryAddress(String recoveryAddress)
{
this.recoveryAddress = recoveryAddress;
}
+ /**
+ * Sets the InetAddress on which the recovery listener should bind.
+ * Mainly intended for use by strongly typed bean injection systems,
+ * this is a wrapper around the String form of the method.
+ *
+ * @param inetAddress the address on which to bind the recovery listener.
+ */
public void setRecoveryInetAddress(InetAddress inetAddress) {
setRecoveryAddress(inetAddress.getHostAddress());
}
-// public static final String TRANSACTION_STATUS_MANAGER_PORT = "com.arjuna.ats.arjuna.recovery.transactionStatusManagerPort";
+ /**
+ * Returns the network port number on which the transaction status manager should bind.
+ *
+ * Default: 0
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.transactionStatusManagerPort
+ *
+ * @return the port number for the transaction status manager listener.
+ */
public int getTransactionStatusManagerPort()
{
return transactionStatusManagerPort;
}
+ /**
+ * Sets the network port number on which the transaction status manager should bind.
+ *
+ * @param transactionStatusManagerPort the port number for the transaction status manager listener.
+ */
public void setTransactionStatusManagerPort(int transactionStatusManagerPort)
{
Utility.validatePortRange(transactionStatusManagerPort);
this.transactionStatusManagerPort = transactionStatusManagerPort;
}
-// public static final String TRANSACTION_STATUS_MANAGER_ADDRESS = "com.arjuna.ats.arjuna.recovery.transactionStatusManagerAddress";
+ /**
+ * Returns the hostname on which the transaction status manager should bind.
+ *
+ * Default: "localhost"
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.transactionStatusManagerAddress
+ *
+ * @return the hostname on which the transaction status manager will listen.
+ */
public String getTransactionStatusManagerAddress()
{
return transactionStatusManagerAddress;
}
+ /**
+ * Sets the hostname on which the transaction status manager should bind.
+ *
+ * @param transactionStatusManagerAddress the hostname on which the transaction status manager will listen.
+ */
public void setTransactionStatusManagerAddress(String transactionStatusManagerAddress)
{
this.transactionStatusManagerAddress = transactionStatusManagerAddress;
}
+ /**
+ * Sets the InetAddress on which the transaction status manager should bind.
+ * Mainly intended for use by strongly typed bean injection systems,
+ * this is a wrapper around the String form of the method.
+ *
+ * @param inetAddress the address on which to bind the transaction status manager.
+ */
public void setTransactionStatusManagerInetAddress(InetAddress inetAddress) {
setTransactionStatusManagerAddress(inetAddress.getHostAddress());
}
-// public static final String EXPIRY_SCAN_INTERVAL = "com.arjuna.ats.arjuna.recovery.expiryScanInterval";
+ /**
+ * Returns the interval on which the ObjectStore will be scanned for expired items, in hours.
+ *
+ * Default: 12 hours
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.expiryScanInterval
+ *
+ * @return the interval between ObjectStore expiry checks, in hours.
+ */
public int getExpiryScanInterval()
{
return expiryScanInterval;
}
+ /**
+ * Sets the interval on which the ObjectStore will be scanned for expired items, in hours.
+ *
+ * @param expiryScanInterval the interval between ObjectStore expiry checks, in hours.
+ */
public void setExpiryScanInterval(int expiryScanInterval)
{
this.expiryScanInterval = expiryScanInterval;
}
-// public static final String TRANSACTION_STATUS_MANAGER_EXPIRY_TIME = "com.arjuna.ats.arjuna.recovery.transactionStatusManagerExpiryTime";
+ /**
+ * Returns the time period after which items will be considered to have expired, in hours.
+ *
+ * Default: 12 hours
+ * Equivalent deprecated property: com.arjuna.ats.arjuna.recovery.transactionStatusManagerExpiryTime
+ *
+ * @return the expiry timeout, in hours.
+ */
public int getTransactionStatusManagerExpiryTime()
{
return transactionStatusManagerExpiryTime;
}
+ /**
+ * Sets the time period after which items will be considered to have expired, in hours.
+ *
+ * @param transactionStatusManagerExpiryTime the expiry timeout, in hours.
+ */
public void setTransactionStatusManagerExpiryTime(int transactionStatusManagerExpiryTime)
{
this.transactionStatusManagerExpiryTime = transactionStatusManagerExpiryTime;
}
+ /**
+ * Returns a list of names of classes that implement ExpiryScanner.
+ * The returned list is a copy. May return an empty list, will not return null.
+ *
+ * Default: empty list.
+ * Equivalent deprecated property prefix: com.arjuna.ats.arjuna.recovery.expiryScanner
+ *
+ * @return a list of ExpiryScanner implementation class names.
+ */
public List<String> getExpiryScanners()
{
return new ArrayList<String>(expiryScanners);
}
+ /**
+ * Sets the expiry scanners.
+ * List elements should be names of classes that implement ExpiryScanner.
+ * The provided list will be copied, not retained.
+ *
+ * @param expiryScanners a list of ExpiryScanner implementation class names.
+ */
public void setExpiryScanners(List<String> expiryScanners)
{
if(expiryScanners == null) {
@@ -184,11 +322,27 @@
}
}
+ /**
+ * Returns a list of names of classes that implement RecoveryModule.
+ * The returned list is a copy. May return an empty list, will not return null.
+ *
+ * Default: empty list.
+ * Equivalent deprecated property prefix:
+ *
+ * @return a list of RecoveryModule implementation class names.
+ */
public List<String> getRecoveryExtensions()
{
return new ArrayList<String>(recoveryExtensions);
}
+ /**
+ * Sets the recovery modules.
+ * List elements should be names of classes that implement RecoveryModule.
+ * The provided list will be copied, not retained.
+ *
+ * @param recoveryExtensions a list of RecoveryModule implementation class names.
+ */
public void setRecoveryExtensions(List<String> recoveryExtensions)
{
if(recoveryExtensions == null) {
@@ -198,11 +352,27 @@
}
}
+ /**
+ * Returns a list of names of classes that implement RecoveryActivator.
+ * The returned list is a copy. May return an empty list, will not return null.
+ *
+ * Default: empty list.
+ * Equivalent deprecated property prefix:
+ *
+ * @return a list of RecoveryActivator implementation class names.
+ */
public List<String> getRecoveryActivators()
{
return new ArrayList<String>(recoveryActivators);
}
+ /**
+ * Sets the recovery activators.
+ * List elements should be names of classes that implement RecoveryActivator.
+ * The provided list will be copied, not retained.
+ *
+ * @param recoveryActivators a list of RecoveryActivator implementation class names.
+ */
public void setRecoveryActivators(List<String> recoveryActivators)
{
if(recoveryActivators == null) {
@@ -212,11 +382,24 @@
}
}
+ /**
+ * Returns true if SO_TIMEOUT should be set on Listener socket instances.
+ *
+ * Default: false
+ * Equivalent deprecated property: com.arjuna.ats.internal.arjuna.recovery.listener.timeoutsocket
+ *
+ * @return true if SO_TIMEOUT should be used, false if not.
+ */
public boolean isTimeoutSocket()
{
return timeoutSocket;
}
+ /**
+ * Sets the socket timeout behaviour of the Listener instances.
+ *
+ * @param timeoutSocket true to enable timeouts, false to disable.
+ */
public void setTimeoutSocket(boolean timeoutSocket)
{
this.timeoutSocket = timeoutSocket;
More information about the jboss-svn-commits
mailing list