Interface JobArchiver

  • All Known Implementing Classes:
    FileSystemJobArchiverImpl, S3JobArchiverImpl

    public interface JobArchiver
    Implementations of this interface should be able to a write job files to a WritableResource root location.
    Since:
    4.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean archiveDirectory​(java.nio.file.Path directory, java.util.List<java.io.File> filesList, java.net.URI target)
      Attempt to archive a directory located at directory to the target.
    • Method Detail

      • archiveDirectory

        boolean archiveDirectory​(java.nio.file.Path directory,
                                 java.util.List<java.io.File> filesList,
                                 java.net.URI target)
                          throws JobArchiveException
        Attempt to archive a directory located at directory to the target. All existing data "under" target should be assumed to be overwritten/replaced.
        Parameters:
        directory - The directory to archive
        filesList - The list of files to archive
        target - The root of a writable location to archive to.
        Returns:
        false if this implementation doesn't support archiving to target. true if does support archiving to target and the archival was successful
        Throws:
        JobArchiveException - If an exception happened during archival