Package org.apache.jackrabbit.vault.fs.io

Class JcrArchive

java.lang.Object

org.apache.jackrabbit.vault.fs.io.JcrArchive

All Implemented Interfaces:

Closeable, AutoCloseable, Archive

public class JcrArchive
extends Object

Implements an archive that is based on nt:file/nt:folder nodes in a JCR repository.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.vault.fs.io.Archive

Archive.Entry

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	PROPERTY_ENABLE_STACK_TRACES
protected static boolean	SHOULD_CREATE_STACK_TRACE	Determines whether stack traces should be created for each register call of CloseWatcher.

Constructor Summary

Constructors

Constructor	Description
JcrArchive(@NotNull Node archiveRoot, @NotNull String rootPath)	Creates a new JCR archive rooted at the given node.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the archive.
Archive.Entry	getEntry(String path)	Returns the entry specified by path.
VaultInputSource	getInputSource(Archive.Entry entry)	Returns an input source for the given entry.
Archive.Entry	getJcrRoot()	Returns the entry that specifies the "jcr_root".
MetaInf	getMetaInf()	Returns the meta inf.
Archive.Entry	getRoot()	Returns the root entry.
Archive	getSubArchive(String rootPath, boolean asJcrRoot)	Returns a sub archive that is rooted at the given path.
void	open(boolean strict)	Opens the archive.
InputStream	openInputStream(Archive.Entry entry)	Opens an input stream for the given entry.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_ENABLE_STACK_TRACES

protected static final String PROPERTY_ENABLE_STACK_TRACES

See Also:

Constant Field Values

SHOULD_CREATE_STACK_TRACE

protected static final boolean SHOULD_CREATE_STACK_TRACE

Determines whether stack traces should be created for each register call of CloseWatcher. This is false by default. Enable via system or OSGi framework property vault.enableStackTraces.

Constructor Detail

JcrArchive

public JcrArchive(@NotNull
                  @NotNull Node archiveRoot,
                  @NotNull
                  @NotNull 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 IOException

Opens the archive.

Parameters:

strict - if true open will fail if there was an internal error while parsing meta data.

Throws:

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 IOException

Returns the root entry. Requires a previous call to Archive.open(boolean).

Returns:

the root entry.

Throws:

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 InputStream openInputStream(Archive.Entry entry)
                            throws 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:

IOException - if an error occurs

getInputSource

public VaultInputSource getInputSource(Archive.Entry entry)
                                throws 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:

IOException - if an error occurs

toString

public String toString()

Overrides:

toString in class Object

getEntry

public Archive.Entry getEntry(String path)
                       throws 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:

IOException - if an error occurs

getSubArchive

public Archive getSubArchive(String rootPath,
                             boolean asJcrRoot)
                      throws 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:

IOException - if an error occurs