├── .editorconfig ├── .github ├── dependabot.yml └── workflows │ └── ci.yaml ├── .gitignore ├── .mvn └── wrapper │ ├── MavenWrapperDownloader.java │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── .settings.xml ├── LICENSE ├── README.md ├── config ├── checkstyle │ └── checkstyle.xml └── pmd │ └── ruleset.xml ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── github │ │ └── timpeeters │ │ └── boot │ │ └── shutdown │ │ └── autoconfigure │ │ ├── GracefulShutdownAutoConfiguration.java │ │ ├── GracefulShutdownHealthIndicator.java │ │ ├── GracefulShutdownProperties.java │ │ ├── GracefulShutdownTomcatConnectorCustomizer.java │ │ └── GracefulShutdownTomcatContainerCustomizer.java └── resources │ └── META-INF │ └── spring.factories └── test ├── java └── com │ └── github │ └── timpeeters │ └── boot │ └── shutdown │ └── autoconfigure │ ├── AbstractIT.java │ ├── GracefulShutdownIT.java │ ├── GracefulShutdownTomcatConnectorCustomizerTest.java │ ├── GracefulShutdownWithWaitIT.java │ └── NonGracefulShutdownIT.java └── resources └── logback-test.xml /.editorconfig: -------------------------------------------------------------------------------- 1 | root=true 2 | 3 | [*] 4 | charset=utf-8 5 | continuation_indent_size=8 6 | end_of_line=lf 7 | insert_final_newline=true 8 | indent_size=4 9 | indent_style=space 10 | trim_trailing_whitespace=true 11 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: maven 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "08:00" 8 | timezone: Europe/Brussels 9 | open-pull-requests-limit: 10 10 | ignore: 11 | - dependency-name: org.springframework.boot:spring-boot-dependencies 12 | versions: 13 | - "> 2.2.7.RELEASE, < 3" 14 | - dependency-name: org.springframework.boot:spring-boot-dependencies 15 | versions: 16 | - ">= 2.4.a, < 2.5" 17 | - dependency-name: com.puppycrawl.tools:checkstyle 18 | versions: 19 | - "8.40" 20 | - "8.41" 21 | - 8.41.1 22 | - package-ecosystem: maven 23 | directory: "/" 24 | schedule: 25 | interval: daily 26 | time: "08:00" 27 | timezone: Europe/Brussels 28 | open-pull-requests-limit: 10 29 | target-branch: 2.0.x 30 | ignore: 31 | - dependency-name: org.springframework.boot:spring-boot-dependencies 32 | versions: 33 | - "> 2.0.9.RELEASE, < 3" 34 | - dependency-name: org.springframework.boot:spring-boot-dependencies 35 | versions: 36 | - "< 2.2, >= 2.1.a" 37 | - dependency-name: org.springframework.boot:spring-boot-dependencies 38 | versions: 39 | - ">= 2.2.a, < 2.3" 40 | - dependency-name: com.puppycrawl.tools:checkstyle 41 | versions: 42 | - "8.40" 43 | - "8.41" 44 | - 8.41.1 45 | - package-ecosystem: maven 46 | directory: "/" 47 | schedule: 48 | interval: daily 49 | time: "08:00" 50 | timezone: Europe/Brussels 51 | open-pull-requests-limit: 10 52 | target-branch: 2.1.x 53 | ignore: 54 | - dependency-name: org.springframework.boot:spring-boot-dependencies 55 | versions: 56 | - "> 2.1.9.RELEASE, < 3" 57 | - dependency-name: com.puppycrawl.tools:checkstyle 58 | versions: 59 | - "8.40" 60 | - "8.41" 61 | - 8.41.1 62 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | types: [ opened, synchronize, reopened ] 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | with: 14 | fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of SonarCloud analysis 15 | - name: Set up JDK 16 | uses: actions/setup-java@v1 17 | with: 18 | architecture: x64 19 | java-version: 11 20 | - name: Cache SonarCloud packages 21 | uses: actions/cache@v1 22 | with: 23 | path: ~/.sonar/cache 24 | key: ${{ runner.os }}-sonar 25 | restore-keys: ${{ runner.os }}-sonar 26 | - name: Cache Maven packages 27 | uses: actions/cache@v2 28 | with: 29 | path: ~/.m2 30 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} 31 | restore-keys: ${{ runner.os }}-m2 32 | - name: Build with Maven 33 | run: mvn verify --batch-mode 34 | - name: SonarCloud Analysis with Maven 35 | env: 36 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any 37 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 38 | run: mvn org.sonarsource.scanner.maven:sonar-maven-plugin:sonar --batch-mode -Psonar -Dsonar.login=$SONAR_TOKEN 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .idea 3 | target 4 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | import java.net.*; 21 | import java.io.*; 22 | import java.nio.channels.*; 23 | import java.util.Properties; 24 | 25 | public class MavenWrapperDownloader { 26 | 27 | /** 28 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. 29 | */ 30 | private static final String DEFAULT_DOWNLOAD_URL = 31 | "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"; 32 | 33 | /** 34 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to 35 | * use instead of the default one. 36 | */ 37 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH = 38 | ".mvn/wrapper/maven-wrapper.properties"; 39 | 40 | /** 41 | * Path where the maven-wrapper.jar will be saved to. 42 | */ 43 | private static final String MAVEN_WRAPPER_JAR_PATH = 44 | ".mvn/wrapper/maven-wrapper.jar"; 45 | 46 | /** 47 | * Name of the property which should be used to override the default download url for the wrapper. 48 | */ 49 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; 50 | 51 | public static void main(String args[]) { 52 | System.out.println("- Downloader started"); 53 | File baseDirectory = new File(args[0]); 54 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); 55 | 56 | // If the maven-wrapper.properties exists, read it and check if it contains a custom 57 | // wrapperUrl parameter. 58 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); 59 | String url = DEFAULT_DOWNLOAD_URL; 60 | if(mavenWrapperPropertyFile.exists()) { 61 | FileInputStream mavenWrapperPropertyFileInputStream = null; 62 | try { 63 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); 64 | Properties mavenWrapperProperties = new Properties(); 65 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); 66 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); 67 | } catch (IOException e) { 68 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); 69 | } finally { 70 | try { 71 | if(mavenWrapperPropertyFileInputStream != null) { 72 | mavenWrapperPropertyFileInputStream.close(); 73 | } 74 | } catch (IOException e) { 75 | // Ignore ... 76 | } 77 | } 78 | } 79 | System.out.println("- Downloading from: : " + url); 80 | 81 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); 82 | if(!outputFile.getParentFile().exists()) { 83 | if(!outputFile.getParentFile().mkdirs()) { 84 | System.out.println( 85 | "- ERROR creating output direcrory '" + outputFile.getParentFile().getAbsolutePath() + "'"); 86 | } 87 | } 88 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); 89 | try { 90 | downloadFileFromURL(url, outputFile); 91 | System.out.println("Done"); 92 | System.exit(0); 93 | } catch (Throwable e) { 94 | System.out.println("- Error downloading"); 95 | e.printStackTrace(); 96 | System.exit(1); 97 | } 98 | } 99 | 100 | private static void downloadFileFromURL(String urlString, File destination) throws Exception { 101 | URL website = new URL(urlString); 102 | ReadableByteChannel rbc; 103 | rbc = Channels.newChannel(website.openStream()); 104 | FileOutputStream fos = new FileOutputStream(destination); 105 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); 106 | fos.close(); 107 | rbc.close(); 108 | } 109 | 110 | } 111 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/timpeeters/spring-boot-graceful-shutdown/6db79270990fae65fd8ef516fc25b1d3e2c6ac41/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.2/apache-maven-3.6.2-bin.zip -------------------------------------------------------------------------------- /.settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | 8 | 9 | 10 | ossrh 11 | ${env.SONATYPE_USERNAME} 12 | ${env.SONATYPE_PASSWORD} 13 | 14 | 15 | 16 | 17 | 18 | ossrh 19 | 20 | true 21 | 22 | 23 | ${env.GPG_EXECUTABLE} 24 | ${env.GPG_PASSPHRASE} 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Spring Boot Graceful Shutdown 2 | ============================= 3 | 4 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.timpeeters/spring-boot-graceful-shutdown/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.timpeeters/spring-boot-graceful-shutdown) 5 | 6 | This project adds graceful shutdown behavior to Spring Boot. 7 | 8 | > :warning: As of Spring Boot 2.3+, use the native support inside Spring Boot to accomplish graceful shutdown: https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.graceful-shutdown. Additionally, when deployed on Kubernetes, add a preStop command: 9 | https://docs.spring.io/spring-boot/docs/current/reference/html/deployment.html#deployment.cloud.kubernetes.container-lifecycle 10 | 11 | Versions 12 | -------- 13 | 14 | Multiple branches are maintained to support multiple Spring Boot versions. 15 | The following tables show the relation between the Spring Boot version and the Spring Boot Graceful Shutdown version. 16 | 17 | | Spring Boot | Spring Boot Graceful Shutdown | Branch | 18 | | :--- | :--- | :--- | 19 | | 1.5.x | 1.0.x | 1.0.x | 20 | | 2.0.x | 2.0.x | 2.0.x | 21 | | 2.1.x | 2.1.x | 2.1.x | 22 | | 2.2.x | 2.2.x | master | 23 | 24 | 25 | Flow 26 | ---- 27 | 28 | 1. The JVM receives the SIGTERM signal and starts shutting down the Spring container. 29 | 2. A Spring EventListener listens for a ContextClosedEvent and is invoked once the shutdown is started. 30 | 3. The EventListener updates a Spring Boot HealthIndicator and puts it "out of service". 31 | 5. The context shutdown is delayed using a Thread.sleep to allow the load balancer to see the updated HealthIndicator status and stop forwarding requests to this instance. 32 | 7. When the Thread.sleep is finished, the Tomcat container is gracefully shutdown. 33 | First by pausing the connector, no longer accepting new request. 34 | Next, by allowing the Tomcat thread pool a configurable amount of time to finish the active threads. 35 | 8. Finally, the Spring context is closed. 36 | 37 | 38 | Limitations 39 | ----------- 40 | 41 | Currently this project only supports Tomcat as embedded web container for Spring Boot. 42 | Undertow and/or Jetty are not yet supported. 43 | 44 | 45 | Installation 46 | ------------ 47 | 48 | 1. Add the following Maven dependency: 49 | 50 | ```xml 51 | 52 | com.github.timpeeters 53 | spring-boot-graceful-shutdown 54 | X.X.X 55 | 56 | ``` 57 | 58 | 59 | Configuration 60 | ------------- 61 | 62 | | Key | Default value | Description | 63 | | ------------------------- | -------------- | ----------- | 64 | | graceful.shutdown.enabled | false | Indicates whether graceful shutdown is enabled or not. | 65 | | graceful.shutdown.timeout | 60s | The time to wait for active threads to finish before shutting down the Tomcat connector. | 66 | | graceful.shutdown.wait | 30s | The time to return "out of service" on the health page before starting the graceful shutdown. | 67 | 68 | It is important to specify the time unit, otherwise you end up with milliseconds. 69 | 70 | Alternative implementations 71 | --------------------------- 72 | 73 | We found several alternatives for graceful shutdown behavior in Spring Boot. 74 | 75 | - https://github.com/SchweizerischeBundesbahnen/springboot-graceful-shutdown 76 | - https://github.com/corentin59/spring-boot-graceful-shutdown 77 | - https://github.com/gesellix/graceful-shutdown-spring-boot 78 | 79 | 80 | References 81 | ---------- 82 | 83 | - https://github.com/spring-projects/spring-boot/issues/4657 84 | -------------------------------------------------------------------------------- /config/checkstyle/checkstyle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | -------------------------------------------------------------------------------- /config/pmd/ruleset.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | 8 | 4.0.0 9 | com.github.timpeeters 10 | spring-boot-graceful-shutdown 11 | 2.2.3-SNAPSHOT 12 | jar 13 | Spring Boot Graceful Shutdown 14 | Add graceful shutdown support to Spring Boot applications. 15 | https://github.com/timpeeters/spring-boot-graceful-shutdown 16 | 17 | 18 | 19 | Apache License, Version 2.0 20 | http://www.apache.org/licenses/LICENSE-2.0 21 | repo 22 | 23 | 24 | 25 | 26 | 27 | Tim Peeters 28 | tim.peeters@me.com 29 | 30 | 31 | 32 | 33 | scm:git:https://github.com/timpeeters/spring-boot-graceful-shutdown.git 34 | scm:git:https://github.com/timpeeters/spring-boot-graceful-shutdown.git 35 | https://github.com/timpeeters/spring-boot-graceful-shutdown 36 | 37 | 38 | 39 | 40 | ossrh 41 | https://oss.sonatype.org/content/repositories/snapshots 42 | 43 | 44 | 45 | 46 | 11 47 | 11 48 | 49 | UTF-8 50 | UTF-8 51 | 52 | 53 | 54 | 55 | com.fasterxml.jackson.core 56 | jackson-annotations 57 | provided 58 | 59 | 60 | 61 | junit 62 | junit 63 | test 64 | 65 | 66 | 67 | org.apache.tomcat.embed 68 | tomcat-embed-core 69 | true 70 | 71 | 72 | 73 | org.assertj 74 | assertj-core 75 | test 76 | 77 | 78 | 79 | org.asynchttpclient 80 | async-http-client 81 | test 82 | 83 | 84 | 85 | org.mockito 86 | mockito-core 87 | test 88 | 89 | 90 | 91 | org.slf4j 92 | slf4j-api 93 | 94 | 95 | 96 | org.springframework 97 | spring-beans 98 | 99 | 100 | 101 | org.springframework 102 | spring-context 103 | 104 | 105 | 106 | org.springframework 107 | spring-core 108 | 109 | 110 | 111 | org.springframework 112 | spring-web 113 | test 114 | 115 | 116 | 117 | org.springframework.boot 118 | spring-boot 119 | 120 | 121 | 122 | org.springframework.boot 123 | spring-boot-actuator 124 | true 125 | 126 | 127 | 128 | org.springframework.boot 129 | spring-boot-autoconfigure 130 | 131 | 132 | 133 | org.springframework.boot 134 | spring-boot-configuration-processor 135 | true 136 | 137 | 138 | 139 | org.springframework.boot 140 | spring-boot-starter-actuator 141 | test 142 | 143 | 144 | 145 | org.springframework.boot 146 | spring-boot-starter-logging 147 | test 148 | 149 | 150 | 151 | org.springframework.boot 152 | spring-boot-starter-test 153 | test 154 | 155 | 156 | 157 | org.springframework.boot 158 | spring-boot-starter-web 159 | test 160 | 161 | 162 | 163 | 164 | 165 | 166 | org.assertj 167 | assertj-core 168 | 3.21.0 169 | 170 | 171 | 172 | org.asynchttpclient 173 | async-http-client 174 | 2.12.3 175 | 176 | 177 | 178 | org.springframework.boot 179 | spring-boot-dependencies 180 | 2.2.7.RELEASE 181 | import 182 | pom 183 | 184 | 185 | 186 | 187 | 188 | package 189 | 190 | 191 | 192 | 193 | maven-checkstyle-plugin 194 | 3.1.2 195 | 196 | 197 | com.puppycrawl.tools 198 | checkstyle 199 | 9.2 200 | 201 | 202 | 203 | 204 | 205 | maven-clean-plugin 206 | 3.1.0 207 | 208 | 209 | 210 | maven-compiler-plugin 211 | 3.8.1 212 | 213 | 214 | 215 | maven-dependency-plugin 216 | 3.1.2 217 | 218 | 219 | 220 | maven-deploy-plugin 221 | 2.8.2 222 | 223 | 224 | 225 | maven-enforcer-plugin 226 | 3.0.0 227 | 228 | 229 | 230 | maven-failsafe-plugin 231 | 2.22.2 232 | 233 | 234 | 235 | maven-gpg-plugin 236 | 3.0.1 237 | 238 | 239 | 240 | maven-install-plugin 241 | 2.5.2 242 | 243 | 244 | 245 | maven-jar-plugin 246 | 3.2.0 247 | 248 | 249 | 250 | maven-javadoc-plugin 251 | 3.3.1 252 | 253 | 254 | 255 | maven-pmd-plugin 256 | 3.15.0 257 | 258 | 259 | 260 | maven-resources-plugin 261 | 3.2.0 262 | 263 | 264 | 265 | maven-site-plugin 266 | 3.9.1 267 | 268 | 269 | 270 | maven-source-plugin 271 | 3.2.1 272 | 273 | 274 | 275 | maven-surefire-plugin 276 | 2.22.2 277 | 278 | 279 | 280 | org.jacoco 281 | jacoco-maven-plugin 282 | 0.8.7 283 | 284 | 285 | 286 | org.sonatype.plugins 287 | nexus-staging-maven-plugin 288 | 1.6.8 289 | 290 | 291 | 292 | 293 | 294 | 295 | maven-checkstyle-plugin 296 | 297 | 298 | validate 299 | validate 300 | 301 | ${basedir}/config/checkstyle/checkstyle.xml 302 | UTF-8 303 | false 304 | false 305 | true 306 | true 307 | 308 | 309 | check 310 | 311 | 312 | 313 | 314 | 315 | 316 | maven-compiler-plugin 317 | 318 | -Xlint:-processing 319 | true 320 | true 321 | true 322 | 323 | 324 | 325 | 326 | maven-dependency-plugin 327 | 328 | 329 | analyze 330 | verify 331 | 332 | analyze-only 333 | 334 | 335 | true 336 | 337 | 338 | org.springframework.boot:spring-boot-configuration-processor 339 | 340 | 341 | org.springframework.boot:spring-boot-starter-* 342 | 343 | 344 | 345 | com.fasterxml.jackson.core:jackson-annotations 346 | 347 | 348 | 349 | 350 | 351 | 352 | 353 | maven-enforcer-plugin 354 | 355 | 356 | enforce 357 | 358 | enforce 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | 367 | [11,] 368 | 369 | 370 | 371 | [3.6.3,) 372 | 373 | 374 | 375 | 376 | 377 | 378 | 379 | 380 | 381 | 382 | maven-failsafe-plugin 383 | 384 | 385 | integration-test 386 | 387 | integration-test 388 | verify 389 | 390 | 391 | 392 | 393 | 394 | 395 | maven-pmd-plugin 396 | 397 | false 398 | true 399 | false 400 | true 401 | 402 | ${basedir}/config/pmd/ruleset.xml 403 | 404 | 405 | 406 | 407 | pmd-check 408 | 409 | check 410 | cpd-check 411 | 412 | 413 | 414 | 415 | 416 | 417 | org.jacoco 418 | jacoco-maven-plugin 419 | 420 | 421 | 422 | prepare-agent 423 | 424 | 425 | 426 | report 427 | verify 428 | 429 | report 430 | 431 | 432 | 433 | 434 | 435 | 436 | 437 | 438 | 439 | release 440 | 441 | 442 | 443 | maven-gpg-plugin 444 | 445 | 446 | sign-artifacts 447 | verify 448 | 449 | sign 450 | 451 | 452 | 453 | 454 | 455 | 456 | maven-javadoc-plugin 457 | 458 | 459 | attach-javadoc 460 | 461 | jar 462 | 463 | 464 | 465 | 466 | 467 | 468 | maven-source-plugin 469 | 470 | 471 | attach-sources 472 | 473 | jar-no-fork 474 | 475 | 476 | 477 | 478 | 479 | 480 | org.sonatype.plugins 481 | nexus-staging-maven-plugin 482 | true 483 | 484 | true 485 | https://oss.sonatype.org/ 486 | ossrh 487 | 15 488 | 489 | 490 | 491 | 492 | 493 | 494 | 495 | sonar 496 | 497 | https://sonarcloud.io 498 | timpeeters 499 | ${project.groupId}:${project.artifactId} 500 | 501 | 502 | 503 | 504 | -------------------------------------------------------------------------------- /src/main/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; 6 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 7 | import org.springframework.context.ApplicationContext; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | 11 | @ConditionalOnProperty(havingValue = "true", prefix = "graceful.shutdown", name = "enabled") 12 | @ConditionalOnWebApplication 13 | @Configuration 14 | @EnableConfigurationProperties(GracefulShutdownProperties.class) 15 | public class GracefulShutdownAutoConfiguration { 16 | @Bean 17 | @ConditionalOnMissingBean 18 | public GracefulShutdownHealthIndicator gracefulShutdownHealthIndicator( 19 | ApplicationContext ctx, GracefulShutdownProperties props) { 20 | 21 | return new GracefulShutdownHealthIndicator(ctx, props); 22 | } 23 | 24 | @Bean 25 | @ConditionalOnMissingBean 26 | public GracefulShutdownTomcatContainerCustomizer gracefulShutdownTomcatContainerCustomizer( 27 | GracefulShutdownTomcatConnectorCustomizer connectorCustomizer) { 28 | 29 | return new GracefulShutdownTomcatContainerCustomizer(connectorCustomizer); 30 | } 31 | 32 | @Bean 33 | @ConditionalOnMissingBean 34 | public GracefulShutdownTomcatConnectorCustomizer gracefulShutdownTomcatConnectorCustomizer( 35 | ApplicationContext ctx, GracefulShutdownProperties props) { 36 | 37 | return new GracefulShutdownTomcatConnectorCustomizer(ctx, props); 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownHealthIndicator.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.slf4j.Logger; 4 | import org.slf4j.LoggerFactory; 5 | import org.springframework.boot.actuate.health.Health; 6 | import org.springframework.boot.actuate.health.HealthIndicator; 7 | import org.springframework.context.ApplicationContext; 8 | import org.springframework.context.event.ContextClosedEvent; 9 | import org.springframework.context.event.EventListener; 10 | import org.springframework.core.Ordered; 11 | import org.springframework.core.annotation.Order; 12 | 13 | public class GracefulShutdownHealthIndicator implements HealthIndicator { 14 | private static final Logger LOG = LoggerFactory.getLogger(GracefulShutdownHealthIndicator.class); 15 | 16 | private final ApplicationContext applicationContext; 17 | private final GracefulShutdownProperties props; 18 | 19 | private Health health = Health.up().build(); 20 | 21 | public GracefulShutdownHealthIndicator(ApplicationContext ctx, GracefulShutdownProperties props) { 22 | this.applicationContext = ctx; 23 | this.props = props; 24 | } 25 | 26 | @Override 27 | public Health health() { 28 | return health; 29 | } 30 | 31 | @EventListener(ContextClosedEvent.class) 32 | @Order(Ordered.HIGHEST_PRECEDENCE) 33 | public void contextClosed(ContextClosedEvent event) throws InterruptedException { 34 | if (isEventFromLocalContext(event)) { 35 | updateHealthToOutOfService(); 36 | waitForKubernetesToSeeOutOfService(); 37 | } 38 | } 39 | 40 | private void updateHealthToOutOfService() { 41 | health = Health.outOfService().build(); 42 | 43 | LOG.info("Health status set to out of service"); 44 | } 45 | 46 | private void waitForKubernetesToSeeOutOfService() throws InterruptedException { 47 | LOG.info("Wait {} seconds for Kubernetes to see the out of service status", props.getWait().getSeconds()); 48 | 49 | Thread.sleep(props.getWait().toMillis()); 50 | } 51 | 52 | private boolean isEventFromLocalContext(ContextClosedEvent event) { 53 | return event.getApplicationContext().equals(applicationContext); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/main/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownProperties.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.slf4j.Logger; 4 | import org.slf4j.LoggerFactory; 5 | import org.springframework.beans.factory.InitializingBean; 6 | import org.springframework.boot.context.properties.ConfigurationProperties; 7 | 8 | import java.time.Duration; 9 | import java.util.StringJoiner; 10 | 11 | @ConfigurationProperties("graceful.shutdown") 12 | public class GracefulShutdownProperties implements InitializingBean { 13 | private static final Logger LOG = LoggerFactory.getLogger(GracefulShutdownProperties.class); 14 | 15 | /** 16 | * Indicates whether graceful shutdown is enabled or not. 17 | */ 18 | private boolean enabled; 19 | 20 | /** 21 | * The number of seconds to wait for active threads to finish before shutting down the embedded web container. 22 | */ 23 | private Duration timeout = Duration.ofSeconds(60); 24 | 25 | /** 26 | * The number of seconds to wait before starting the graceful shutdown. During this time, the health checker returns 27 | * OUT_OF_SERVICE. 28 | */ 29 | private Duration wait = Duration.ofSeconds(30); 30 | 31 | public boolean isEnabled() { 32 | return enabled; 33 | } 34 | 35 | public void setEnabled(boolean enabled) { 36 | this.enabled = enabled; 37 | } 38 | 39 | public Duration getTimeout() { 40 | return timeout; 41 | } 42 | 43 | public void setTimeout(Duration timeout) { 44 | this.timeout = timeout; 45 | } 46 | 47 | public Duration getWait() { 48 | return wait; 49 | } 50 | 51 | public void setWait(Duration wait) { 52 | this.wait = wait; 53 | } 54 | 55 | @Override 56 | public String toString() { 57 | return new StringJoiner(", ", "GracefulShutdownProperties[", "]") 58 | .add("enabled=" + isEnabled()) 59 | .add("timeout=" + getTimeout()) 60 | .add("wait=" + getWait()) 61 | .toString(); 62 | } 63 | 64 | @Override 65 | public void afterPropertiesSet() { 66 | LOG.info(toString()); 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/main/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownTomcatConnectorCustomizer.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.apache.catalina.connector.Connector; 4 | import org.slf4j.Logger; 5 | import org.slf4j.LoggerFactory; 6 | import org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer; 7 | import org.springframework.context.ApplicationContext; 8 | import org.springframework.context.event.ContextClosedEvent; 9 | import org.springframework.context.event.EventListener; 10 | import org.springframework.core.Ordered; 11 | import org.springframework.core.annotation.Order; 12 | 13 | import java.util.concurrent.Executor; 14 | import java.util.concurrent.ThreadPoolExecutor; 15 | import java.util.concurrent.TimeUnit; 16 | 17 | public class GracefulShutdownTomcatConnectorCustomizer implements TomcatConnectorCustomizer { 18 | private static final Logger LOG = LoggerFactory.getLogger(GracefulShutdownTomcatConnectorCustomizer.class); 19 | 20 | private static final int CHECK_INTERVAL = 10; 21 | 22 | private final ApplicationContext applicationContext; 23 | private final GracefulShutdownProperties props; 24 | 25 | private Connector connector; 26 | 27 | public GracefulShutdownTomcatConnectorCustomizer(ApplicationContext ctx, GracefulShutdownProperties props) { 28 | this.applicationContext = ctx; 29 | this.props = props; 30 | } 31 | 32 | @Override 33 | public void customize(Connector connector) { 34 | this.connector = connector; 35 | } 36 | 37 | @EventListener(ContextClosedEvent.class) 38 | @Order(Ordered.HIGHEST_PRECEDENCE + 1) 39 | public void contextClosed(ContextClosedEvent event) throws InterruptedException { 40 | if (connector == null) { 41 | return; 42 | } 43 | 44 | if (isEventFromLocalContext(event)) { 45 | stopAcceptingNewRequests(); 46 | shutdownThreadPoolExecutor(); 47 | } 48 | } 49 | 50 | private void stopAcceptingNewRequests() { 51 | connector.pause(); 52 | 53 | LOG.info("Paused {} to stop accepting new requests", connector); 54 | } 55 | 56 | private void shutdownThreadPoolExecutor() throws InterruptedException { 57 | ThreadPoolExecutor executor = getThreadPoolExecutor(); 58 | 59 | if (executor != null) { 60 | executor.shutdown(); 61 | awaitTermination(executor); 62 | } 63 | } 64 | 65 | private void awaitTermination(ThreadPoolExecutor executor) throws InterruptedException { 66 | for (long remaining = props.getTimeout().getSeconds(); remaining > 0; remaining -= CHECK_INTERVAL) { 67 | LOG.info("{} thread(s) active, {} seconds remaining", executor.getActiveCount(), remaining); 68 | 69 | if (executor.awaitTermination(CHECK_INTERVAL, TimeUnit.SECONDS)) { 70 | return; 71 | } 72 | } 73 | 74 | logMessageIfThereAreStillActiveThreads(executor); 75 | } 76 | 77 | private void logMessageIfThereAreStillActiveThreads(ThreadPoolExecutor executor) { 78 | if (executor.getActiveCount() > 0) { 79 | LOG.warn("{} thread(s) still active, force shutdown", executor.getActiveCount()); 80 | } 81 | } 82 | 83 | private ThreadPoolExecutor getThreadPoolExecutor() { 84 | Executor executor = connector.getProtocolHandler().getExecutor(); 85 | 86 | if (executor instanceof ThreadPoolExecutor) { 87 | return (ThreadPoolExecutor) executor; 88 | } 89 | 90 | return null; 91 | } 92 | 93 | private boolean isEventFromLocalContext(ContextClosedEvent event) { 94 | return event.getApplicationContext().equals(applicationContext); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/main/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownTomcatContainerCustomizer.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory; 4 | import org.springframework.boot.web.server.WebServerFactoryCustomizer; 5 | 6 | public class GracefulShutdownTomcatContainerCustomizer 7 | implements WebServerFactoryCustomizer { 8 | 9 | private final GracefulShutdownTomcatConnectorCustomizer connectorCustomizer; 10 | 11 | public GracefulShutdownTomcatContainerCustomizer(GracefulShutdownTomcatConnectorCustomizer connectorCustomizer) { 12 | this.connectorCustomizer = connectorCustomizer; 13 | } 14 | 15 | @Override 16 | public void customize(TomcatServletWebServerFactory factory) { 17 | factory.addConnectorCustomizers(connectorCustomizer); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 2 | com.github.timpeeters.boot.shutdown.autoconfigure.GracefulShutdownAutoConfiguration 3 | -------------------------------------------------------------------------------- /src/test/java/com/github/timpeeters/boot/shutdown/autoconfigure/AbstractIT.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.asynchttpclient.ListenableFuture; 4 | import org.asynchttpclient.Response; 5 | import org.junit.After; 6 | import org.junit.Before; 7 | import org.slf4j.Logger; 8 | import org.slf4j.LoggerFactory; 9 | import org.springframework.boot.SpringApplication; 10 | import org.springframework.boot.autoconfigure.SpringBootApplication; 11 | import org.springframework.context.ConfigurableApplicationContext; 12 | import org.springframework.http.HttpStatus; 13 | import org.springframework.http.ResponseEntity; 14 | import org.springframework.util.SocketUtils; 15 | import org.springframework.web.bind.annotation.GetMapping; 16 | import org.springframework.web.bind.annotation.RestController; 17 | 18 | import java.util.Properties; 19 | import java.util.concurrent.CompletableFuture; 20 | import java.util.concurrent.ExecutionException; 21 | import java.util.concurrent.Semaphore; 22 | import java.util.concurrent.TimeUnit; 23 | 24 | import static org.assertj.core.api.Assertions.assertThat; 25 | import static org.assertj.core.api.Assertions.assertThatCode; 26 | import static org.asynchttpclient.Dsl.asyncHttpClient; 27 | import static org.asynchttpclient.Dsl.get; 28 | 29 | public abstract class AbstractIT { 30 | protected static final Logger LOG = LoggerFactory.getLogger(NonGracefulShutdownIT.class); 31 | 32 | protected static final Semaphore REQ_RECEIVED = new Semaphore(0); 33 | protected static final Semaphore REQ_FINISHED = new Semaphore(0); 34 | 35 | private final int port = SocketUtils.findAvailableTcpPort(); 36 | 37 | private ConfigurableApplicationContext applicationContext; 38 | private CompletableFuture shutdown; 39 | 40 | @Before 41 | public void startSpringBootApplication() throws ExecutionException, InterruptedException { 42 | applicationContext = SpringApplication.run(TestApplication.class, getArgs()); 43 | 44 | emulateSuccessfulRequest(); 45 | } 46 | 47 | @After 48 | public void verifySpringBootApplicationShutdownComplete() { 49 | assertThatCode(() -> shutdown.get(30, TimeUnit.SECONDS)).doesNotThrowAnyException(); 50 | } 51 | 52 | protected String[] getArgs() { 53 | return getProperties().entrySet().stream() 54 | .map(e -> "--" + e.getKey() + "=" + e.getValue()) 55 | .toArray(String[]::new); 56 | 57 | } 58 | 59 | protected final Properties getProperties() { 60 | Properties props = new Properties(); 61 | props.setProperty("server.port", Integer.toString(port)); 62 | props.setProperty("spring.main.banner-mode", "off"); 63 | 64 | configure(props); 65 | 66 | return props; 67 | } 68 | 69 | protected abstract void configure(Properties properties); 70 | 71 | protected void emulateSuccessfulRequest() throws ExecutionException, InterruptedException { 72 | ListenableFuture slowRequest = sendRequestAndWaitForServerToStartProcessing(); 73 | 74 | REQ_FINISHED.release(); 75 | 76 | assertThat(slowRequest.get().getStatusCode()).isEqualTo(HttpStatus.NO_CONTENT.value()); 77 | } 78 | 79 | protected ListenableFuture sendRequestAndWaitForServerToStartProcessing() 80 | throws InterruptedException { 81 | 82 | ListenableFuture response = sendRequest("/"); 83 | 84 | REQ_RECEIVED.acquire(); 85 | 86 | return response; 87 | } 88 | 89 | protected ListenableFuture sendRequest(String path) { 90 | return asyncHttpClient().executeRequest(get("http://localhost:" + port + path)); 91 | } 92 | 93 | protected void stopSpringBootApp() { 94 | shutdown = CompletableFuture.runAsync(() -> applicationContext.close()); 95 | } 96 | 97 | @SpringBootApplication 98 | public static class TestApplication { 99 | @RestController 100 | public class TestController { 101 | @GetMapping("/") 102 | public ResponseEntity get() throws InterruptedException { 103 | REQ_RECEIVED.release(); 104 | 105 | LOG.debug("Received get request, try to acquire semaphore"); 106 | 107 | REQ_FINISHED.acquire(); 108 | 109 | LOG.debug("Semaphore acquired, returning empty response"); 110 | 111 | return new ResponseEntity<>(HttpStatus.NO_CONTENT); 112 | } 113 | } 114 | 115 | public static void main(String[] args) { 116 | SpringApplication.run(TestApplication.class); 117 | } 118 | } 119 | } 120 | -------------------------------------------------------------------------------- /src/test/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownIT.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.asynchttpclient.ListenableFuture; 4 | import org.asynchttpclient.Response; 5 | import org.junit.Test; 6 | import org.springframework.http.HttpStatus; 7 | 8 | import java.io.IOException; 9 | import java.util.Properties; 10 | import java.util.concurrent.ExecutionException; 11 | 12 | import static org.assertj.core.api.Assertions.assertThat; 13 | import static org.assertj.core.api.Assertions.assertThatCode; 14 | 15 | public class GracefulShutdownIT extends AbstractIT { 16 | @Override 17 | protected void configure(Properties properties) { 18 | properties.setProperty("graceful.shutdown.enabled", "true"); 19 | properties.setProperty("graceful.shutdown.timeout", "5s"); 20 | properties.setProperty("graceful.shutdown.wait", "0s"); 21 | } 22 | 23 | @Test 24 | public void inFlightRequestSuccessful() throws ExecutionException, InterruptedException { 25 | ListenableFuture response = sendRequestAndWaitForServerToStartProcessing(); 26 | 27 | stopSpringBootApp(); 28 | 29 | REQ_FINISHED.release(); 30 | 31 | assertThat(response.get().getStatusCode()).isEqualTo(HttpStatus.NO_CONTENT.value()); 32 | } 33 | 34 | @Test 35 | public void inFlightRequestFailsAfterTimeout() throws InterruptedException { 36 | ListenableFuture response = sendRequestAndWaitForServerToStartProcessing(); 37 | 38 | stopSpringBootApp(); 39 | 40 | assertThatCode(response::get).hasCauseInstanceOf(IOException.class); 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/test/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownTomcatConnectorCustomizerTest.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.apache.catalina.connector.Connector; 4 | import org.apache.coyote.ProtocolHandler; 5 | import org.junit.Test; 6 | import org.junit.runner.RunWith; 7 | import org.mockito.InjectMocks; 8 | import org.mockito.Mock; 9 | import org.mockito.junit.MockitoJUnitRunner; 10 | import org.springframework.context.ApplicationContext; 11 | import org.springframework.context.event.ContextClosedEvent; 12 | import org.springframework.core.task.SyncTaskExecutor; 13 | 14 | import static org.assertj.core.api.Assertions.assertThatCode; 15 | import static org.mockito.Mockito.mock; 16 | import static org.mockito.Mockito.when; 17 | 18 | @RunWith(MockitoJUnitRunner.class) 19 | public class GracefulShutdownTomcatConnectorCustomizerTest { 20 | 21 | @Mock 22 | private ApplicationContext applicationContext; 23 | 24 | @InjectMocks 25 | private GracefulShutdownTomcatConnectorCustomizer customizer; 26 | 27 | @Test 28 | public void skipGracefulShutdownIfConnectorIsNull() { 29 | assertThatCode(() -> customizer.contextClosed(new ContextClosedEvent(applicationContext))) 30 | .doesNotThrowAnyException(); 31 | } 32 | 33 | @Test 34 | public void differentThreadPoolImplementation() { 35 | Connector mockConnector = configureConnectorToReturnDifferentThreadPoolImplementation(); 36 | 37 | customizer.customize(mockConnector); 38 | 39 | assertThatCode(() -> customizer.contextClosed(new ContextClosedEvent(applicationContext))) 40 | .doesNotThrowAnyException(); 41 | } 42 | 43 | private Connector configureConnectorToReturnDifferentThreadPoolImplementation() { 44 | Connector mockConnector = mock(Connector.class); 45 | ProtocolHandler mockProtocolHandler = mock(ProtocolHandler.class); 46 | 47 | when(mockConnector.getProtocolHandler()).thenReturn(mockProtocolHandler); 48 | when(mockProtocolHandler.getExecutor()).thenReturn(new SyncTaskExecutor()); 49 | 50 | return mockConnector; 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/test/java/com/github/timpeeters/boot/shutdown/autoconfigure/GracefulShutdownWithWaitIT.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.junit.Test; 4 | import org.springframework.http.HttpStatus; 5 | 6 | import java.util.Properties; 7 | import java.util.concurrent.ExecutionException; 8 | 9 | import static org.assertj.core.api.Assertions.assertThat; 10 | 11 | public class GracefulShutdownWithWaitIT extends AbstractIT { 12 | @Override 13 | protected void configure(Properties properties) { 14 | properties.setProperty("graceful.shutdown.enabled", "true"); 15 | properties.setProperty("graceful.shutdown.timeout", "0s"); 16 | properties.setProperty("graceful.shutdown.wait", "5s"); 17 | } 18 | 19 | @Test 20 | public void test() throws ExecutionException, InterruptedException { 21 | stopSpringBootApp(); 22 | 23 | Thread.sleep(2000); 24 | 25 | assertThat(sendRequest("/actuator/health").get().getStatusCode()) 26 | .isEqualTo(HttpStatus.SERVICE_UNAVAILABLE.value()); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/test/java/com/github/timpeeters/boot/shutdown/autoconfigure/NonGracefulShutdownIT.java: -------------------------------------------------------------------------------- 1 | package com.github.timpeeters.boot.shutdown.autoconfigure; 2 | 3 | import org.asynchttpclient.ListenableFuture; 4 | import org.asynchttpclient.Response; 5 | import org.junit.Test; 6 | 7 | import java.io.IOException; 8 | import java.util.Properties; 9 | 10 | import static org.assertj.core.api.Assertions.assertThatCode; 11 | 12 | public class NonGracefulShutdownIT extends AbstractIT { 13 | @Override 14 | protected void configure(Properties properties) { 15 | } 16 | 17 | @Test 18 | public void inFlightRequestFails() throws InterruptedException { 19 | ListenableFuture response = sendRequestAndWaitForServerToStartProcessing(); 20 | 21 | stopSpringBootApp(); 22 | 23 | assertThatCode(response::get).hasCauseInstanceOf(IOException.class); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/test/resources/logback-test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | --------------------------------------------------------------------------------