GH-8691: Add (S)FTP, SMB aged file filters
Fixes https://github.com/spring-projects/spring-integration/issues/8691 * Remove setAge with TimeUnit Turned out we don't need anymore since we're using Duration for age in FtpLastModifiedFileListFilter and SftpLastModifiedFileListFilter. * Add changes to the docs * Introduce AbstractLastModifiedFileListFilter * Some code readability improvements * Make language in the docs more official
This commit is contained in:
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright 2023 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
|
||||
*
|
||||
* https://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.sftp.filters;
|
||||
|
||||
import java.nio.file.attribute.FileTime;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import org.apache.sshd.sftp.client.SftpClient;
|
||||
|
||||
import org.springframework.integration.file.filters.AbstractLastModifiedFileListFilter;
|
||||
|
||||
/**
|
||||
* The {@link AbstractLastModifiedFileListFilter} implementation to filter those files which
|
||||
* {@link FileTime#toInstant()} is less than the age in comparison with the {@link Instant#now()}.
|
||||
* When discardCallback {@link #addDiscardCallback(Consumer)} is provided, it called for all the rejected files.
|
||||
*
|
||||
* @author Adama Sorho
|
||||
* @author Artem Bilan
|
||||
*
|
||||
* @since 6.2
|
||||
*/
|
||||
public class SftpLastModifiedFileListFilter extends AbstractLastModifiedFileListFilter<SftpClient.DirEntry> {
|
||||
|
||||
public SftpLastModifiedFileListFilter() {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct a {@link SftpLastModifiedFileListFilter} instance with provided age.
|
||||
* Defaults to 60 seconds.
|
||||
* @param age the age in seconds.
|
||||
*/
|
||||
public SftpLastModifiedFileListFilter(long age) {
|
||||
this(Duration.ofSeconds(age));
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct a {@link SftpLastModifiedFileListFilter} instance with provided age.
|
||||
* Defaults to 60 seconds.
|
||||
* @param age the Duration
|
||||
*/
|
||||
public SftpLastModifiedFileListFilter(Duration age) {
|
||||
super(age);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Instant getLastModified(SftpClient.DirEntry remoteFile) {
|
||||
return remoteFile.getAttributes().getModifyTime().toInstant();
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
/*
|
||||
* Copyright 2023 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
|
||||
*
|
||||
* https://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.sftp.filters;
|
||||
|
||||
import java.nio.file.attribute.FileTime;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
|
||||
import org.apache.sshd.sftp.client.SftpClient;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* @author Adama Sorho
|
||||
* @author Artem Bilan
|
||||
*
|
||||
* @since 6.2
|
||||
*/
|
||||
public class SftpLastModifiedFileListFilterTests {
|
||||
|
||||
@Test
|
||||
public void testAge() {
|
||||
SftpLastModifiedFileListFilter filter = new SftpLastModifiedFileListFilter();
|
||||
SftpClient.Attributes attributes1 = new SftpClient.Attributes();
|
||||
attributes1.setModifyTime(FileTime.from(Instant.now()));
|
||||
SftpClient.Attributes attributes2 = new SftpClient.Attributes();
|
||||
attributes2.setModifyTime(FileTime.from(Instant.now()));
|
||||
|
||||
SftpClient.DirEntry sftpFile1 = new SftpClient.DirEntry("foo", "foo", attributes1);
|
||||
SftpClient.DirEntry sftpFile2 = new SftpClient.DirEntry("bar", "bar", attributes2);
|
||||
SftpClient.DirEntry[] files = new SftpClient.DirEntry[] {sftpFile1, sftpFile2};
|
||||
|
||||
assertThat(filter.filterFiles(files)).hasSize(0);
|
||||
assertThat(filter.accept(sftpFile2)).isFalse();
|
||||
|
||||
FileTime fileTime = FileTime.from(Instant.now().minus(Duration.ofDays(1)));
|
||||
sftpFile2.getAttributes().setModifyTime(fileTime);
|
||||
assertThat(filter.filterFiles(files)).hasSize(1);
|
||||
assertThat(filter.accept(sftpFile2)).isTrue();
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user