GH-9869: Introduce AbstractRecentFileListFilter strategy

Fixes: https://github.com/spring-projects/spring-integration/issues/9869

Currently, FileListFilters on the last modified attribute of a file are limited to the use case of discarding files that are too young.
It would be great to have a filter implementation which would accept files which are not old enough.

* Implement `AbstractRecentFileListFilter` for all the supported file protocols
This commit is contained in:
Artem Bilan
2025-02-27 10:59:20 -05:00
parent 7680e02cbb
commit 8bfb5d248f
14 changed files with 517 additions and 2 deletions

View File

@@ -0,0 +1,81 @@
/*
* Copyright 2025 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.file.filters;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
/**
* The {@link FileListFilter} to accept only files which are recent according to provided {@code age}:
* the {@code lastModified} of the file is more than the age in comparison with the current time.
* In other words, accept those files which are not old enough yet.
*
* @param <F> The type that will be filtered.
*
* @author Artem Bilan
*
* @since 6.5
*/
public abstract class AbstractRecentFileListFilter<F> implements FileListFilter<F> {
protected static final long ONE_SECOND = 1000;
private final Duration age;
/**
* Construct an instance with default age as 1 day.
*/
public AbstractRecentFileListFilter() {
this(Duration.ofDays(1));
}
public AbstractRecentFileListFilter(Duration age) {
this.age = age;
}
@Override
public boolean supportsSingleFileFiltering() {
return true;
}
@Override
public List<F> filterFiles(F[] files) {
List<F> list = new ArrayList<>();
Instant now = Instant.now();
for (F file : files) {
if (!fileIsAged(file, now)) {
list.add(file);
}
}
return list;
}
@Override
public boolean accept(F file) {
return !fileIsAged(file, Instant.now());
}
protected boolean fileIsAged(F file, Instant now) {
return getLastModified(file).plus(this.age).isBefore(now);
}
protected abstract Instant getLastModified(F remoteFile);
}

View File

@@ -0,0 +1,44 @@
/*
* Copyright 2025 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.file.filters;
import java.io.File;
import java.time.Duration;
import java.time.Instant;
/**
* The {@link AbstractRecentFileListFilter} implementation for local file system.
*
* @author Artem Bilan
*
* @since 6.5
*/
public class RecentFileListFilter extends AbstractRecentFileListFilter<File> {
public RecentFileListFilter() {
}
public RecentFileListFilter(Duration age) {
super(age);
}
@Override
protected Instant getLastModified(File file) {
return Instant.ofEpochSecond(file.lastModified() / ONE_SECOND);
}
}

View File

@@ -0,0 +1,56 @@
/*
* Copyright 2025 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.file.filters;
import java.io.File;
import java.io.FileOutputStream;
import java.time.Duration;
import java.time.Instant;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import static org.assertj.core.api.Assertions.assertThat;
/**
* @author Artem Bilan
*
* @since 6.5
*
*/
public class RecentFileListFilterTests {
@TempDir
public File folder;
@Test
public void testAge() throws Exception {
RecentFileListFilter filter = new RecentFileListFilter(Duration.ofHours(20));
File testFile = new File(folder, "test.tmp");
FileOutputStream fileOutputStream = new FileOutputStream(testFile);
fileOutputStream.write("x".getBytes());
fileOutputStream.close();
assertThat(filter.filterFiles(new File[] {testFile})).hasSize(1);
assertThat(filter.accept(testFile)).isTrue();
testFile.setLastModified(Instant.now().minus(Duration.ofDays(1)).toEpochMilli());
assertThat(filter.filterFiles(new File[] {testFile})).hasSize(0);
assertThat(filter.accept(testFile)).isFalse();
}
}