View Javadoc
1   /*
2    * This file is part of ***  M y C o R e  ***
3    * See http://www.mycore.de/ for details.
4    *
5    * MyCoRe is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * MyCoRe is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
17   */
18  
19  package org.mycore.frontend.fileupload;
20  
21  import java.io.IOException;
22  import java.nio.file.Path;
23  import java.util.function.Supplier;
24  
25  /**
26   * Modifies a uploaded file before it will be written to the destination Derivate.
27   */
28  public abstract class MCRPostUploadFileProcessor {
29  
30      /**
31       * Checks a file if it is processable.
32       * @param path to the temp file
33       * @return true if this {@link MCRPostUploadFileProcessor} can process this file
34       */
35      public abstract boolean isProcessable(String path);
36  
37      /**
38       *
39       * @param path the actual relative path in the derivate
40       * @param tempFileContent the actual path to the temporary file
41       * @param tempFileSupplier a supplier which creates a new temporary file which can be used for processing.
42       * @return the {@link Path} of the final file, which was provided by the tempFileSupplier
43       * @throws IOException if the processing failed
44       */
45      public abstract Path processFile(String path, Path tempFileContent, Supplier<Path> tempFileSupplier)
46          throws IOException;
47  }