-
Notifications
You must be signed in to change notification settings - Fork 1
/
IScanPlugin.java
50 lines (46 loc) · 1.9 KB
/
IScanPlugin.java
1
2
3
4
5
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
/*
* Copyright 2017-2022 CNES - CENTRE NATIONAL d'ETUDES SPATIALES
*
* This file is part of REGARDS.
*
* REGARDS is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* REGARDS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with REGARDS. If not, see <http://www.gnu.org/licenses/>.
*/
package fr.cnes.regards.modules.acquisition.plugins;
import fr.cnes.regards.framework.modules.plugins.annotations.PluginInterface;
import java.nio.file.Path;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Optional;
/**
* First <b>required</b> step of acquisition processing chain. This step is used to make disk scanning for file
* detection.
*
* @author Marc Sordi
* @author Iliana Ghazali
*/
@PluginInterface(description = "File scanning plugin contract")
public interface IScanPlugin {
/**
* Scan disk to detect and retrieve files.<br/>
* Warning : if last modification date is not used, file might be acquired several times!<br/>
* <b>When using last modification date, we assume scan plugin is working with a precision to the second at least.
* Plugin has to return files with last modification date equals or after the given last modification date.
* The system will filter duplicates if any!</b>
*
* @param dirPath directory to scan
* @param scanningDate last scanning date of the directory
* @return list of detected files
*/
List<Path> scan(Path dirPath, Optional<OffsetDateTime> scanningDate);
}