INT-4155: Port FTP DSL
JIRA: https://jira.spring.io/browse/INT-4155 - Add streaming support - Rework tests to use dynamic flow registrations due to the test FTP server is now a test support class. Javadoc fixes Checkstyle fix Polishing - PR Comments Polishing and Port SFTP
This commit is contained in:
Gary Russell
committed by
Artem Bilan
Artem Bilan
parent
6c4d9b2111
commit
8070f72c44
@@ -0,0 +1,204 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.Comparator;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
|
||||
import org.springframework.integration.file.remote.AbstractFileInfo;
|
||||
import org.springframework.integration.file.remote.MessageSessionCallback;
|
||||
import org.springframework.integration.file.remote.RemoteFileTemplate;
|
||||
import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
|
||||
import org.springframework.integration.file.remote.session.SessionFactory;
|
||||
import org.springframework.integration.file.support.FileExistsMode;
|
||||
import org.springframework.integration.ftp.gateway.FtpOutboundGateway;
|
||||
import org.springframework.integration.ftp.session.FtpRemoteFileTemplate;
|
||||
|
||||
/**
|
||||
* The factory for FTP components.
|
||||
*
|
||||
* @author Artem Bilan
|
||||
* @author Gary Russell
|
||||
* @since 5.0
|
||||
*/
|
||||
public final class Ftp {
|
||||
|
||||
/**
|
||||
* A {@link FtpInboundChannelAdapterSpec} factory for an inbound channel adapter spec.
|
||||
* @param sessionFactory the session factory.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<FTPFile> sessionFactory) {
|
||||
return inboundAdapter(sessionFactory, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpInboundChannelAdapterSpec} factory for an inbound channel adapter spec.
|
||||
* @param sessionFactory the session factory.
|
||||
* @param receptionOrderComparator the comparator.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpInboundChannelAdapterSpec inboundAdapter(SessionFactory<FTPFile> sessionFactory,
|
||||
Comparator<File> receptionOrderComparator) {
|
||||
return new FtpInboundChannelAdapterSpec(sessionFactory, receptionOrderComparator);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpStreamingInboundChannelAdapterSpec} factory for an inbound channel
|
||||
* adapter spec.
|
||||
* @param remoteFileTemplate the remote file template.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(
|
||||
RemoteFileTemplate<FTPFile> remoteFileTemplate) {
|
||||
return inboundStreamingAdapter(remoteFileTemplate, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpStreamingInboundChannelAdapterSpec} factory for an inbound channel
|
||||
* adapter spec.
|
||||
* @param remoteFileTemplate the remote file template.
|
||||
* @param receptionOrderComparator the comparator.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpStreamingInboundChannelAdapterSpec inboundStreamingAdapter(
|
||||
RemoteFileTemplate<FTPFile> remoteFileTemplate,
|
||||
Comparator<AbstractFileInfo<FTPFile>> receptionOrderComparator) {
|
||||
return new FtpStreamingInboundChannelAdapterSpec(remoteFileTemplate, receptionOrderComparator);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
|
||||
* @param sessionFactory the session factory.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<FTPFile> sessionFactory) {
|
||||
return new FtpMessageHandlerSpec(sessionFactory);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
|
||||
* @param sessionFactory the session factory.
|
||||
* @param fileExistsMode the file exists mode.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpMessageHandlerSpec outboundAdapter(SessionFactory<FTPFile> sessionFactory,
|
||||
FileExistsMode fileExistsMode) {
|
||||
return outboundAdapter(new FtpRemoteFileTemplate(sessionFactory), fileExistsMode);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
|
||||
* @param remoteFileTemplate the remote file template.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpMessageHandlerSpec outboundAdapter(RemoteFileTemplate<FTPFile> remoteFileTemplate) {
|
||||
return new FtpMessageHandlerSpec(remoteFileTemplate);
|
||||
}
|
||||
|
||||
/**
|
||||
* A {@link FtpMessageHandlerSpec} factory for an outbound channel adapter spec.
|
||||
* @param remoteFileTemplate the remote file template.
|
||||
* @param fileExistsMode the file exists mode.
|
||||
* @return the spec.
|
||||
*/
|
||||
public static FtpMessageHandlerSpec outboundAdapter(RemoteFileTemplate<FTPFile> remoteFileTemplate,
|
||||
FileExistsMode fileExistsMode) {
|
||||
return new FtpMessageHandlerSpec(remoteFileTemplate, fileExistsMode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Produce a {@link FtpOutboundGatewaySpec} based on the {@link SessionFactory},
|
||||
* {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
|
||||
* remoteFilePath.
|
||||
* @param sessionFactory the {@link SessionFactory}.
|
||||
* @param command the command to perform on the FTP.
|
||||
* @param expression the remoteFilePath SpEL expression.
|
||||
* @return the {@link FtpOutboundGatewaySpec}
|
||||
*/
|
||||
public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory,
|
||||
AbstractRemoteFileOutboundGateway.Command command, String expression) {
|
||||
return outboundGateway(sessionFactory, command.getCommand(), expression);
|
||||
}
|
||||
|
||||
/**
|
||||
* Produce a {@link FtpOutboundGatewaySpec} based on the {@link SessionFactory},
|
||||
* {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
|
||||
* remoteFilePath.
|
||||
* @param sessionFactory the {@link SessionFactory}.
|
||||
* @param command the command to perform on the FTP.
|
||||
* @param expression the remoteFilePath SpEL expression.
|
||||
* @return the {@link FtpOutboundGatewaySpec}
|
||||
* @see RemoteFileTemplate
|
||||
*/
|
||||
public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory,
|
||||
String command, String expression) {
|
||||
return new FtpOutboundGatewaySpec(new FtpOutboundGateway(sessionFactory, command, expression));
|
||||
}
|
||||
|
||||
/**
|
||||
* Produce a {@link FtpOutboundGatewaySpec} based on the {@link RemoteFileTemplate},
|
||||
* {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
|
||||
* remoteFilePath.
|
||||
* @param remoteFileTemplate the {@link RemoteFileTemplate}.
|
||||
* @param command the command to perform on the FTP.
|
||||
* @param expression the remoteFilePath SpEL expression.
|
||||
* @return the {@link FtpOutboundGatewaySpec}
|
||||
* @see RemoteFileTemplate
|
||||
*/
|
||||
public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<FTPFile> remoteFileTemplate,
|
||||
AbstractRemoteFileOutboundGateway.Command command, String expression) {
|
||||
return outboundGateway(remoteFileTemplate, command.getCommand(), expression);
|
||||
}
|
||||
|
||||
/**
|
||||
* Produce a {@link FtpOutboundGatewaySpec} based on the {@link RemoteFileTemplate},
|
||||
* {@link AbstractRemoteFileOutboundGateway.Command} and {@code expression} for the
|
||||
* remoteFilePath.
|
||||
* @param remoteFileTemplate the {@link RemoteFileTemplate}.
|
||||
* @param command the command to perform on the FTP.
|
||||
* @param expression the remoteFilePath SpEL expression.
|
||||
* @return the {@link FtpOutboundGatewaySpec}
|
||||
* @see RemoteFileTemplate
|
||||
*/
|
||||
public static FtpOutboundGatewaySpec outboundGateway(RemoteFileTemplate<FTPFile> remoteFileTemplate,
|
||||
String command, String expression) {
|
||||
return new FtpOutboundGatewaySpec(new FtpOutboundGateway(remoteFileTemplate, command, expression));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Produce a {@link FtpOutboundGatewaySpec} based on the
|
||||
* {@link MessageSessionCallback}.
|
||||
* @param sessionFactory the {@link SessionFactory} to connect to.
|
||||
* @param messageSessionCallback the {@link MessageSessionCallback} to perform SFTP
|
||||
* operation(s) with the {@code Message} context.
|
||||
* @return the {@link FtpOutboundGatewaySpec}
|
||||
* @see MessageSessionCallback
|
||||
*/
|
||||
public static FtpOutboundGatewaySpec outboundGateway(SessionFactory<FTPFile> sessionFactory,
|
||||
MessageSessionCallback<FTPFile, ?> messageSessionCallback) {
|
||||
return new FtpOutboundGatewaySpec(new FtpOutboundGateway(sessionFactory, messageSessionCallback));
|
||||
}
|
||||
|
||||
private Ftp() {
|
||||
super();
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.Comparator;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
|
||||
import org.springframework.integration.file.dsl.RemoteFileInboundChannelAdapterSpec;
|
||||
import org.springframework.integration.file.remote.session.SessionFactory;
|
||||
import org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter;
|
||||
import org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter;
|
||||
import org.springframework.integration.ftp.inbound.FtpInboundFileSynchronizer;
|
||||
import org.springframework.integration.ftp.inbound.FtpInboundFileSynchronizingMessageSource;
|
||||
|
||||
/**
|
||||
* A {@link RemoteFileInboundChannelAdapterSpec} for a
|
||||
* {@link FtpInboundFileSynchronizingMessageSource}.
|
||||
*
|
||||
* @author Artem Bilan
|
||||
* @since 5.0
|
||||
*/
|
||||
public class FtpInboundChannelAdapterSpec
|
||||
extends RemoteFileInboundChannelAdapterSpec<FTPFile, FtpInboundChannelAdapterSpec,
|
||||
FtpInboundFileSynchronizingMessageSource> {
|
||||
|
||||
FtpInboundChannelAdapterSpec(SessionFactory<FTPFile> sessionFactory, Comparator<File> comparator) {
|
||||
super(new FtpInboundFileSynchronizer(sessionFactory));
|
||||
this.target = new FtpInboundFileSynchronizingMessageSource(this.synchronizer, comparator);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specify a simple pattern to match remote files.
|
||||
* @param pattern the pattern.
|
||||
* @see FtpSimplePatternFileListFilter
|
||||
* @see #filter(org.springframework.integration.file.filters.FileListFilter)
|
||||
*/
|
||||
@Override
|
||||
public FtpInboundChannelAdapterSpec patternFilter(String pattern) {
|
||||
return filter(new FtpSimplePatternFileListFilter(pattern));
|
||||
}
|
||||
|
||||
/**
|
||||
* Specify a regular expression to match remote files.
|
||||
* @param regex the expression.
|
||||
* @see FtpRegexPatternFileListFilter
|
||||
* @see #filter(org.springframework.integration.file.filters.FileListFilter)
|
||||
*/
|
||||
@Override
|
||||
public FtpInboundChannelAdapterSpec regexFilter(String regex) {
|
||||
return filter(new FtpRegexPatternFileListFilter(regex));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
|
||||
import org.springframework.integration.file.dsl.FileTransferringMessageHandlerSpec;
|
||||
import org.springframework.integration.file.remote.RemoteFileTemplate;
|
||||
import org.springframework.integration.file.remote.session.SessionFactory;
|
||||
import org.springframework.integration.file.support.FileExistsMode;
|
||||
|
||||
/**
|
||||
* A {@link FileTransferringMessageHandlerSpec} for FTP.
|
||||
*
|
||||
* @author Artem Bilan
|
||||
* @since 5.0
|
||||
*/
|
||||
public class FtpMessageHandlerSpec extends FileTransferringMessageHandlerSpec<FTPFile, FtpMessageHandlerSpec> {
|
||||
|
||||
FtpMessageHandlerSpec(SessionFactory<FTPFile> sessionFactory) {
|
||||
super(sessionFactory);
|
||||
}
|
||||
|
||||
FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate) {
|
||||
super(remoteFileTemplate);
|
||||
}
|
||||
|
||||
FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate, FileExistsMode fileExistsMode) {
|
||||
super(remoteFileTemplate, fileExistsMode);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
|
||||
import org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec;
|
||||
import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
|
||||
import org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter;
|
||||
import org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter;
|
||||
|
||||
/**
|
||||
* A {@link RemoteFileOutboundGatewaySpec} for FTP.
|
||||
*
|
||||
* @author Artem Bilan
|
||||
* @since 5.0
|
||||
*/
|
||||
public class FtpOutboundGatewaySpec extends RemoteFileOutboundGatewaySpec<FTPFile, FtpOutboundGatewaySpec> {
|
||||
|
||||
FtpOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<FTPFile> outboundGateway) {
|
||||
super(outboundGateway);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see FtpSimplePatternFileListFilter
|
||||
*/
|
||||
@Override
|
||||
public FtpOutboundGatewaySpec patternFileNameFilter(String pattern) {
|
||||
return filter(new FtpSimplePatternFileListFilter(pattern));
|
||||
}
|
||||
|
||||
/**
|
||||
* @see FtpRegexPatternFileListFilter
|
||||
*/
|
||||
@Override
|
||||
public FtpOutboundGatewaySpec regexFileNameFilter(String regex) {
|
||||
return filter(new FtpRegexPatternFileListFilter(regex));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import java.util.Comparator;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
|
||||
import org.springframework.integration.file.dsl.RemoteFileStreamingInboundChannelAdapterSpec;
|
||||
import org.springframework.integration.file.remote.AbstractFileInfo;
|
||||
import org.springframework.integration.file.remote.RemoteFileTemplate;
|
||||
import org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter;
|
||||
import org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter;
|
||||
import org.springframework.integration.ftp.inbound.FtpStreamingMessageSource;
|
||||
|
||||
/**
|
||||
* A {@link RemoteFileStreamingInboundChannelAdapterSpec} for a
|
||||
* {@link FtpStreamingMessageSource}.
|
||||
*
|
||||
* @author Gary Russell
|
||||
* @since 5.0
|
||||
*/
|
||||
public class FtpStreamingInboundChannelAdapterSpec
|
||||
extends RemoteFileStreamingInboundChannelAdapterSpec<FTPFile, FtpStreamingInboundChannelAdapterSpec,
|
||||
FtpStreamingMessageSource> {
|
||||
|
||||
FtpStreamingInboundChannelAdapterSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate,
|
||||
Comparator<AbstractFileInfo<FTPFile>> comparator) {
|
||||
this.target = new FtpStreamingMessageSource(remoteFileTemplate, comparator);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specify a simple pattern to match remote files (e.g. '*.txt').
|
||||
* @param pattern the pattern.
|
||||
* @see FtpSimplePatternFileListFilter
|
||||
* @see #filter(org.springframework.integration.file.filters.FileListFilter)
|
||||
*/
|
||||
@Override
|
||||
public FtpStreamingInboundChannelAdapterSpec patternFilter(String pattern) {
|
||||
return filter(new FtpSimplePatternFileListFilter(pattern));
|
||||
}
|
||||
|
||||
/**
|
||||
* Specify a regular expression to match remote files (e.g. '[0-9].*.txt').
|
||||
* @param regex the expression.
|
||||
* @see FtpRegexPatternFileListFilter
|
||||
* @see #filter(org.springframework.integration.file.filters.FileListFilter)
|
||||
*/
|
||||
@Override
|
||||
public FtpStreamingInboundChannelAdapterSpec regexFilter(String regex) {
|
||||
return filter(new FtpRegexPatternFileListFilter(regex));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* Provides FTP Components for the Java DSL.
|
||||
*/
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
@@ -16,7 +16,6 @@
|
||||
|
||||
package org.springframework.integration.ftp;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.Arrays;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
@@ -53,10 +52,6 @@ public class FtpTestSupport extends RemoteFileTestSupport {
|
||||
|
||||
private static volatile FtpServer server;
|
||||
|
||||
public String getTargetLocalDirectoryName() {
|
||||
return targetLocalDirectory.getAbsolutePath() + File.separator;
|
||||
}
|
||||
|
||||
@BeforeClass
|
||||
public static void createServer() throws Exception {
|
||||
FtpServerFactory serverFactory = new FtpServerFactory();
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.ftp.dsl;
|
||||
|
||||
import static org.hamcrest.Matchers.containsString;
|
||||
import static org.hamcrest.Matchers.instanceOf;
|
||||
import static org.hamcrest.Matchers.isOneOf;
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertThat;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.InputStream;
|
||||
import java.util.List;
|
||||
import java.util.regex.Matcher;
|
||||
|
||||
import org.apache.commons.net.ftp.FTPFile;
|
||||
import org.hamcrest.Matchers;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.integration.IntegrationMessageHeaderAccessor;
|
||||
import org.springframework.integration.channel.QueueChannel;
|
||||
import org.springframework.integration.config.EnableIntegration;
|
||||
import org.springframework.integration.dsl.IntegrationFlow;
|
||||
import org.springframework.integration.dsl.IntegrationFlows;
|
||||
import org.springframework.integration.dsl.Pollers;
|
||||
import org.springframework.integration.dsl.StandardIntegrationFlow;
|
||||
import org.springframework.integration.dsl.context.IntegrationFlowContext;
|
||||
import org.springframework.integration.dsl.context.IntegrationFlowRegistration;
|
||||
import org.springframework.integration.file.FileHeaders;
|
||||
import org.springframework.integration.file.remote.RemoteFileTemplate;
|
||||
import org.springframework.integration.file.remote.gateway.AbstractRemoteFileOutboundGateway;
|
||||
import org.springframework.integration.file.support.FileExistsMode;
|
||||
import org.springframework.integration.ftp.FtpTestSupport;
|
||||
import org.springframework.integration.ftp.session.FtpRemoteFileTemplate;
|
||||
import org.springframework.integration.support.MessageBuilder;
|
||||
import org.springframework.messaging.Message;
|
||||
import org.springframework.messaging.support.GenericMessage;
|
||||
import org.springframework.test.annotation.DirtiesContext;
|
||||
import org.springframework.test.context.junit4.SpringRunner;
|
||||
|
||||
/**
|
||||
* @author Artem Bilan
|
||||
* @author Gary Russell
|
||||
* @since 5.0
|
||||
*/
|
||||
@RunWith(SpringRunner.class)
|
||||
@DirtiesContext
|
||||
public class FtpTests extends FtpTestSupport {
|
||||
|
||||
@Autowired
|
||||
private IntegrationFlowContext flowContext;
|
||||
|
||||
@Test
|
||||
public void testFtpInboundFlow() {
|
||||
QueueChannel out = new QueueChannel();
|
||||
IntegrationFlow flow = IntegrationFlows.from(Ftp.inboundAdapter(sessionFactory())
|
||||
.preserveTimestamp(true)
|
||||
.remoteDirectory("ftpSource")
|
||||
.regexFilter(".*\\.txt$")
|
||||
.localFilename(f -> f.toUpperCase() + ".a")
|
||||
.localDirectory(getTargetLocalDirectory()),
|
||||
e -> e.id("ftpInboundAdapter").poller(Pollers.fixedDelay(100)))
|
||||
.channel(out)
|
||||
.get();
|
||||
IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
|
||||
Message<?> message = out.receive(10_000);
|
||||
assertNotNull(message);
|
||||
Object payload = message.getPayload();
|
||||
assertThat(payload, instanceOf(File.class));
|
||||
File file = (File) payload;
|
||||
assertThat(file.getName(), isOneOf(" FTPSOURCE1.TXT.a", "FTPSOURCE2.TXT.a"));
|
||||
assertThat(file.getAbsolutePath(), containsString("localTarget"));
|
||||
|
||||
message = out.receive(10_000);
|
||||
assertNotNull(message);
|
||||
file = (File) message.getPayload();
|
||||
assertThat(file.getName(), isOneOf(" FTPSOURCE1.TXT.a", "FTPSOURCE2.TXT.a"));
|
||||
assertThat(file.getAbsolutePath(), containsString("localTarget"));
|
||||
|
||||
registration.destroy();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFtpInboundStreamFlow() throws Exception {
|
||||
QueueChannel out = new QueueChannel();
|
||||
StandardIntegrationFlow flow = IntegrationFlows.from(
|
||||
Ftp.inboundStreamingAdapter(new FtpRemoteFileTemplate(sessionFactory()))
|
||||
.remoteDirectory("ftpSource")
|
||||
.regexFilter(".*\\.txt$"),
|
||||
e -> e.id("ftpInboundAdapter").poller(Pollers.fixedDelay(100)))
|
||||
.channel(out)
|
||||
.get();
|
||||
IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
|
||||
Message<?> message = out.receive(10_000);
|
||||
assertNotNull(message);
|
||||
assertThat(message.getPayload(), instanceOf(InputStream.class));
|
||||
assertThat(message.getHeaders().get(FileHeaders.REMOTE_FILE), isOneOf(" ftpSource1.txt", "ftpSource2.txt"));
|
||||
new IntegrationMessageHeaderAccessor(message).getCloseableResource().close();
|
||||
|
||||
message = out.receive(10_000);
|
||||
assertNotNull(message);
|
||||
assertThat(message.getPayload(), instanceOf(InputStream.class));
|
||||
assertThat(message.getHeaders().get(FileHeaders.REMOTE_FILE), isOneOf(" ftpSource1.txt", "ftpSource2.txt"));
|
||||
new IntegrationMessageHeaderAccessor(message).getCloseableResource().close();
|
||||
|
||||
registration.destroy();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testFtpOutboundFlow() {
|
||||
IntegrationFlow flow = f -> f
|
||||
.handle(Ftp.outboundAdapter(sessionFactory(), FileExistsMode.FAIL)
|
||||
.useTemporaryFileName(false)
|
||||
.fileNameExpression("headers['" + FileHeaders.FILENAME + "']")
|
||||
.remoteDirectory("ftpTarget"));
|
||||
IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
|
||||
String fileName = "foo.file";
|
||||
registration.getInputChannel().send(MessageBuilder.withPayload("foo")
|
||||
.setHeader(FileHeaders.FILENAME, fileName)
|
||||
.build());
|
||||
RemoteFileTemplate<FTPFile> template = new RemoteFileTemplate<>(sessionFactory());
|
||||
FTPFile[] files = template.execute(session ->
|
||||
session.list(getTargetRemoteDirectory().getName() + "/" + fileName));
|
||||
assertEquals(1, files.length);
|
||||
assertEquals(3, files[0].getSize());
|
||||
|
||||
registration.destroy();
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
public void testFtpMgetFlow() {
|
||||
QueueChannel out = new QueueChannel();
|
||||
IntegrationFlow flow = f -> f
|
||||
.handle(Ftp.outboundGateway(sessionFactory(),
|
||||
AbstractRemoteFileOutboundGateway.Command.MGET, "payload")
|
||||
.options(AbstractRemoteFileOutboundGateway.Option.RECURSIVE)
|
||||
.regexFileNameFilter("(subFtpSource|.*1.txt)")
|
||||
.localDirectoryExpression("'" + getTargetLocalDirectoryName() + "' + #remoteDirectory")
|
||||
.localFilenameExpression("#remoteFileName.replaceFirst('ftpSource', 'localTarget')"))
|
||||
.channel(out);
|
||||
IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
|
||||
String dir = "ftpSource/";
|
||||
registration.getInputChannel().send(new GenericMessage<>(dir + "*"));
|
||||
Message<?> result = out.receive(10_000);
|
||||
assertNotNull(result);
|
||||
List<File> localFiles = (List<File>) result.getPayload();
|
||||
// should have filtered ftpSource2.txt
|
||||
assertEquals(2, localFiles.size());
|
||||
|
||||
for (File file : localFiles) {
|
||||
assertThat(file.getPath().replaceAll(Matcher.quoteReplacement(File.separator), "/"),
|
||||
Matchers.containsString(dir));
|
||||
}
|
||||
assertThat(localFiles.get(1).getPath().replaceAll(Matcher.quoteReplacement(File.separator), "/"),
|
||||
Matchers.containsString(dir + "subFtpSource"));
|
||||
|
||||
registration.destroy();
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@EnableIntegration
|
||||
public static class ContextConfiguration {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user