Documentation

Recent Changes

You are here: Documentation » Spring Boot Integration

Spring Boot Integration

TransactionsEssentials 5.0 and higher

For the latest releases of our product, you have to include our custom starter:

   <dependency>
      <groupId>com.atomikos</groupId>
      <artifactId>transactions-spring-boot-starter</artifactId>
   </dependency>

TransactionsEssentials 4.x

Spring Boot already has built-in integration with older versions of Atomikos TransactionsEssentials. Assuming your pom is already configured for basic Spring Boot, all you need to do extra is add the right "starter" dependency in your pom:

   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jta-atomikos</artifactId>
   </dependency>

Because of the way the boot starters work, this will pull in all Atomikos required dependencies into your project.

ExtremeTransactions

To use the commercial version of Atomikos, override the Atomikos version property in the generated Spring Boot pom.xml file:

Example: releases 5.0.x

<properties>
...
   <atomikos.version>5.0.78</atomikos.version>
</properties>

Example: releases 4.0.x

<properties>
...
   <atomikos.version>4.0.70</atomikos.version>
</properties>

Feel free to use whatever other 4.0 release you need.

Example: releases 3.9.x

<properties>
...
   <atomikos.version>3.9.34</atomikos.version>
</properties>

You will also need to setup your maven build to use our commercial maven repo (customer access only).

Configuring Spring Boot Logging

Spring Boot expects you to specify logging preferences in your application.properties file. Below is an example to set the Atomikos log level to DEBUG:

logging.level.com.atomikos=DEBUG

See Configuring the Logs for what Atomikos log levels mean and do…

By default, Spring Boot logs to the console. To configure a file destination (e.g., 'atomikos.log') you need to add the following in your application.properties file:

logging.file=atomikos.log

Be careful if you add logger-framework specific configuration files because the results may be confusing.

Configuring Atomikos properties in Spring Boot

See https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html for the Spring Boot equivalents of our JTA Properties. Here is an example:

spring:
  jta:
    atomikos:
      properties:
        max-timeout: 900000

IMPORTANT UPDATE: As of release 5.0.107 we have included our own Spring Boot starter, and config properties are no longer prefixed with spring.jta but rather like this:

atomikos:
   properties:
      max-timeout: 900000

Alternatively, just add a separate jta.properties file to your classpath.

Still Need Help?

Apply for a free trial of ExtremeTransactions and have us support you along the way:

Free Trial