Package io.quarkus.paths

Class ArchivePathTree.OpenArchivePathTree

java.lang.Object
io.quarkus.paths.PathTreeWithManifest
io.quarkus.paths.OpenContainerPathTree
io.quarkus.paths.ArchivePathTree.OpenArchivePathTree
All Implemented Interfaces:
OpenPathTree, PathTree, Closeable, AutoCloseable
Enclosing class:
ArchivePathTree
protected class ArchivePathTree.OpenArchivePathTree extends OpenContainerPathTree
Thread-safe view of an open archive backed by a ReadOnlyZipFileSystem.

ReadOnlyZipFileSystem uses RandomAccessFile instead of FileChannel, making it immune to the JDK issue (JDK-8316882) where an interrupted thread closes the shared FileChannel (via InterruptibleChannel), breaking the entire filesystem for all other threads. Because RandomAccessFile is not interruptible, the thread's interrupt flag is naturally preserved without explicit clearing or restoring.

  • Constructor Details

    • OpenArchivePathTree

      protected OpenArchivePathTree(io.quarkus.fs.util.rozip.ReadOnlyZipFileSystem fs)

  • Method Details

    • isArchiveOrigin

      public boolean isArchiveOrigin()
      Description copied from interface: PathTree
      Whether the content of this tree comes from an archive or not.

      This is useful for instance when you want to determine if the resources can be updated in dev mode.

    • getContainerPath

      protected Path getContainerPath()
      Description copied from class: OpenContainerPathTree
      This is the path to the container.

      In the case of a zip archive, it's the path of the archive. In the case of a directory, it's the directory.

      Should only be used for equals/hashCode.

      Specified by:
      getContainerPath in class OpenContainerPathTree

    • getRootPath

      protected Path getRootPath()
      Description copied from class: OpenContainerPathTree
      This is the path to the container.

      In the case of a zip archive, it's the path to the root of the archive (i.e. a ZipPath). In the case of a directory, it's the directory.

      Should be used for any read operation on the container.

      Specified by:
      getRootPath in class OpenContainerPathTree

    • readLock

      protected ReentrantReadWriteLock.ReadLock readLock()

    • writeLock

      protected ReentrantReadWriteLock.WriteLock writeLock()

    • initManifest

      protected void initManifest(Manifest m)
      Overrides:
      initManifest in class PathTreeWithManifest

    • initMultiReleaseMapping

      protected void initMultiReleaseMapping(Map<String,String> mrMapping)
      Overrides:
      initMultiReleaseMapping in class PathTreeWithManifest

    • isOpen

      public boolean isOpen()

    • apply

      protected <T> T apply(String resourceName, Function<PathVisit,T> func, boolean manifestEnabled)
      Overrides:
      apply in class OpenContainerPathTree

    • accept

      public void accept(String resourceName, Consumer<PathVisit> consumer)
      Description copied from interface: PathTree
      Consumes a given resource from the tree. If the resource isn't found in the tree, the PathVisit argument passed to the consumer will be null.
      Specified by:
      accept in interface PathTree
      Overrides:
      accept in class OpenContainerPathTree
      Parameters:
      resourceName - resource to consume
      consumer - path consumer

    • walk

      public void walk(PathVisitor visitor)
      Description copied from interface: PathTree
      Walks the tree.

      This method will make sure the relevant multi release content is associated with the expected resource name paths for the current Java version.

      Specified by:
      walk in interface PathTree
      Overrides:
      walk in class OpenContainerPathTree
      Parameters:
      visitor - path visitor

    • walkRaw

      public void walkRaw(PathVisitor visitor)
      Description copied from interface: PathTree
      Walks the tree without remapping multi release content to the paths expected for the current Java version.
      Specified by:
      walkRaw in interface PathTree
      Overrides:
      walkRaw in class OpenContainerPathTree
      Parameters:
      visitor - path visitor

    • walkIfContains

      public void walkIfContains(String resourceDirName, PathVisitor visitor)
      Description copied from interface: PathTree
      Walks a subtree of resources in this tree that begins with a passed in resourceDirName. If this tree does not contain resource resourceDirName then the method returns without an error.

      This method does not create a new PathTree with the root at resourceDirName. It simply applies an inclusion filter to this PathTree instance, keeping the same root.

      Specified by:
      walkIfContains in interface PathTree
      Overrides:
      walkIfContains in class OpenContainerPathTree
      Parameters:
      resourceDirName - directory resource name starting from which the walk should begin
      visitor - path visitor

    • getResourceNames

      public Set<String> getResourceNames()
      Description copied from interface: PathTree
      Returns a set of resource names provided by this path tree. The set may include both directories and files.
      Returns:
      a set of resource names provided by this path tree

    • contains

      public boolean contains(String resourceName)
      Description copied from interface: PathTree
      Checks whether the tree contains a resource.
      Specified by:
      contains in interface PathTree
      Overrides:
      contains in class OpenContainerPathTree
      Parameters:
      resourceName - resource name to check
      Returns:
      true, in case the tree contains the path, otherwise - false

    • getPath

      public Path getPath(String resourceName)
      Specified by:
      getPath in interface OpenPathTree
      Overrides:
      getPath in class OpenContainerPathTree

    • close

      public void close() throws IOException
      Throws:
      IOException

    • getOriginalTree

      public PathTree getOriginalTree()

    • toString

      public String toString()
      Overrides:
      toString in class OpenContainerPathTree