org.springframework.boot.jta.atomikos

Class AtomikosProperties

java.lang.Object

org.springframework.boot.jta.atomikos.AtomikosProperties

public class AtomikosProperties
extends Object

Bean friendly variant of Atomikos configuration properties. Allows for setter based configuration and is amiable to relaxed data binding.

Since:

1.2.0

Author:

Phillip Webb

See Also:

asProperties()

Constructor Summary

Constructors

Constructor and Description
AtomikosProperties()

Method Summary

Methods

Modifier and Type	Method and Description
Properties	asProperties() Returns the properties as a Properties object that can be used with Atomikos.
void	setCheckpointInterval(long checkpointInterval) Specifies the interval between checkpoints.
void	setConsoleFileCount(int consoleFileCount) Specifies how many debug logs files can be created.
void	setConsoleFileLimit(int consoleFileLimit) Specifies how many bytes can be stored at most in debug logs files.
void	setConsoleFileName(String consoleFileName) Specifies the debug logs file name.
void	setConsoleLogLevel(AtomikosLoggingLevel consoleLogLevel) Specifies the console log level.
void	setDefaultJtaTimeout(long defaultJtaTimeout) The default timeout for JTA transactions (optional, defaults to 10000 ms).
void	setEnableLogging(boolean enableLogging) Specifies if disk logging should be enabled or not.
void	setForceShutdownOnVmExit(boolean forceShutdownOnVmExit) Specifies whether VM shutdown should trigger forced shutdown of the transaction core.
void	setLogBaseDir(String logBaseDir) Specifies the directory in which the log files should be stored.
void	setLogBaseName(String logBaseName) Specifies the transactions log file base name.
void	setMaxActives(int maxActivities) Specifies the maximum number of active transactions.
void	setMaxTimeout(long maxTimeout) Specifies the maximum timeout (in milliseconds) that can be allowed for transactions.
void	setOutputDir(String outputDir) Specifies the directory in which to store the debug log files.
void	setSerialJtaTransactions(boolean serialJtaTransactions) Specifies if subtransactions should be joined when possible.
void	setService(String service) Specifies the transaction manager implementation that should be started.
void	setThreadedTwoPhaseCommit(boolean threadedTwoPhaseCommit) Specifies whether or not to use different (and concurrent) threads for two-phase commit on the participating resources.
void	setTransactionManagerUniqueName(String uniqueName) Specifies the transaction manager's unique name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomikosProperties

public AtomikosProperties()

Method Detail

setService

public void setService(String service)

Specifies the transaction manager implementation that should be started. There is no default value and this must be set. Generally, com.atomikos.icatch.standalone.UserTransactionServiceFactory is the value you should set.

Parameters:

service - the service

setMaxTimeout

public void setMaxTimeout(long maxTimeout)

Specifies the maximum timeout (in milliseconds) that can be allowed for transactions. Defaults to 300000. This means that calls to UserTransaction.setTransactionTimeout() with a value higher than configured here will be max'ed to this value.

Parameters:

maxTimeout - the max timeout

setDefaultJtaTimeout

public void setDefaultJtaTimeout(long defaultJtaTimeout)

The default timeout for JTA transactions (optional, defaults to 10000 ms).

Parameters:

defaultJtaTimeout - the default JTA timeout

setMaxActives

public void setMaxActives(int maxActivities)

Specifies the maximum number of active transactions. Defaults to 50. A negative value means infinite amount. You will get an IllegalStateException with error message "Max number of active transactions reached" if you call UserTransaction.begin() while there are already n concurrent transactions running, n being this value.

Parameters:

maxActivities - the max activities

setEnableLogging

public void setEnableLogging(boolean enableLogging)

Specifies if disk logging should be enabled or not. Defaults to true. It is useful for JUnit testing, or to profile code without seeing the transaction manager's activity as a hot spot but this should never be disabled on production or data integrity cannot be guaranteed.

Parameters:

enableLogging - if logging is enabled

setTransactionManagerUniqueName

public void setTransactionManagerUniqueName(String uniqueName)

Specifies the transaction manager's unique name. Defaults to the machine's IP address. If you plan to run more than one transaction manager against one database you must set this property to a unique value or you might run into duplicate transaction ID (XID) problems that can be quite subtle (example: http://fogbugz.atomikos.com/default.asp?community.6.2225.7). If multiple instances need to use the same properties file then the easiest way to ensure uniqueness for this property is by referencing a system property specified at VM startup.

Parameters:

uniqueName - the unique name

setSerialJtaTransactions

public void setSerialJtaTransactions(boolean serialJtaTransactions)

Specifies if subtransactions should be joined when possible. Defaults to true. When false, no attempt to call XAResource.start(TM_JOIN) will be made for different but related subtransctions. This setting has no effect on resource access within one and the same transaction. If you don't use subtransactions then this setting can be ignored.

Parameters:

serialJtaTransactions - if serial JTA transaction are supported

setForceShutdownOnVmExit

public void setForceShutdownOnVmExit(boolean forceShutdownOnVmExit)

Specifies whether VM shutdown should trigger forced shutdown of the transaction core. Defaults to false.

Parameters:

forceShutdownOnVmExit -

setLogBaseName

public void setLogBaseName(String logBaseName)

Specifies the transactions log file base name. Defaults to tmlog. The transactions logs are stored in files using this name appended with a number and the extension .log. At checkpoint, a new transactions log file is created and the number is incremented.

Parameters:

logBaseName - the log base name

setLogBaseDir

public void setLogBaseDir(String logBaseDir)

Specifies the directory in which the log files should be stored. Defaults to the current working directory. This directory should be a stable storage like a SAN, RAID or at least backed up location. The transactions logs files are as important as the data themselves to guarantee consistency in case of failures.

Parameters:

logBaseDir - the log base dir

setCheckpointInterval

public void setCheckpointInterval(long checkpointInterval)

Specifies the interval between checkpoints. A checkpoint reduces the log file size at the expense of adding some overhead in the runtime. Defaults to 500.

Parameters:

checkpointInterval - the checkpoint interval

setConsoleLogLevel

public void setConsoleLogLevel(AtomikosLoggingLevel consoleLogLevel)

Specifies the console log level. Defaults to AtomikosLoggingLevel.WARN.

Parameters:

consoleLogLevel - the console log level

setOutputDir

public void setOutputDir(String outputDir)

Specifies the directory in which to store the debug log files. Defaults to the current working directory.

Parameters:

outputDir - the output dir

setConsoleFileName

public void setConsoleFileName(String consoleFileName)

Specifies the debug logs file name. Defaults to tm.out.

Parameters:

consoleFileName - the console file name

setConsoleFileCount

public void setConsoleFileCount(int consoleFileCount)

Specifies how many debug logs files can be created. Defaults to 1.

Parameters:

consoleFileCount - the console file count

setConsoleFileLimit

public void setConsoleFileLimit(int consoleFileLimit)

Specifies how many bytes can be stored at most in debug logs files. Defaults to -1. Negative values means unlimited.

Parameters:

consoleFileLimit - the console file limit

setThreadedTwoPhaseCommit

public void setThreadedTwoPhaseCommit(boolean threadedTwoPhaseCommit)

Specifies whether or not to use different (and concurrent) threads for two-phase commit on the participating resources. Setting this to true implies that the commit is more efficient since waiting for acknowledgements is done in parallel. Defaults to true. If you set this to false, then commits will happen in the order that resources are accessed within the transaction.

Parameters:

threadedTwoPhaseCommit - if threaded two phase commits should be used

asProperties

public Properties asProperties()

Returns the properties as a Properties object that can be used with Atomikos.

Returns:

the properties