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

Class FileStore

java.lang.Object

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

All Implemented Interfaces:

SegmentStore

Direct Known Subclasses:

FileStore.ReadOnlyStore

public class FileStore
extends Object
implements SegmentStore

The storage implementation for tar files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileStore.Builder Builder for creating FileStore instances.
static class	FileStore.ReadOnlyStore A read only FileStore implementation that supports going back to old revisions.

Constructor Summary

Constructors

Constructor and Description
FileStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore, File directory, int maxFileSizeMB, boolean memoryMapping) Deprecated.
FileStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore, File directory, org.apache.jackrabbit.oak.spi.state.NodeState initial, int maxFileSizeMB, int cacheSizeMB, boolean memoryMapping) Deprecated.
FileStore(File directory, int maxFileSizeMB) Deprecated.
FileStore(File directory, int maxFileSizeMB, boolean memoryMapping) Deprecated.
FileStore(File directory, int maxFileSizeMB, int cacheSizeMB, boolean memoryMapping) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
List<File>	cleanup() Runs garbage collection on the segment level, which could write new generations of tar files.
void	close()
void	compact() Copy every referenced record in data (non-bulk) segments.
boolean	containsSegment(SegmentId id) Checks whether the identified segment exists in this store.
void	flush()
void	flush(boolean cleanup)
void	gc() Triggers removal of segments that are no longer referenceable.
org.apache.jackrabbit.oak.spi.blob.BlobStore	getBlobStore() Returns the external BlobStore (if configured) with this store
SegmentNodeState	getHead() Returns the head state.
Iterable<SegmentId>	getSegmentIds()
FileStoreStats	getStats()
Map<UUID,List<UUID>>	getTarGraph(String fileName)
Map<String,Set<UUID>>	getTarReaderIndex()
SegmentTracker	getTracker()
SegmentVersion	getVersion()
boolean	maybeCompact(boolean cleanup)
static FileStore.Builder	newFileStore(File directory) Create a new instance of a FileStore.Builder for a file store.
org.apache.jackrabbit.oak.api.Blob	readBlob(String blobId) Read a blob from external storage.
int	readerCount()
Segment	readSegment(SegmentId id) Reads the identified segment from this store.
FileStore	setCompactionStrategy(CompactionStrategy strategy)
boolean	setHead(SegmentNodeState base, SegmentNodeState head)
long	size()
void	writeSegment(SegmentId id, byte[] data, int offset, int length) Writes the given segment to the segment store.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStore

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

Deprecated.

Throws:

IOException

FileStore

@Deprecated
public FileStore(File directory,
                    int maxFileSizeMB,
                    boolean memoryMapping)
          throws IOException

Deprecated.

Throws:

IOException

FileStore

@Deprecated
public FileStore(File directory,
                    int maxFileSizeMB)
          throws IOException

Deprecated.

Throws:

IOException

FileStore

@Deprecated
public FileStore(File directory,
                    int maxFileSizeMB,
                    int cacheSizeMB,
                    boolean memoryMapping)
          throws IOException

Deprecated.

Throws:

IOException

FileStore

@Deprecated
public FileStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore,
                    File directory,
                    org.apache.jackrabbit.oak.spi.state.NodeState initial,
                    int maxFileSizeMB,
                    int cacheSizeMB,
                    boolean memoryMapping)
          throws IOException

Deprecated.

Throws:

IOException

Method Detail

newFileStore

@Nonnull
public static FileStore.Builder newFileStore(@Nonnull
                                     File directory)

Create a new instance of a FileStore.Builder for a file store.

Parameters:

directory - directory where the tar files are stored

Returns:

a new FileStore.Builder instance.

maybeCompact

public boolean maybeCompact(boolean cleanup)
                     throws IOException

Throws:

IOException

size

public long size()

readerCount

public int readerCount()

getStats

public FileStoreStats getStats()

flush

public void flush()
           throws IOException

Throws:

IOException

flush

public void flush(boolean cleanup)
           throws IOException

Throws:

IOException

cleanup

public List<File> cleanup()
                   throws IOException

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.

Throws:

IOException

compact

public void compact()
             throws IOException

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).

Throws:

IOException

getSegmentIds

public Iterable<SegmentId> getSegmentIds()

getTracker

public SegmentTracker getTracker()

Specified by:

getTracker in interface SegmentStore

getHead

public SegmentNodeState getHead()

Description copied from interface: SegmentStore

Returns the head state.

Specified by:

getHead in interface SegmentStore

Returns:

head state

setHead

public boolean setHead(SegmentNodeState base,
              SegmentNodeState head)

Specified by:

setHead in interface SegmentStore

close

public void close()

Specified by:

close in interface SegmentStore

containsSegment

public boolean containsSegment(SegmentId id)

Description copied from interface: SegmentStore

Checks whether the identified segment exists in this store.

Specified by:

containsSegment in interface SegmentStore

Parameters:

id - segment identifier

Returns:

true if the segment exists, false otherwise

readSegment

public Segment readSegment(SegmentId id)

Description copied from interface: SegmentStore

Reads the identified segment from this store.

Specified by:

readSegment in interface SegmentStore

Parameters:

id - segment identifier

Returns:

identified segment, or a SegmentNotFoundException thrown if not found

writeSegment

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

Description copied from interface: SegmentStore

Writes the given segment to the segment store.

Specified by:

writeSegment in interface SegmentStore

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

Throws:

IOException

readBlob

public org.apache.jackrabbit.oak.api.Blob readBlob(String blobId)

Description copied from interface: SegmentStore

Read a blob from external storage.

Specified by:

readBlob in interface SegmentStore

Parameters:

blobId - blob reference

Returns:

external blob

getBlobStore

public org.apache.jackrabbit.oak.spi.blob.BlobStore getBlobStore()

Description copied from interface: SegmentStore

Returns the external BlobStore (if configured) with this store

Specified by:

getBlobStore in interface SegmentStore

gc

public void gc()

Description copied from interface: SegmentStore

Triggers removal of segments that are no longer referenceable.

Specified by:

gc in interface SegmentStore

getTarReaderIndex

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

getTarGraph

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

Throws:

IOException

setCompactionStrategy

public FileStore setCompactionStrategy(CompactionStrategy strategy)

getVersion

public SegmentVersion getVersion()