/**
* Copyright 2010 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package bitronix.tm;
import bitronix.tm.utils.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.util.Properties;
/**
* Configuration repository of the transaction manager. You can set configurable values either via the properties file
* or by setting properties of the {@link Configuration} object.
* Once the transaction manager has started it is not possible to change the configuration: all calls to setters will
* throw a {@link IllegalStateException}.
* <p>The configuration filename must be specified with the <code>bitronix.tm.configuration</code> system property.</p>
* <p>The default settings are good enough for running in a test environment but certainly not for production usage.
* Also, all properties are reset to their default value after the transaction manager has shut down.</p>
* <p>All those properties can refer to other defined ones or to system properties using the Ant notation:
* <code>${some.property.name}</code>.</p>
* <p>© <a href="http://www.bitronix.be">Bitronix Software</a></p>
*
* @author lorban
*/
public class Configuration implements Service {
private final static Logger log = LoggerFactory.getLogger(Configuration.class);
private final static int MAX_SERVER_ID_LENGTH = 51;
private String serverId;
private byte[] serverIdArray;
private String logPart1Filename;
private String logPart2Filename;
private boolean forcedWriteEnabled;
private boolean forceBatchingEnabled;
private int maxLogSizeInMb;
private boolean filterLogStatus;
private boolean skipCorruptedLogs;
private boolean asynchronous2Pc;
private boolean warnAboutZeroResourceTransaction;
private int defaultTransactionTimeout;
private int gracefulShutdownInterval;
private int backgroundRecoveryIntervalSeconds;
private boolean disableJmx;
private String jndiUserTransactionName;
private String journal;
private boolean currentNodeOnlyRecovery;
private String resourceConfigurationFilename;
protected Configuration() {
try {
InputStream in = null;
Properties properties;
try {
String configurationFilename = System.getProperty("bitronix.tm.configuration");
if (configurationFilename != null) {
if (log.isDebugEnabled()) log.debug("loading configuration file " + configurationFilename);
in = new FileInputStream(configurationFilename);
} else {
if (log.isDebugEnabled()) log.debug("loading default configuration");
in = ClassLoaderUtils.getResourceAsStream("bitronix-default-config.properties");
}
properties = new Properties();
if (in != null)
properties.load(in);
else
if (log.isDebugEnabled()) log.debug("no configuration file found, using default settings");
} finally {
if (in != null) in.close();
}
serverId = getString(properties, "bitronix.tm.serverId", null);
logPart1Filename = getString(properties, "bitronix.tm.journal.disk.logPart1Filename", "btm1.tlog");
logPart2Filename = getString(properties, "bitronix.tm.journal.disk.logPart2Filename", "btm2.tlog");
forcedWriteEnabled = getBoolean(properties, "bitronix.tm.journal.disk.forcedWriteEnabled", true);
forceBatchingEnabled = getBoolean(properties, "bitronix.tm.journal.disk.forceBatchingEnabled", true);
maxLogSizeInMb = getInt(properties, "bitronix.tm.journal.disk.maxLogSize", 2);
filterLogStatus = getBoolean(properties, "bitronix.tm.journal.disk.filterLogStatus", false);
skipCorruptedLogs = getBoolean(properties, "bitronix.tm.journal.disk.skipCorruptedLogs", false);
asynchronous2Pc = getBoolean(properties, "bitronix.tm.2pc.async", false);
warnAboutZeroResourceTransaction = getBoolean(properties, "bitronix.tm.2pc.warnAboutZeroResourceTransactions", true);
defaultTransactionTimeout = getInt(properties, "bitronix.tm.timer.defaultTransactionTimeout", 60);
gracefulShutdownInterval = getInt(properties, "bitronix.tm.timer.gracefulShutdownInterval", 60);
backgroundRecoveryIntervalSeconds = getInt(properties, "bitronix.tm.timer.backgroundRecoveryIntervalSeconds", 60);
disableJmx = getBoolean(properties, "bitronix.tm.disableJmx", false);
jndiUserTransactionName = getString(properties, "bitronix.tm.jndi.userTransactionName", null);
journal = getString(properties, "bitronix.tm.journal", "disk");
currentNodeOnlyRecovery = getBoolean(properties, "bitronix.tm.currentNodeOnlyRecovery", true);
resourceConfigurationFilename = getString(properties, "bitronix.tm.resource.configuration", null);
} catch (IOException ex) {
throw new InitializationException("error loading configuration", ex);
}
}
/**
* ASCII ID that must uniquely identify this TM instance. It must not exceed 51 characters or it will be truncated.
* <p>Property name:<br/><b>bitronix.tm.serverId -</b> <i>(defaults to server's IP address but that's unsafe for
* production use)</i></p>
* @return the unique ID of this TM instance.
*/
public String getServerId() {
return serverId;
}
/**
* Set the ASCII ID that must uniquely identify this TM instance. It must not exceed 51 characters or it will be
* truncated.
* @see #getServerId()
* @param serverId the unique ID of this TM instance.
*/
public void setServerId(String serverId) {
checkNotStarted();
this.serverId = serverId;
}
/**
* Get the journal fragment file 1 name.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.logPart1Filename -</b> <i>(defaults to btm1.tlog)</i></p>
* @return the journal fragment file 1 name.
*/
public String getLogPart1Filename() {
return logPart1Filename;
}
/**
* Set the journal fragment file 1 name.
* @see #getLogPart1Filename()
* @param logPart1Filename the journal fragment file 1 name.
*/
public void setLogPart1Filename(String logPart1Filename) {
checkNotStarted();
this.logPart1Filename = logPart1Filename;
}
/**
* Get the journal fragment file 2 name.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.logPart2Filename -</b> <i>(defaults to btm2.tlog)</i></p>
* @return the journal fragment file 2 name.
*/
public String getLogPart2Filename() {
return logPart2Filename;
}
/**
* Set the journal fragment file 2 name.
* @see #getLogPart2Filename()
* @param logPart2Filename the journal fragment file 2 name.
*/
public void setLogPart2Filename(String logPart2Filename) {
checkNotStarted();
this.logPart2Filename = logPart2Filename;
}
/**
* Are logs forced to disk ? Do not set to false in production since without disk force, integrity is not
* guaranteed.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.forcedWriteEnabled -</b> <i>(defaults to true)</i></p>
* @return true if logs are forced to disk, false otherwise.
*/
public boolean isForcedWriteEnabled() {
return forcedWriteEnabled;
}
/**
* Set if logs are forced to disk. Do not set to false in production since without disk force, integrity is not
* guaranteed.
* @see #isForcedWriteEnabled()
* @param forcedWriteEnabled true if logs should be forced to disk, false otherwise.
*/
public void setForcedWriteEnabled(boolean forcedWriteEnabled) {
checkNotStarted();
this.forcedWriteEnabled = forcedWriteEnabled;
}
/**
* Are disk forces batched ? Disabling batching can seriously lower the transaction manager's throughput.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.forceBatchingEnabled -</b> <i>(defaults to true)</i></p>
* @return true if disk forces are batched, false otherwise.
*/
public boolean isForceBatchingEnabled() {
return forceBatchingEnabled;
}
/**
* Set if disk forces are batched. Disabling batching can seriously lower the transaction manager's throughput.
* @see #isForceBatchingEnabled()
* @param forceBatchingEnabled true if disk forces are batched, false otherwise.
*/
public void setForceBatchingEnabled(boolean forceBatchingEnabled) {
checkNotStarted();
this.forceBatchingEnabled = forceBatchingEnabled;
}
/**
* Maximum size in megabytes of the journal fragments. Larger logs allow transactions to stay longer in-doubt but
* the TM pauses longer when a fragment is full.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.maxLogSize -</b> <i>(defaults to 2)</i></p>
* @return the maximum size in megabytes of the journal fragments.
*/
public int getMaxLogSizeInMb() {
return maxLogSizeInMb;
}
/**
* Set the Maximum size in megabytes of the journal fragments. Larger logs allow transactions to stay longer
* in-doubt but the TM pauses longer when a fragment is full.
* @see #getMaxLogSizeInMb()
* @param maxLogSizeInMb the maximum size in megabytes of the journal fragments.
*/
public void setMaxLogSizeInMb(int maxLogSizeInMb) {
checkNotStarted();
this.maxLogSizeInMb = maxLogSizeInMb;
}
/**
* Should only mandatory logs be written ? Enabling this parameter lowers space usage of the fragments but makes
* debugging more complex.
* <p>Property name:<br/><b>bitronix.tm.journal.disk.filterLogStatus -</b> <i>(defaults to false)</i></p>
* @return true if only mandatory logs should be written.
*/
public boolean isFilterLogStatus() {
return filterLogStatus;
}
/**
* Set if only mandatory logs should be written. Enabling this parameter lowers space usage of the fragments but
* makes debugging more complex.
* @see #isFilterLogStatus()
* @param filterLogStatus true if only mandatory logs should be written.
*/
public void setFilterLogStatus(boolean filterLogStatus) {
checkNotStarted();
this.filterLogStatus = filterLogStatus;
}
/**
* Should corrupted logs be skipped ?
* <p>Property name:<br/><b>bitronix.tm.journal.disk.skipCorruptedLogs -</b> <i>(defaults to false)</i></p>
* @return true if corrupted logs should be skipped.
*/
public boolean isSkipCorruptedLogs() {
return skipCorruptedLogs;
}
/**
* Set if corrupted logs should be skipped.
* @see #isSkipCorruptedLogs()
* @param skipCorruptedLogs true if corrupted logs should be skipped.
*/
public void setSkipCorruptedLogs(boolean skipCorruptedLogs) {
this.skipCorruptedLogs = skipCorruptedLogs;
}
/**
* Should two phase commit be executed asynchronously ? Asynchronous two phase commit can improve performance when
* there are many resources enlisted in transactions but is more CPU intensive due to the dynamic thread spawning
* requirements. It also makes debugging more complex.
* <p>Property name:<br/><b>bitronix.tm.2pc.async -</b> <i>(defaults to false)</i></p>
* @return true if two phase commit should be executed asynchronously.
*/
public boolean isAsynchronous2Pc() {
return asynchronous2Pc;
}
/**
* Set if two phase commit should be executed asynchronously. Asynchronous two phase commit can improve performance
* when there are many resources enlisted in transactions but is more CPU intensive due to the dynamic thread
* spawning requirements. It also makes debugging more complex.
* @see #isAsynchronous2Pc()
* @param asynchronous2Pc true if two phase commit should be executed asynchronously.
*/
public void setAsynchronous2Pc(boolean asynchronous2Pc) {
checkNotStarted();
this.asynchronous2Pc = asynchronous2Pc;
}
/**
* Should transactions executed without a single enlisted resource result in a warning or not ? Most of the time
* transactions executed with no enlisted resource reflect a bug or a mis-configuration somewhere.
* <p>Property name:<br/><b>bitronix.tm.2pc.warnAboutZeroResourceTransactions -</b> <i>(defaults to true)</i></p>
* @return true if transactions executed without a single enlisted resource should result in a warning.
*/
public boolean isWarnAboutZeroResourceTransaction() {
return warnAboutZeroResourceTransaction;
}
/**
* Set if transactions executed without a single enlisted resource should result in a warning or not. Most of the
* time transactions executed with no enlisted resource reflect a bug or a mis-configuration somewhere.
* @see #isWarnAboutZeroResourceTransaction()
* @param warnAboutZeroResourceTransaction true if transactions executed without a single enlisted resource should
* result in a warning.
*/
public void setWarnAboutZeroResourceTransaction(boolean warnAboutZeroResourceTransaction) {
checkNotStarted();
this.warnAboutZeroResourceTransaction = warnAboutZeroResourceTransaction;
}
/**
* Default transaction timeout in seconds.
* <p>Property name:<br/><b>bitronix.tm.timer.defaultTransactionTimeout -</b> <i>(defaults to 60)</i></p>
* @return the default transaction timeout in seconds.
*/
public int getDefaultTransactionTimeout() {
return defaultTransactionTimeout;
}
/**
* Set the default transaction timeout in seconds.
* @see #getDefaultTransactionTimeout()
* @param defaultTransactionTimeout the default transaction timeout in seconds.
*/
public void setDefaultTransactionTimeout(int defaultTransactionTimeout) {
checkNotStarted();
this.defaultTransactionTimeout = defaultTransactionTimeout;
}
/**
* Maximum amount of seconds the TM will wait for transactions to get done before aborting them at shutdown time.
* <p>Property name:<br/><b>bitronix.tm.timer.gracefulShutdownInterval -</b> <i>(defaults to 60)</i></p>
* @return the maximum amount of time in seconds.
*/
public int getGracefulShutdownInterval() {
return gracefulShutdownInterval;
}
/**
* Set the maximum amount of seconds the TM will wait for transactions to get done before aborting them at shutdown
* time.
* @see #getGracefulShutdownInterval()
* @param gracefulShutdownInterval the maximum amount of time in seconds.
*/
public void setGracefulShutdownInterval(int gracefulShutdownInterval) {
checkNotStarted();
this.gracefulShutdownInterval = gracefulShutdownInterval;
}
/**
* Interval in minutes at which to run the recovery process in the background. Disabled when set to 0.
* <p>Property name:<br/><b>bitronix.tm.timer.backgroundRecoveryInterval -</b> <i>(defaults to 0)</i></p>
* @return the interval in minutes.
* @deprecated superceded by #getBackgroundRecoveryIntervalSeconds().
*/
public int getBackgroundRecoveryInterval() {
return getBackgroundRecoveryIntervalSeconds() / 60;
}
/**
* Set the interval in minutes at which to run the recovery process in the background. Disabled when set to 0.
* @see #getBackgroundRecoveryInterval()
* @param backgroundRecoveryInterval the interval in minutes.
* @deprecated superceded by #setBackgroundRecoveryIntervalSeconds(int).
*/
public void setBackgroundRecoveryInterval(int backgroundRecoveryInterval) {
log.warn("setBackgroundRecoveryInterval() is deprecated, consider using setBackgroundRecoveryIntervalSeconds() instead.");
setBackgroundRecoveryIntervalSeconds(backgroundRecoveryInterval * 60);
}
/**
* Interval in seconds at which to run the recovery process in the background. Disabled when set to 0.
* <p>Property name:<br/><b>bitronix.tm.timer.backgroundRecoveryIntervalSeconds -</b> <i>(defaults to 60)</i></p>
* @return the interval in seconds.
*/
public int getBackgroundRecoveryIntervalSeconds() {
return backgroundRecoveryIntervalSeconds;
}
/**
* Set the interval in seconds at which to run the recovery process in the background. Disabled when set to 0.
* @see #getBackgroundRecoveryIntervalSeconds()
* @param backgroundRecoveryIntervalSeconds the interval in minutes.
*/
public void setBackgroundRecoveryIntervalSeconds(int backgroundRecoveryIntervalSeconds) {
checkNotStarted();
this.backgroundRecoveryIntervalSeconds = backgroundRecoveryIntervalSeconds;
}
/**
* Should JMX Mbeans not be registered even if a JMX MBean server is detected ?
* <p>Property name:<br/><b>bitronix.tm.disableJmx -</b> <i>(defaults to false)</i></p>
* @return true if JMX MBeans should never be registered.
*/
public boolean isDisableJmx() {
return disableJmx;
}
/**
* Set to true if JMX Mbeans should not be registered even if a JMX MBean server is detected.
* @see #isDisableJmx()
* @param disableJmx true if JMX MBeans should never be registered.
*/
public void setDisableJmx(boolean disableJmx) {
this.disableJmx = disableJmx;
}
/**
* Get the name the {@link javax.transaction.UserTransaction} should be bound under in the
* {@link bitronix.tm.jndi.BitronixContext}.
* @return the name the {@link javax.transaction.UserTransaction} should
* be bound under in the {@link bitronix.tm.jndi.BitronixContext}.
*/
public String getJndiUserTransactionName() {
return jndiUserTransactionName;
}
/**
* Set the name the {@link javax.transaction.UserTransaction} should be bound under in the
* {@link bitronix.tm.jndi.BitronixContext}.
* @see #getJndiUserTransactionName()
* @param jndiUserTransactionName the name the {@link javax.transaction.UserTransaction} should
* be bound under in the {@link bitronix.tm.jndi.BitronixContext}.
*/
public void setJndiUserTransactionName(String jndiUserTransactionName) {
checkNotStarted();
this.jndiUserTransactionName = jndiUserTransactionName;
}
/**
* Get the journal implementation. Can be <code>disk</code>, <code>null</code> or a class name.
* @return the journal name.
*/
public String getJournal() {
return journal;
}
/**
* Set the journal name. Can be <code>disk</code>, <code>null</code> or a class name.
* @see #getJournal()
* @param journal the journal name.
*/
public void setJournal(String journal) {
this.journal = journal;
}
/**
* Should the recovery process <b>not</b> recover XIDs generated with another JVM unique ID ? Setting this property to true
* is useful in clustered environments where multiple instances of BTM are running on different nodes.
* @see #getServerId() contains the value used as the JVM unique ID.
* @return true if recovery should filter out recovered XIDs that do not contain this JVM's unique ID, false otherwise.
*/
public boolean isCurrentNodeOnlyRecovery() {
return currentNodeOnlyRecovery;
}
/**
* Set to true if recovery should filter out recovered XIDs that do not contain this JVM's unique ID, false otherwise.
* @see #isCurrentNodeOnlyRecovery()
* @param currentNodeOnlyRecovery true if recovery should filter out recovered XIDs that do not contain this JVM's unique ID, false otherwise.
*/
public void setCurrentNodeOnlyRecovery(boolean currentNodeOnlyRecovery) {
this.currentNodeOnlyRecovery = currentNodeOnlyRecovery;
}
/**
* {@link bitronix.tm.resource.ResourceLoader} configuration file name. {@link bitronix.tm.resource.ResourceLoader}
* will be disabled if this value is null.
* <p>Property name:<br/><b>bitronix.tm.resource.configuration -</b> <i>(defaults to null)</i></p>
* @return the filename of the resources configuration file or null if not configured.
*/
public String getResourceConfigurationFilename() {
return resourceConfigurationFilename;
}
/**
* Set the {@link bitronix.tm.resource.ResourceLoader} configuration file name.
* @see #getResourceConfigurationFilename()
* @param resourceConfigurationFilename the filename of the resources configuration file or null you do not want to
* use the {@link bitronix.tm.resource.ResourceLoader}.
*/
public void setResourceConfigurationFilename(String resourceConfigurationFilename) {
checkNotStarted();
this.resourceConfigurationFilename = resourceConfigurationFilename;
}
/**
* Build the server ID byte array that will be prepended in generated UIDs. Once built, the value is cached for
* the duration of the JVM lifespan.
* @return the server ID.
*/
public byte[] buildServerIdArray() {
if (serverIdArray == null) {
try {
serverIdArray = serverId.substring(0, Math.min(serverId.length(), MAX_SERVER_ID_LENGTH)).getBytes("US-ASCII");
} catch (Exception ex) {
log.warn("cannot get this JVM unique ID. Make sure it is configured and you only use ASCII characters. Will use IP address instead (unsafe for production usage!).");
try {
serverIdArray = InetAddress.getLocalHost().getHostAddress().getBytes("US-ASCII");
} catch (Exception ex2) {
final String unknownServerId = "unknown-server-id";
log.warn("cannot get the local IP address. Will replace it with '" + unknownServerId + "' constant (highly unsafe!).");
serverIdArray = unknownServerId.getBytes();
}
}
if (serverIdArray.length > MAX_SERVER_ID_LENGTH) {
byte[] truncatedServerId = new byte[MAX_SERVER_ID_LENGTH];
System.arraycopy(serverIdArray, 0, truncatedServerId, 0, MAX_SERVER_ID_LENGTH);
serverIdArray = truncatedServerId;
}
String serverIdArrayAsString = new String(serverIdArray);
if (serverId == null)
serverId = serverIdArrayAsString;
log.info("JVM unique ID: <" + serverIdArrayAsString + ">");
}
return serverIdArray;
}
public void shutdown() {
}
public String toString() {
StringBuffer sb = new StringBuffer(512);
sb.append("a Configuration with [");
try {
sb.append(PropertyUtils.propertiesToString(this));
} catch (PropertyException ex) {
sb.append("???");
if (log.isDebugEnabled()) log.debug("error accessing properties of Configuration object", ex);
}
sb.append("]");
return sb.toString();
}
/*
* Internal implementation
*/
private void checkNotStarted() {
if (TransactionManagerServices.isTransactionManagerRunning())
throw new IllegalStateException("cannot change the configuration while the transaction manager is running");
}
static String getString(Properties properties, String key, String defaultValue) {
String value = System.getProperty(key);
if (value == null) {
value = properties.getProperty(key);
if (value == null)
return defaultValue;
}
return evaluate(properties, value);
}
static boolean getBoolean(Properties properties, String key, boolean defaultValue) {
return Boolean.valueOf(getString(properties, key, "" + defaultValue)).booleanValue();
}
static int getInt(Properties properties, String key, int defaultValue) {
return Integer.parseInt(getString(properties, key, "" + defaultValue));
}
private static String evaluate(Properties properties, String value) {
String result = value;
int startIndex = value.indexOf('$');
if (startIndex > -1 && value.charAt(startIndex +1) == '{') {
int endIndex = value.indexOf('}');
if (startIndex +2 == endIndex)
throw new IllegalArgumentException("property ref cannot refer to an empty name: ${}");
if (endIndex == -1)
throw new IllegalArgumentException("unclosed property ref: ${" + value.substring(startIndex +2));
String subPropertyKey = value.substring(startIndex +2, endIndex);
String subPropertyValue = getString(properties, subPropertyKey, null);
result = result.substring(0, startIndex) + subPropertyValue + result.substring(endIndex +1);
return evaluate(properties, result);
}
return result;
}
}