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

Interface VaultFileSystem

All Known Implementing Classes:

VaultFileSystemImpl

public interface VaultFileSystem

The file system containing a repository export. All passed paths are supposed to be in platform format (i.e. with file name escaping applied)

See Also:

PlatformNameFormat

Method Summary

Modifier and Type	Method	Description
AggregateManager	getAggregateManager()	Returns the attached artifacts manager.
VaultFsConfig	getConfig()	Returns the vault configuration that is used
VaultFile	getFile(String path)	Returns the file at the given path.
VaultFile	getFile(VaultFile parent, String path)	Returns the file at the given path.
VaultFile	getRoot()	Returns the root file
WorkspaceFilter	getWorkspaceFilter()	Returns the current workspace filter
void	invalidate()	Flushes the file cache
boolean	isMounted()	Checks if this tree is still mounted and if the attached session is still live.
VaultFsTransaction	startTransaction()	Starts a new transaction.
void	unmount()	Releases all resources attached to this Vault filesystem

Method Detail

unmount

void unmount()
      throws RepositoryException

Releases all resources attached to this Vault filesystem

Throws:

RepositoryException - if an error occurs.

isMounted

boolean isMounted()

Checks if this tree is still mounted and if the attached session is still live.

Returns:

true if still mounted

getRoot

VaultFile getRoot()

Returns the root file

Returns:

the root file

getAggregateManager

AggregateManager getAggregateManager()

Returns the attached artifacts manager.

Returns:

the attached artifacts manager.

getFile

VaultFile getFile(String path)
           throws IOException,
                  RepositoryException

Returns the file at the given path. If the file does not exists null is thrown.

Parameters:

path - the path of the file

Returns:

the file or null

Throws:

IOException - if an I/O error occurs.

RepositoryException - if a repository error occurs.

getFile

VaultFile getFile(VaultFile parent,
                  String path)
           throws IOException,
                  RepositoryException

Returns the file at the given path. The path can be relative and may contain ".." path elements. If the file does not exists null is returned.

Parameters:

parent - the parent file.

path - the path of the file

Returns:

the file or null

Throws:

IOException - if an I/O error occurs.

RepositoryException - if a repository error occurs.

startTransaction

VaultFsTransaction startTransaction()

Starts a new transaction.

Returns:

a new transaction.

invalidate

void invalidate()
         throws RepositoryException

Flushes the file cache

Throws:

RepositoryException - if an error occurs

getConfig

VaultFsConfig getConfig()

Returns the vault configuration that is used

Returns:

the vault configuration.

getWorkspaceFilter

WorkspaceFilter getWorkspaceFilter()

Returns the current workspace filter

Returns:

the workspace filter