Package nl.knaw.dans.layerstore

Interface ArchiveProvider

All Known Implementing Classes:
DmfTarArchiveProvider, TarArchiveProvider, ZipArchiveProvider
public interface ArchiveProvider
Provides a way to create an Archive. The implementation should provide a way to configure where the archive is stored.

  • Method Summary

    Modifier and Type
    Method
    Description
    Archive
    createArchive(long layerId)
    Create a new Archive instance for the given layer ID.
    boolean
    exists(long layerId)
    Check if an archive exists at the given path.
    List<Long>
    listLayerIds()
    List all archived layer IDs.
    void
    validateRoot()
    Verifies that the archive root contains only valid archives.

  • Method Details

    • createArchive

      Archive createArchive(long layerId)
      Create a new Archive instance for the given layer ID.
      Parameters:
      layerId - the layer ID
      Returns:
      the new archive

    • exists

      boolean exists(long layerId)
      Check if an archive exists at the given path.
      Parameters:
      layerId - the layer ID
      Returns:
      true if the archive exists, false otherwise

    • listLayerIds

      List<Long> listLayerIds() throws IOException
      List all archived layer IDs.
      Returns:
      a list of layer IDs for which archives exist
      Throws:
      IOException

    • validateRoot

      void validateRoot() throws IOException
      Verifies that the archive root contains only valid archives.
      Throws:
      RuntimeException - if illegal files are found
      IOException