org.apache.jackrabbit.oak.plugins.segment.file

Class FileStore.ReadOnlyStore

java.lang.Object

org.apache.jackrabbit.oak.plugins.segment.file.FileStore

org.apache.jackrabbit.oak.plugins.segment.file.FileStore.ReadOnlyStore

All Implemented Interfaces:

SegmentStore

Enclosing class:

FileStore

public static class FileStore.ReadOnlyStore
extends FileStore

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

All write methods are no-ops.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.plugins.segment.file.FileStore

FileStore.Builder, FileStore.ReadOnlyStore

Constructor Summary

Constructors

Constructor and Description
FileStore.ReadOnlyStore(File directory)
FileStore.ReadOnlyStore(File directory, org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)
FileStore.ReadOnlyStore(File directory, int cacheSize, boolean memoryMapping)
FileStore.ReadOnlyStore(File directory, int cacheSize, boolean memoryMapping, org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)

Method Summary

Methods

Modifier and Type	Method and Description
LinkedList<File>	cleanup() Runs garbage collection on the segment level, which could write new generations of tar files.
void	compact() Copy every referenced record in data (non-bulk) segments.
void	flush() no-op
void	gc() Triggers removal of segments that are no longer referenceable.
boolean	maybeCompact(boolean cleanup)
boolean	setHead(SegmentNodeState base, SegmentNodeState head)
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.plugins.segment.file.FileStore

close, containsSegment, flush, getBlobStore, getHead, getSegmentIds, getStats, getTarGraph, getTarReaderIndex, getTracker, getVersion, newFileStore, readBlob, readerCount, readSegment, setCompactionStrategy, size

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStore.ReadOnlyStore

public FileStore.ReadOnlyStore(File directory,
                       int cacheSize,
                       boolean memoryMapping)
                        throws IOException

Throws:

IOException

FileStore.ReadOnlyStore

public FileStore.ReadOnlyStore(File directory,
                       int cacheSize,
                       boolean memoryMapping,
                       org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)
                        throws IOException

Throws:

IOException

FileStore.ReadOnlyStore

public FileStore.ReadOnlyStore(File directory)
                        throws IOException

Throws:

IOException

FileStore.ReadOnlyStore

public FileStore.ReadOnlyStore(File directory,
                       org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)
                        throws IOException

Throws:

IOException

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

setHead

public boolean setHead(SegmentNodeState base,
              SegmentNodeState head)

Specified by:

setHead in interface SegmentStore

Overrides:

setHead in class FileStore

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.

Specified by:

writeSegment in interface SegmentStore

Overrides:

writeSegment in class FileStore

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

flush

public void flush()

no-op

Overrides:

flush in class FileStore

cleanup

public LinkedList<File> cleanup()

Description copied from class: FileStore

Runs garbage collection on the segment level, which could write new generations of tar files. It checks which segments are still reachable, and throws away those that are not.

A new generation of a tar file is created (and segments are only discarded) if doing so releases more than 25% of the space in a tar file.

Overrides:

cleanup in class FileStore

gc

public void gc()

Description copied from interface: SegmentStore

Triggers removal of segments that are no longer referenceable.

Specified by:

gc in interface SegmentStore

Overrides:

gc in class FileStore

compact

public void compact()

Description copied from class: FileStore

Copy every referenced record in data (non-bulk) segments. Bulk segments are fully kept (they are only removed in cleanup, if there is no reference to them).

Overrides:

compact in class FileStore

maybeCompact

public boolean maybeCompact(boolean cleanup)

Overrides:

maybeCompact in class FileStore