Narayana is a popular open source JTA transaction manager implementation supported by Red Hat.
You can use the narayana-spring-boot-starter
starter to add the appropriate Narayana dependencies to your project.
Spring Boot automatically configures Narayana and post-processes your beans to ensure that startup and shutdown ordering
is correct.
<dependency>
<groupId>dev.snowdrop</groupId>
<artifactId>narayana-spring-boot-starter</artifactId>
<version>RELEASE</version>
</dependency>
By default, Narayana transaction logs are written to a transaction-logs
directory in your application home directory
(the directory in which your application jar file resides). You can customize the location of this directory by setting
a narayana.log-dir
property in your application.properties file. Properties starting with narayana
can also be used
to customize the Narayana configuration. See the
NarayanaProperties
Javadoc for complete details.
Only a limited number of Narayana configuration options are exposed via
application.properties
. For a more complex configuration you can provide ajbossts-properties.xml
file. To get more details, please, consult Narayana project documentation.
To ensure that multiple transaction managers can safely coordinate the same resource managers, each Narayana instance must be configured with a unique ID. By default, this ID is set to 1. To ensure uniqueness in production, you should configure the
narayana.node-identifier
property with a different value for each instance of your application. This value must not exceed a length of 28 bytes. To ensure that the value is shortened to a valid length by hashing with SHA-224 and encoding with base64, configurenarayana.shorten-node-identifier-if-necessary
property to true. Be aware, this may result in duplicate strings which break the uniqueness that is mandatory for safe transaction usage!
If you are running your Spring Boot application as a batch program, you'll have to explicitly call exit (SIGTERM
) on your application to proper shutdown.
This is needed because of Narayana is running periodic recovery in a non-daemon background thread.
This could be achieved with the following code example:
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.exit(SpringApplication.run(Application.class, args));
}
}
By default, Narayana Transactional driver is used to enlist a relational database to a JTA transaction which provides a basic XAResource enlistment and recovery as well as a simple pooling mechanism.
Be aware that Narayana Transactional driver automatically set transaction isolation level to
Connection.TRANSACTION_SERIALIZABLE
, which might change default behaviour of the used database system! For example, Oracle Database
If you need a more sophisticated connection management, we advise you to use agroal-spring-boot-starter which provides connection pooling and many other features. To enable Agroal add the following dependency to your application configuration:
<dependency>
<groupId>io.agroal</groupId>
<artifactId>agroal-spring-boot-starter</artifactId>
<version>2.x.x</version>
</dependency>
All Agroal configuration properties described in its documentation
This Narayana starter supports two ways to enlist a messaging broker to a JTA transaction: plain connection factory and MessagingHub pooled connection factory.
By default, Narayana Connection Proxy around the JMS connection factory is used which provides a basic XAResource enlistment and recovery.
If you need a more sophisticated connection management, you can enable MessagingHub support which provides connection pooling and many other features. To enable MessagingHub add the following dependency and property to you application configuration:
<dependency>
<groupId>org.messaginghub</groupId>
<artifactId>pooled-jms</artifactId>
</dependency>
narayana.messaginghub.enabled=true
All MessagingHub configuration properties described in its documentation
are mapped with a prefix narayana.messaginghub
. So for example if you'd like to set a max connections pool size to 10,
you could do that by adding this entry to your application configuration:
narayana.messaginghub.maxConnections=10
Dry run:
mvn release:prepare -DdryRun
Tag:
mvn release:prepare
Deploy:
mvn release:perform
Set all modules to new SNAPSHOT version:
mvn versions:set
mvn versions:commit