From 46d94aba4f4b78377ac80300ccc06eeb58e3a2a9 Mon Sep 17 00:00:00 2001 From: nklmish Date: Fri, 1 Dec 2017 11:19:23 +0100 Subject: [PATCH] Allow graceful shutdown of Atomikos See gh-11237 --- .../jta/AtomikosJtaConfiguration.java | 3 ++- .../boot/jta/atomikos/AtomikosProperties.java | 20 +++++++++++++++++++ .../jta/atomikos/AtomikosPropertiesTests.java | 10 +++++++--- 3 files changed, 29 insertions(+), 4 deletions(-) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/jta/AtomikosJtaConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/jta/AtomikosJtaConfiguration.java index a653a24dd2..23bc7bc85d 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/jta/AtomikosJtaConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/jta/AtomikosJtaConfiguration.java @@ -53,6 +53,7 @@ import org.springframework.util.StringUtils; * @author Andy Wilkinson * @author Stephane Nicoll * @author Kazuki Shimizu + * @author Nakul Mishra * @since 1.2.0 */ @Configuration @@ -72,7 +73,7 @@ class AtomikosJtaConfiguration { .getIfAvailable(); } - @Bean(initMethod = "init", destroyMethod = "shutdownForce") + @Bean(initMethod = "init", destroyMethod = "shutdownWait") @ConditionalOnMissingBean(UserTransactionService.class) public UserTransactionServiceImp userTransactionService( AtomikosProperties atomikosProperties) { diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java index 6a03d099d3..b3ddb0ece0 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jta/atomikos/AtomikosProperties.java @@ -29,6 +29,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; * * @author Phillip Webb * @author Stephane Nicoll + * @author Nakul Mishra * @since 1.2.0 * @see #asProperties() */ @@ -107,6 +108,11 @@ public class AtomikosProperties { private final Recovery recovery = new Recovery(); + /** + * How long should normal shutdown (no-force) wait for transactions to complete. + */ + private long defaultMaxWaitTimeOnShutdown = Long.MAX_VALUE; + /** * Specifies the transaction manager implementation that should be started. There is * no default value and this must be set. Generally, @@ -300,6 +306,19 @@ public class AtomikosProperties { return this.recovery; } + /** + * Specifies how long should a normal shutdown (no-force) wait for transactions to complete. + * Defaults to {@literal Long.MAX_VALUE}. + * @param defaultMaxWaitTimeOnShutdown the default max wait time on shutdown + */ + public void setDefaultMaxWaitTimeOnShutdown(long defaultMaxWaitTimeOnShutdown) { + this.defaultMaxWaitTimeOnShutdown = defaultMaxWaitTimeOnShutdown; + } + + public long getDefaultMaxWaitTimeOnShutdown() { + return this.defaultMaxWaitTimeOnShutdown; + } + /** * Returns the properties as a {@link Properties} object that can be used with * Atomikos. @@ -326,6 +345,7 @@ public class AtomikosProperties { set(properties, "recovery_delay", recovery.getDelay()); set(properties, "oltp_max_retries", recovery.getMaxRetries()); set(properties, "oltp_retry_interval", recovery.getRetryInterval()); + set(properties, "default_max_wait_time_on_shutdown", getDefaultMaxWaitTimeOnShutdown()); return properties; } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jta/atomikos/AtomikosPropertiesTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jta/atomikos/AtomikosPropertiesTests.java index 0565dd1662..a06d4dfc18 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jta/atomikos/AtomikosPropertiesTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jta/atomikos/AtomikosPropertiesTests.java @@ -33,6 +33,7 @@ import static org.assertj.core.api.Assertions.entry; * * @author Phillip Webb * @author Stephane Nicoll + * @author Nakul Mishra */ public class AtomikosPropertiesTests { @@ -58,7 +59,8 @@ public class AtomikosPropertiesTests { this.properties.getRecovery().setDelay(Duration.ofMillis(3000)); this.properties.getRecovery().setMaxRetries(10); this.properties.getRecovery().setRetryInterval(Duration.ofMillis(4000)); - assertThat(this.properties.asProperties().size()).isEqualTo(17); + this.properties.setDefaultMaxWaitTimeOnShutdown(20); + assertThat(this.properties.asProperties().size()).isEqualTo(18); assertProperty("com.atomikos.icatch.service", "service"); assertProperty("com.atomikos.icatch.max_timeout", "1"); assertProperty("com.atomikos.icatch.default_jta_timeout", "2"); @@ -76,6 +78,7 @@ public class AtomikosPropertiesTests { assertProperty("com.atomikos.icatch.recovery_delay", "3000"); assertProperty("com.atomikos.icatch.oltp_max_retries", "10"); assertProperty("com.atomikos.icatch.oltp_retry_interval", "4000"); + assertProperty("com.atomikos.icatch.default_max_wait_time_on_shutdown", "20"); } @Test @@ -94,10 +97,11 @@ public class AtomikosPropertiesTests { "com.atomikos.icatch.threaded_2pc", "com.atomikos.icatch.forget_orphaned_log_entries_delay", "com.atomikos.icatch.oltp_max_retries", - "com.atomikos.icatch.oltp_retry_interval")); + "com.atomikos.icatch.oltp_retry_interval", + "com.atomikos.icatch.default_max_wait_time_on_shutdown")); assertThat(properties).contains(entry("com.atomikos.icatch.recovery_delay", defaultSettings.get("com.atomikos.icatch.default_jta_timeout"))); - assertThat(properties).hasSize(14); + assertThat(properties).hasSize(15); } private MapEntry[] defaultOf(Properties defaultSettings, String... keys) {