Package org.apache.jackrabbit.vault.fs.api

Interface VaultFile

All Superinterfaces:
Dumpable
All Known Implementing Classes:
VaultFileImpl
public interface VaultFile extends Dumpable
Representation of a node serialization in VaultFileSystem. All paths used have the platform format, except if explicitly mentioned otherwise.
See Also:

  • Method Details

    • getPath

      String getPath()
      Returns the os path
      Returns:
      the os path.

    • getRepoRelPath

      String getRepoRelPath()
      Returns:
      the relative path of this artifact with respect to its parent node (repository format).

    • getAggregatePath

      String getAggregatePath()
      Returns:
      the repository path of the artifact's root (repository format).

    • getName

      String getName()
      Returns the name of this file.
      Returns:
      the name of this file.

    • getArtifact

      Artifact getArtifact()
      Returns the underlying artifact for this os file. If this file represents the Meta-Directory null is returned.
      Returns:
      the artifact or null.

    • isDirectory

      boolean isDirectory()
      Checks if this file is a directory.
      Returns:
      true if this file is a directory.

    • isTransient

      boolean isTransient()
      Checks if this file is transient. a file is transient if it's only used as hierarchical node for a deeper 'real' file. i.e.
      Returns:
      true if this file is transient

    • getParent

      VaultFile getParent() throws IOException, RepositoryException
      Returns the parent file or null if this is the root file.
      Returns:
      the parent file.
      Throws:
      IOException - if an I/O error occurs.
      RepositoryException - if a repository error occurs.

    • getAggregate

      Aggregate getAggregate()
      Returns the artifacts node of this file or null if it's transient
      Returns:
      the artifacts node

    • getControllingAggregate

      Aggregate getControllingAggregate()
      Returns the aggregate that controls this file.
      Returns:
      the artifacts node

    • getChild

      VaultFile getChild(String name) throws RepositoryException
      Returns the child with the given name or null
      Parameters:
      name - the name of the child
      Returns:
      the child or null
      Throws:
      RepositoryException - if an error occurs

    • getChildren

      Collection<? extends VaultFile> getChildren() throws RepositoryException
      Returns a collection of the children
      Returns:
      a collection of the children
      Throws:
      RepositoryException - if an error occurs

    • getRelated

      Collection<? extends VaultFile> getRelated() throws RepositoryException
      Returns the os file set for this file. The set contains those are the files that are generated from the same jcr file.
      Returns:
      the file set of related files
      Throws:
      RepositoryException - if an error occurs.

    • canRead

      boolean canRead()
      Checks if this file can be read from (eg. if it's not a directory)
      Returns:
      true if this file can be read from.

    • lastModified

      long lastModified()
      Returns the last modified date or 0 if not known.
      Returns:
      the last modified date or 0

    • length

      long length()
      Returns the length of the serialized data if it's known without doing the actual serialization.
      Returns:
      the length or -1 if the length cannot be determined.

    • getContentType

      String getContentType()
      Returns the content type of this file or null if the type cannot be determined or if it's a directory.
      Returns:
      the content type or null.

    • getFileSystem

      VaultFileSystem getFileSystem()
      Returns the underlying file system.
      Returns:
      the Vault filesystem

    • invalidate

      void invalidate() throws RepositoryException
      Throws:
      RepositoryException