Class JcrArchive

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Archive

    public class JcrArchive
    extends java.lang.Object
    Implements an archive that is based on nt:file/nt:folder nodes in a JCR repository.
    • Constructor Detail

      • JcrArchive

        public JcrArchive​(@NotNull
                          @NotNull Node archiveRoot,
                          @NotNull
                          @NotNull java.lang.String rootPath)
        Creates a new JCR archive rooted at the given node.
        Parameters:
        archiveRoot - root node for this archive
        rootPath - root path
    • Method Detail

      • open

        public void open​(boolean strict)
                  throws java.io.IOException
        Opens the archive.
        Parameters:
        strict - if true open will fail if there was an internal error while parsing meta data.
        Throws:
        java.io.IOException - if an error occurs
      • close

        public void close()
        Closes the archive. Only necessary to call if the archive has been opened.
      • getJcrRoot

        public Archive.Entry getJcrRoot()
        Returns the entry that specifies the "jcr_root". if no such entry exists, null is returned. Requires a previous call to Archive.open(boolean).
        Specified by:
        getJcrRoot in interface Archive
        Returns:
        the jcr_root entry or null
      • getRoot

        public Archive.Entry getRoot()
                              throws java.io.IOException
        Returns the root entry. Requires a previous call to Archive.open(boolean).
        Returns:
        the root entry.
        Throws:
        java.io.IOException - if an error occurs
      • getMetaInf

        public MetaInf getMetaInf()
        Returns the meta inf. If the archive provides no specific meta data, a default, empty meta inf is returned. Requires a previous call to Archive.open(boolean).
        Returns:
        the meta inf.
      • openInputStream

        public java.io.InputStream openInputStream​(Archive.Entry entry)
                                            throws java.io.IOException
        Opens an input stream for the given entry. Requires a previous call to Archive.open(boolean).
        Parameters:
        entry - the entry
        Returns:
        the input stream or null if the entry can't be read
        Throws:
        java.io.IOException - if an error occurs
      • getInputSource

        public VaultInputSource getInputSource​(Archive.Entry entry)
                                        throws java.io.IOException
        Returns an input source for the given entry. Requires a previous call to Archive.open(boolean).
        Parameters:
        entry - the entry
        Returns:
        the input source or null if the entry can't be read
        Throws:
        java.io.IOException - if an error occurs
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getEntry

        public Archive.Entry getEntry​(java.lang.String path)
                               throws java.io.IOException
        Description copied from interface: Archive
        Returns the entry specified by path. Requires a previous call to Archive.open(boolean).
        Specified by:
        getEntry in interface Archive
        Parameters:
        path - the path
        Returns:
        the entry or null if not found.
        Throws:
        java.io.IOException - if an error occurs
      • getSubArchive

        public Archive getSubArchive​(java.lang.String rootPath,
                                     boolean asJcrRoot)
                              throws java.io.IOException
        Description copied from interface: Archive
        Returns a sub archive that is rooted at the given path. Note that sub archives currently can't have their own meta inf and are closed automatically if their container archive is closed. Requires a previous call to Archive.open(boolean).
        Specified by:
        getSubArchive in interface Archive
        Parameters:
        rootPath - root path
        asJcrRoot - if true the given root is the jcr_root
        Returns:
        the archive or null if entry specified by root does not exist.
        Throws:
        java.io.IOException - if an error occurs