keren123 / narayana-spring-boot

Narayana Spring Boot autoconfiguration and starter

Narayana Spring Boot

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.

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 or spring.jta.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 more complex configuration you can provide a jbossts-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.transaction-manager-id or spring.jta.transaction-manager-id property with a different value for each instance of your application.

Using databases

This Narayana starter supports two ways to enlist a relational database to a JTA transaction: Narayana Transactional Driver and DBCP2.

By default Narayana Transactional driver is used which provides a basic XAResource enlistment and recovery.

Add pooling

If you need a more sophisticated connection management, you can enable DBCP2 support which provides connection pooling and many other features. To enable DBCP2 add the following property to you application configuration:

narayana.dbcp.enabled=true

All DBCP2 configuration properties described in its documentation are mapped with a prefix narayana.dbcp. So for example if you'd like to set an initial pool size to 10, you could do that by adding this entry to your application configuration:

narayana.dbcp.initialSize=10

Add last resource commit optimization

If you are forced to use a non-xa DataSource to connect to your database you can auto wrap a JDBC Driver instance in a special XADataSource instance with last resource commit optimization enabled by adding this entry to your application configuration:

narayana.dbcp.enabled=true
narayana.lrco.enabled=true

Due to Narayana internal design restrictions, last resource commit optimization is supported for pooled DataSources only.

Using messaging brokers

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.

Add pooling

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 property to you application configuration:

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 an max connections pool size to 10, you could do that by adding this entry to your application configuration:

narayana.messaginghub.maxConnections=10

Release

With GitHub action

GitHub release action is activates with a tag. For example, to release a version 1.2.3 create and push the following tag.

git tag release-1.2.3
git push origin release-1.2.3

Manually

Dry run:

mvn release:prepare -DdryRun

Tag:

mvn release:prepare

Deploy:

mvn release:perform