Package land.oras.utils

Class ArchiveUtils

java.lang.Object
land.oras.utils.ArchiveUtils
@NullMarked public final class ArchiveUtils extends Object
Archive utilities

  • Method Details

    • createTempTar

      public static Path createTempTar()
      Create a temporary archive when uploading directory layers
      Returns:
      The path to the archive

    • createTempZip

      public static Path createTempZip()
      Create a temporary zip file when uploading directory layers with zip media type
      Returns:
      The path to the zip file

    • createTempDir

      public static Path createTempDir()
      Create a temporary directory
      Returns:
      The path to the temporary directory

    • zip

      public static LocalPath zip(LocalPath sourceDir)
      Zip a local source dire and return a temporary zip file as a local path
      Parameters:
      sourceDir - The source directory
      Returns:
      The local path to the zip file

    • tar

      public static LocalPath tar(LocalPath sourceDir)
      Create a tar file from a directory, prefixing every entry with the source directory's own name.

      Equivalent to calling tar(sourceDir, true).

      Parameters:
      sourceDir - The source directory
      Returns:
      The local path to the temporary tar file

    • tar

      public static LocalPath tar(LocalPath sourceDir, boolean includeDirectoryName)
      Create a tar file from a directory.

      When includeDirectoryName is true (the default behaviour) every entry is prefixed with the source directory's own name, e.g. mydir/blobs/sha256/.... When false, entries are stored relative to the source directory itself, e.g. blobs/sha256/... — which is the format required by the OCI Image Layout specification when packaging a layout as a plain tar archive.

      Parameters:
      sourceDir - The source directory
      includeDirectoryName - true to prefix entries with the directory name, false for root-relative entry names
      Returns:
      The local path to the temporary tar file

    • tarcompress

      public static LocalPath tarcompress(LocalPath sourceDir, String mediaType)
      Create a tar compressed file from a directory
      Parameters:
      sourceDir - The source directory
      mediaType - The media type
      Returns:
      The path to the tar compressed file

    • untar

      public static void untar(Path path, Path target)
      Extract a tar file to a target directory
      Parameters:
      path - The tar file
      target - The target directory

    • uncompressuntar

      public static void uncompressuntar(Path path, Path target, String mediaType)
      Uncompress a compressed file and untar it to the target directory
      Parameters:
      path - The compressed file
      target - The target directory
      mediaType - The media type of the compressed file

    • uncompressuntar

      public static Path uncompressuntar(Path path, String mediaType)
      Uncompress a compressed file and untar to a temporary directory
      Parameters:
      path - The compressed file
      mediaType - The media type of the compressed file
      Returns:
      The path to the temporary directory

    • untar

      public static Path untar(Path path)
      Convienience method to extract a tar file to a temporary directory
      Parameters:
      path - The tar file
      Returns:
      The path to the temporary directory

    • unzip

      public static void unzip(Path path, Path target)
      Extract a zip file to a target directory
      Parameters:
      path - The zip file
      target - The target directory

    • untar

      public static void untar(InputStream fis, Path target)
      Extract a tar file to a target directory
      Parameters:
      fis - The archive stream
      target - The target directory

    • compress

      public static LocalPath compress(LocalPath path, String mediaType)
      Compress a tar file to a tar.gz or tar.zstd file depending on the requested media type
      Parameters:
      path - The tar file
      mediaType - The target media type
      Returns:
      The path to the tar.gz file or the tar.zstd file

    • uncompress

      public static LocalPath uncompress(InputStream is, String mediaType)
      Extract a compressed file from a tar.gz or tar.zstd file depending on the requested media type
      Parameters:
      is - The compressed input stream
      mediaType - The media type of the stream to select the uncompression method
      Returns:
      The path to the tar.gz file or the tar.zstd file