├── .gitignore ├── LICENSE.txt ├── README.md ├── images └── File_Poller.png ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── porterhead │ │ ├── Application.java │ │ └── integration │ │ ├── configuration │ │ └── ApplicationConfiguration.java │ │ ├── file │ │ ├── FilePollingConfiguration.java │ │ └── FilePollingIntegrationFlow.java │ │ └── writer │ │ └── MessageProcessingIntegrationFlow.java └── resources │ └── application.yml └── test ├── java └── com │ └── porterhead │ └── integration │ ├── TestUtils.java │ └── file │ └── FilePollingTest.java └── resources └── data └── foo.txt /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | inbound 3 | !.mvn/wrapper/maven-wrapper.jar 4 | .flattened-pom.xml 5 | 6 | ### STS ### 7 | .apt_generated 8 | .classpath 9 | .factorypath 10 | .project 11 | .settings 12 | .springBeans 13 | .mvn 14 | .DS* 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | nbproject/private/ 24 | build/ 25 | nbbuild/ 26 | dist/ 27 | nbdist/ 28 | .nb-gradle/ 29 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | A simple Spring Boot application that demonstrates how to set up File polling using the Spring Integration DSL and how to test it 2 | 3 | The application consists of an Integration flow that polls a directory for files that match a given regex expression. 4 | 5 | On finding a file it is transformed to a String and passed to a message handling flow that writes it out to another directory. 6 | 7 | The EIP Flow 8 | 9 | ![EIP diagram](images/File_Poller.png?raw=true) 10 | 11 | It can be used as an entry point to a bigger application. 12 | 13 | The tests show best practices for testing such a component. 14 | 15 | See blog post: [File Polling made easy with Spring Integration DSL](https://medium.com/@changeant/file-poller-with-spring-integration-dsl-ecb7bc996ba5) 16 | 17 | To build it: 18 | 19 | ```$code 20 | > mvn clean install 21 | ``` 22 | 23 | To run it: 24 | ```$code 25 | 26 | > mvn spring-boot:run 27 | ``` 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /images/File_Poller.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/iainporter/spring-file-poller/ca1ba76f545316e4cfff8c8b6ed1cab814952ba9/images/File_Poller.png -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 4.0.0 5 | 6 | com.porterhead 7 | spring-file-poller 8 | File Polling Service 9 | jar 10 | File Polling Service 11 | 1.0.1 12 | 13 | 14 | 15 | iainporter 16 | Iain Porter 17 | changeant@gmail.com 18 | 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-parent 24 | 2.6.3 25 | 26 | 27 | 28 | 3.8.0 29 | true 30 | 11 31 | 11 32 | UTF-8 33 | UTF-8 34 | 5.5.8 35 | 36 | 37 | 38 | 39 | 40 | org.springframework.integration 41 | spring-integration-file 42 | ${spring-integration-file.version} 43 | 44 | 45 | org.springframework.boot 46 | spring-boot-starter-integration 47 | 48 | 49 | 50 | org.springframework.boot 51 | spring-boot-starter-test 52 | test 53 | 54 | 55 | org.junit.jupiter 56 | junit-jupiter 57 | 58 | 59 | 60 | 61 | junit 62 | junit 63 | 4.13.2 64 | test 65 | 66 | 67 | 68 | 69 | 70 | org.springframework.boot 71 | spring-boot-maven-plugin 72 | 2.6.3 73 | 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /src/main/java/com/porterhead/Application.java: -------------------------------------------------------------------------------- 1 | package com.porterhead; 2 | 3 | 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | import org.springframework.boot.builder.SpringApplicationBuilder; 6 | 7 | /** 8 | * 9 | * @author Iain Porter 10 | */ 11 | @SpringBootApplication 12 | public class Application { 13 | 14 | public static void main(String[] args) { 15 | new SpringApplicationBuilder() 16 | .sources(Application.class) 17 | .run(args); 18 | } 19 | 20 | } 21 | 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /src/main/java/com/porterhead/integration/configuration/ApplicationConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration.configuration; 2 | 3 | import org.springframework.context.annotation.Bean; 4 | import org.springframework.context.annotation.Configuration; 5 | import org.springframework.integration.dsl.MessageChannels; 6 | import org.springframework.messaging.MessageChannel; 7 | 8 | /** 9 | * Global Channel definitions 10 | * 11 | * @author Iain Porter 12 | */ 13 | @Configuration 14 | public class ApplicationConfiguration { 15 | 16 | public static final String INBOUND_CHANNEL = "inbound-channel"; 17 | 18 | 19 | @Bean(name = INBOUND_CHANNEL) 20 | public MessageChannel inboundFilePollingChannel() { 21 | return MessageChannels.direct().get(); 22 | } 23 | 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/porterhead/integration/file/FilePollingConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration.file; 2 | 3 | import org.springframework.beans.factory.annotation.Value; 4 | import org.springframework.context.annotation.Bean; 5 | import org.springframework.context.annotation.Configuration; 6 | 7 | import java.io.File; 8 | 9 | /** 10 | * Set up Directories 11 | * 12 | * @author Iain Porter 13 | */ 14 | @Configuration 15 | public class FilePollingConfiguration { 16 | 17 | @Bean(name="inboundReadDirectory") 18 | public File inboundReadDirectory(@Value("${inbound.read.path}") String path) { 19 | return makeDirectory(path); 20 | } 21 | 22 | @Bean(name="inboundProcessedDirectory") 23 | public File inboundProcessedDirectory(@Value("${inbound.processed.path}") String path) { 24 | return makeDirectory(path); 25 | } 26 | 27 | @Bean(name="inboundFailedDirectory") 28 | public File inboundFailedDirectory(@Value("${inbound.failed.path}") String path) { 29 | return makeDirectory(path); 30 | } 31 | 32 | @Bean(name="inboundOutDirectory") 33 | public File inboundOutDirectory(@Value("${inbound.out.path}") String path) { 34 | return makeDirectory(path); 35 | } 36 | 37 | private File makeDirectory(String path) { 38 | File file = new File(path); 39 | file.mkdirs(); 40 | return file; 41 | } 42 | 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/com/porterhead/integration/file/FilePollingIntegrationFlow.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration.file; 2 | 3 | import com.porterhead.integration.configuration.ApplicationConfiguration; 4 | import org.springframework.beans.factory.annotation.Autowired; 5 | import org.springframework.beans.factory.annotation.Value; 6 | import org.springframework.context.ApplicationContext; 7 | import org.springframework.context.annotation.Bean; 8 | import org.springframework.context.annotation.Configuration; 9 | import org.springframework.core.task.TaskExecutor; 10 | import org.springframework.expression.ExpressionParser; 11 | import org.springframework.expression.spel.standard.SpelExpressionParser; 12 | import org.springframework.integration.core.MessageSource; 13 | import org.springframework.integration.dsl.IntegrationFlow; 14 | import org.springframework.integration.dsl.IntegrationFlows; 15 | import org.springframework.integration.dsl.Pollers; 16 | import org.springframework.integration.file.DirectoryScanner; 17 | import org.springframework.integration.file.FileReadingMessageSource; 18 | import org.springframework.integration.file.RecursiveDirectoryScanner; 19 | import org.springframework.integration.file.dsl.Files; 20 | import org.springframework.integration.file.filters.AcceptOnceFileListFilter; 21 | import org.springframework.integration.file.filters.CompositeFileListFilter; 22 | import org.springframework.integration.file.filters.RegexPatternFileListFilter; 23 | import org.springframework.integration.transaction.DefaultTransactionSynchronizationFactory; 24 | import org.springframework.integration.transaction.ExpressionEvaluatingTransactionSynchronizationProcessor; 25 | import org.springframework.integration.transaction.PseudoTransactionManager; 26 | import org.springframework.integration.transaction.TransactionSynchronizationFactory; 27 | import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; 28 | 29 | import java.io.File; 30 | import java.util.Arrays; 31 | 32 | /** 33 | * Inbound File Adapter looks for files that match the given regular expression 34 | * Any files that have already been processed with the same name within the same 35 | * JVM session will be ignored 36 | * The poller is transactional and will move the file to a processed directory on successful 37 | * downstream processing. If there is an exception in processing the file will be moved to a 38 | * failed directory 39 | * 40 | * @author Iain Porter 41 | */ 42 | @Configuration 43 | class FilePollingIntegrationFlow { 44 | 45 | @Autowired 46 | public File inboundReadDirectory; 47 | 48 | @Autowired 49 | private ApplicationContext applicationContext; 50 | 51 | @Bean 52 | public IntegrationFlow inboundFileIntegration(@Value("${inbound.file.poller.fixed.delay}") long period, 53 | @Value("${inbound.file.poller.max.messages.per.poll}") int maxMessagesPerPoll, 54 | TaskExecutor taskExecutor, 55 | MessageSource fileReadingMessageSource) { 56 | return IntegrationFlows.from(fileReadingMessageSource, 57 | c -> c.poller(Pollers.fixedDelay(period) 58 | .taskExecutor(taskExecutor) 59 | .maxMessagesPerPoll(maxMessagesPerPoll) 60 | .transactionSynchronizationFactory(transactionSynchronizationFactory()) 61 | .transactional(new PseudoTransactionManager()))) 62 | .transform(Files.toStringTransformer()) 63 | .channel(ApplicationConfiguration.INBOUND_CHANNEL) 64 | .get(); 65 | } 66 | 67 | @Bean 68 | TaskExecutor taskExecutor(@Value("${inbound.file.poller.thread.pool.size}") int poolSize) { 69 | ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor(); 70 | taskExecutor.setCorePoolSize(poolSize); 71 | return taskExecutor; 72 | } 73 | 74 | 75 | @Bean 76 | TransactionSynchronizationFactory transactionSynchronizationFactory() { 77 | ExpressionParser parser = new SpelExpressionParser(); 78 | ExpressionEvaluatingTransactionSynchronizationProcessor syncProcessor = 79 | new ExpressionEvaluatingTransactionSynchronizationProcessor(); 80 | syncProcessor.setBeanFactory(applicationContext.getAutowireCapableBeanFactory()); 81 | syncProcessor.setAfterCommitExpression(parser.parseExpression("payload.renameTo(new java.io.File(@inboundProcessedDirectory.path " + 82 | " + T(java.io.File).separator + payload.name))")); 83 | syncProcessor.setAfterRollbackExpression(parser.parseExpression("payload.renameTo(new java.io.File(@inboundFailedDirectory.path " + 84 | " + T(java.io.File).separator + payload.name))")); 85 | return new DefaultTransactionSynchronizationFactory(syncProcessor); 86 | } 87 | 88 | @Bean 89 | public FileReadingMessageSource fileReadingMessageSource(DirectoryScanner directoryScanner) { 90 | FileReadingMessageSource source = new FileReadingMessageSource(); 91 | source.setDirectory(this.inboundReadDirectory); 92 | source.setScanner(directoryScanner); 93 | source.setAutoCreateDirectory(true); 94 | return source; 95 | } 96 | 97 | @Bean 98 | public DirectoryScanner directoryScanner(@Value("${inbound.filename.regex}") String regex) { 99 | DirectoryScanner scanner = new RecursiveDirectoryScanner(); 100 | CompositeFileListFilter filter = new CompositeFileListFilter<>( 101 | Arrays.asList(new AcceptOnceFileListFilter<>(), 102 | new RegexPatternFileListFilter(regex)) 103 | ); 104 | scanner.setFilter(filter); 105 | return scanner; 106 | } 107 | 108 | 109 | } 110 | -------------------------------------------------------------------------------- /src/main/java/com/porterhead/integration/writer/MessageProcessingIntegrationFlow.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration.writer; 2 | 3 | 4 | import com.porterhead.integration.configuration.ApplicationConfiguration; 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.beans.factory.annotation.Qualifier; 7 | import org.springframework.beans.factory.annotation.Value; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.integration.dsl.IntegrationFlow; 10 | import org.springframework.integration.dsl.IntegrationFlows; 11 | import org.springframework.integration.file.FileNameGenerator; 12 | import org.springframework.integration.file.FileWritingMessageHandler; 13 | import org.springframework.integration.handler.LoggingHandler; 14 | import org.springframework.messaging.MessageHandler; 15 | import org.springframework.stereotype.Component; 16 | 17 | import java.io.File; 18 | import java.time.LocalDateTime; 19 | import java.time.format.DateTimeFormatter; 20 | 21 | @Component 22 | public class MessageProcessingIntegrationFlow { 23 | 24 | public static final String OUTBOUND_FILENAME_GENERATOR = "outboundFilenameGenerator"; 25 | public static final String FILE_WRITING_MESSAGE_HANDLER = "fileWritingMessageHandler"; 26 | @Autowired 27 | public File inboundOutDirectory; 28 | 29 | 30 | /** 31 | * Reverse the contents of the string and write it out using a filename generator to name the file 32 | * 33 | * @param fileWritingMessageHandler 34 | * @return 35 | */ 36 | @Bean 37 | public IntegrationFlow writeToFile(@Qualifier("fileWritingMessageHandler") MessageHandler fileWritingMessageHandler) { 38 | return IntegrationFlows.from(ApplicationConfiguration.INBOUND_CHANNEL) 39 | .transform(m -> new StringBuilder((String)m).reverse().toString()) 40 | .handle(fileWritingMessageHandler) 41 | .log(LoggingHandler.Level.INFO) 42 | .get(); 43 | } 44 | 45 | 46 | @Bean (name = FILE_WRITING_MESSAGE_HANDLER) 47 | public MessageHandler fileWritingMessageHandler(@Qualifier(OUTBOUND_FILENAME_GENERATOR) FileNameGenerator fileNameGenerator) { 48 | FileWritingMessageHandler handler = new FileWritingMessageHandler(inboundOutDirectory); 49 | handler.setAutoCreateDirectory(true); 50 | handler.setFileNameGenerator(fileNameGenerator); 51 | return handler; 52 | } 53 | 54 | @Bean(name = OUTBOUND_FILENAME_GENERATOR) 55 | public FileNameGenerator outboundFileName(@Value("${out.filename.dateFormat}") String dateFormat, @Value("${out.filename.suffix}") String filenameSuffix) { 56 | return message -> DateTimeFormatter.ofPattern(dateFormat).format(LocalDateTime.now()) + filenameSuffix; 57 | } 58 | 59 | } 60 | -------------------------------------------------------------------------------- /src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | inbound: 2 | failed: 3 | path: inbound/failed 4 | file: 5 | poller: 6 | fixed: 7 | delay: 1000 8 | max: 9 | messages: 10 | per: 11 | poll: 5 12 | thread: 13 | pool: 14 | size: 4 15 | filename: 16 | regex: ([^\s]+(\.(?i)(txt))$) 17 | out: 18 | path: inbound/out 19 | processed: 20 | path: inbound/processed 21 | read: 22 | path: inbound/read 23 | out: 24 | filename: 25 | dateFormat: yyyy_MM_dd_HH_mm_ss_SSS 26 | suffix: .txt 27 | -------------------------------------------------------------------------------- /src/test/java/com/porterhead/integration/TestUtils.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration; 2 | 3 | 4 | import org.springframework.core.io.ClassPathResource; 5 | 6 | import java.io.File; 7 | import java.io.FileNotFoundException; 8 | import java.io.IOException; 9 | 10 | import static org.hamcrest.CoreMatchers.is; 11 | import static org.junit.Assert.assertThat; 12 | 13 | public class TestUtils { 14 | 15 | public final static String FILE_FIXTURE_PATH = "/data/foo.txt"; 16 | 17 | public final static String FILE_FIXTURE_NAME = "foo.txt"; 18 | 19 | public static File locateClasspathResource(String resourceName) { 20 | try { 21 | return new ClassPathResource(resourceName).getFile(); 22 | } catch (IOException e) { 23 | throw new RuntimeException(e); 24 | } 25 | } 26 | 27 | public static void assertThatDirectoryHasFiles(File directory, int expectedFileCount) throws Exception { 28 | int count = 0; 29 | while (directory.listFiles().length < expectedFileCount && count++ < 10) { 30 | Thread.sleep(500); 31 | } 32 | assertThat(directory.listFiles().length, is(expectedFileCount)); 33 | } 34 | 35 | public static void assertThatDirectoryIsEmpty(File directory) throws Exception { 36 | int count = 0; 37 | while (directory.listFiles().length > 0 && count++ < 10) { 38 | Thread.sleep(500); 39 | } 40 | assertThat(directory.listFiles().length, is(0)); 41 | } 42 | 43 | public static boolean deleteRecursive(File path) throws FileNotFoundException{ 44 | if (!path.exists()) throw new FileNotFoundException(path.getAbsolutePath()); 45 | boolean ret = true; 46 | if (path.isDirectory()){ 47 | for (File f : path.listFiles()){ 48 | ret = ret && deleteRecursive(f); 49 | } 50 | } 51 | return ret && path.delete(); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/test/java/com/porterhead/integration/file/FilePollingTest.java: -------------------------------------------------------------------------------- 1 | package com.porterhead.integration.file; 2 | 3 | 4 | import com.porterhead.integration.TestUtils; 5 | import com.porterhead.integration.configuration.ApplicationConfiguration; 6 | import org.junit.After; 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | import org.springframework.beans.factory.annotation.Autowired; 10 | import org.springframework.beans.factory.annotation.Qualifier; 11 | import org.springframework.boot.test.context.SpringBootTest; 12 | import org.springframework.integration.channel.DirectChannel; 13 | import org.springframework.messaging.Message; 14 | import org.springframework.messaging.MessageChannel; 15 | import org.springframework.messaging.support.ChannelInterceptor; 16 | import org.springframework.test.annotation.DirtiesContext; 17 | import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 18 | 19 | import java.io.File; 20 | import java.util.concurrent.CountDownLatch; 21 | import java.util.concurrent.TimeUnit; 22 | 23 | import static com.porterhead.integration.TestUtils.assertThatDirectoryHasFiles; 24 | import static com.porterhead.integration.TestUtils.assertThatDirectoryIsEmpty; 25 | import static org.hamcrest.CoreMatchers.is; 26 | import static org.hamcrest.MatcherAssert.assertThat; 27 | import static org.springframework.util.FileCopyUtils.copy; 28 | 29 | @RunWith(SpringJUnit4ClassRunner.class) 30 | @SpringBootTest 31 | @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) 32 | public class FilePollingTest { 33 | 34 | @Autowired 35 | @Qualifier("inboundReadDirectory") 36 | public File inboundReadDirectory; 37 | 38 | @Autowired 39 | @Qualifier("inboundProcessedDirectory") 40 | public File inboundProcessedDirectory; 41 | 42 | @Autowired 43 | @Qualifier("inboundFailedDirectory") 44 | public File inboundFailedDirectory; 45 | 46 | @Autowired 47 | @Qualifier("inboundOutDirectory") 48 | public File inboundOutDirectory; 49 | 50 | @After 51 | public void tearDown() throws Exception { 52 | TestUtils.deleteRecursive(inboundReadDirectory); 53 | TestUtils.deleteRecursive(inboundProcessedDirectory); 54 | TestUtils.deleteRecursive(inboundFailedDirectory); 55 | TestUtils.deleteRecursive(inboundOutDirectory); 56 | } 57 | 58 | @Autowired 59 | @Qualifier(ApplicationConfiguration.INBOUND_CHANNEL) 60 | public DirectChannel filePollingChannel; 61 | 62 | @Test 63 | public void pollFindsValidFile() throws Exception { 64 | final CountDownLatch latch = new CountDownLatch(1); 65 | filePollingChannel.addInterceptor(new ChannelInterceptor() { 66 | @Override 67 | public void postSend(Message message, MessageChannel channel, boolean sent) { 68 | latch.countDown(); 69 | } 70 | }); 71 | copy(TestUtils.locateClasspathResource(TestUtils.FILE_FIXTURE_PATH), new File(inboundReadDirectory, TestUtils.FILE_FIXTURE_NAME )); 72 | assertThat(latch.await(5, TimeUnit.SECONDS), is(true)); 73 | assertThatDirectoryIsEmpty(inboundReadDirectory); 74 | assertThatDirectoryIsEmpty(inboundFailedDirectory); 75 | assertThatDirectoryHasFiles(inboundOutDirectory, 1); 76 | assertThatDirectoryHasFiles(inboundProcessedDirectory, 1); 77 | } 78 | 79 | @Test 80 | public void pollIgnoresInvalidFile() throws Exception { 81 | copy(TestUtils.locateClasspathResource(TestUtils.FILE_FIXTURE_PATH), new File(inboundReadDirectory, TestUtils.FILE_FIXTURE_NAME + ".tmp" )); 82 | Thread.sleep(2000); //enough time to ensure the file has been read and ignored before the test finishes 83 | assertThatDirectoryIsEmpty(inboundProcessedDirectory); 84 | assertThatDirectoryIsEmpty(inboundFailedDirectory); 85 | assertThatDirectoryIsEmpty(inboundOutDirectory); 86 | assertThatDirectoryHasFiles(inboundReadDirectory, 1); 87 | } 88 | 89 | @Test 90 | public void pollIgnoresFileAlreadySeen() throws Exception { 91 | final CountDownLatch stopLatch = new CountDownLatch(1); 92 | filePollingChannel.addInterceptor(new ChannelInterceptor() { 93 | @Override 94 | public void postSend(Message message, MessageChannel channel, boolean sent) { 95 | stopLatch.countDown(); 96 | } 97 | }); 98 | copy(TestUtils.locateClasspathResource(TestUtils.FILE_FIXTURE_PATH), new File(inboundReadDirectory, TestUtils.FILE_FIXTURE_NAME )); 99 | //wait for stopLatch before asserting 100 | assertThat(stopLatch.await(5, TimeUnit.SECONDS), is(true)); 101 | assertThatDirectoryHasFiles(inboundProcessedDirectory, 1); 102 | assertThatDirectoryHasFiles(inboundOutDirectory, 1); 103 | assertThatDirectoryIsEmpty(inboundReadDirectory); 104 | assertThatDirectoryIsEmpty(inboundFailedDirectory); 105 | copy(TestUtils.locateClasspathResource(TestUtils.FILE_FIXTURE_PATH), new File(inboundReadDirectory, TestUtils.FILE_FIXTURE_NAME )); 106 | Thread.sleep(2000); //wait longer than the polling period 107 | assertThatDirectoryIsEmpty(inboundFailedDirectory); 108 | assertThatDirectoryHasFiles(inboundReadDirectory, 1); 109 | assertThatDirectoryHasFiles(inboundProcessedDirectory, 1); 110 | assertThatDirectoryHasFiles(inboundOutDirectory, 1); 111 | } 112 | 113 | @Test 114 | public void rollbackMovesFileToFailed() throws Exception { 115 | final CountDownLatch stopLatch = new CountDownLatch(1); 116 | filePollingChannel.addInterceptor(new ChannelInterceptor() { 117 | @Override 118 | public Message preSend(Message message, MessageChannel channel) { 119 | stopLatch.countDown(); 120 | throw new RuntimeException("Forcing an Exception to trigger rollback"); 121 | } 122 | }); 123 | copy(TestUtils.locateClasspathResource(TestUtils.FILE_FIXTURE_PATH), new File(inboundReadDirectory, TestUtils.FILE_FIXTURE_NAME )); 124 | assertThat(stopLatch.await(5, TimeUnit.SECONDS), is(true)); 125 | assertThatDirectoryIsEmpty(inboundReadDirectory); 126 | assertThatDirectoryIsEmpty(inboundProcessedDirectory); 127 | assertThatDirectoryIsEmpty(inboundOutDirectory); 128 | assertThatDirectoryHasFiles(inboundFailedDirectory, 1); 129 | } 130 | 131 | } 132 | -------------------------------------------------------------------------------- /src/test/resources/data/foo.txt: -------------------------------------------------------------------------------- 1 | This is a file that is going to be read in by a file polling process --------------------------------------------------------------------------------