org.apache.jackrabbit.oak.segment.file

Class ReadOnlyFileStore

java.lang.Object

org.apache.jackrabbit.oak.segment.file.AbstractFileStore

org.apache.jackrabbit.oak.segment.file.ReadOnlyFileStore

All Implemented Interfaces:

Closeable, AutoCloseable, SegmentStore

public class ReadOnlyFileStore
extends AbstractFileStore

A read only AbstractFileStore implementation that supports going back to old revisions.

All write methods are no-ops.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	containsSegment(SegmentId id) Checks whether the identified segment exists in this store.
ReadOnlyRevisions	getRevisions()
Iterable<SegmentId>	getSegmentIds()
Map<UUID,List<UUID>>	getTarGraph(String fileName)
Map<String,Set<UUID>>	getTarReaderIndex()
SegmentWriter	getWriter()
Segment	readSegment(SegmentId id) Reads the identified segment from this store.
void	setRevision(String revision) Go to the specified revision
void	traverseSegmentGraph(Set<UUID> roots, SegmentGraph.SegmentGraphVisitor visitor) Build the graph of segments reachable from an initial set of segments
void	writeSegment(SegmentId id, byte[] data, int offset, int length) Writes the given segment to the segment store.

Methods inherited from class org.apache.jackrabbit.oak.segment.file.AbstractFileStore

getBlobStore, getHead, getReader, getSegmentCacheStats, getStringCacheStats, getTemplateCacheStats, getTracker, newBulkSegmentId, newDataSegmentId, newSegmentId

Methods inherited from class java.lang.Object

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

Method Detail

setRevision

public void setRevision(String revision)

Go to the specified revision

Parameters:

revision -

traverseSegmentGraph

public void traverseSegmentGraph(@Nonnull
                                 Set<UUID> roots,
                                 @Nonnull
                                 SegmentGraph.SegmentGraphVisitor visitor)
                          throws IOException

Build the graph of segments reachable from an initial set of segments

Parameters:

roots - the initial set of segments

visitor - visitor receiving call back while following the segment graph

Throws:

IOException

writeSegment

public void writeSegment(SegmentId id,
                         byte[] data,
                         int offset,
                         int length)

Description copied from interface: SegmentStore

Writes the given segment to the segment store.

Parameters:

id - segment identifier

data - byte buffer that contains the raw contents of the segment

offset - start offset within the byte buffer

length - length of the segment

containsSegment

public boolean containsSegment(SegmentId id)

Description copied from interface: SegmentStore

Checks whether the identified segment exists in this store.

Parameters:

id - segment identifier

Returns:

true if the segment exists, false otherwise

readSegment

@Nonnull
public Segment readSegment(SegmentId id)

Description copied from interface: SegmentStore

Reads the identified segment from this store.

Parameters:

id - segment identifier

Returns:

identified segment, or a SegmentNotFoundException thrown if not found

close

public void close()

getWriter

@Nonnull
public SegmentWriter getWriter()

Specified by:

getWriter in class AbstractFileStore

getTarReaderIndex

public Map<String,Set<UUID>> getTarReaderIndex()

getTarGraph

public Map<UUID,List<UUID>> getTarGraph(String fileName)
                                 throws IOException

Throws:

IOException

getSegmentIds

public Iterable<SegmentId> getSegmentIds()

getRevisions

public ReadOnlyRevisions getRevisions()

Specified by:

getRevisions in class AbstractFileStore

Returns:

the Revisions object bound to the current store.