org.apache.jackrabbit.oak.segment.file

Class AbstractFileStore

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, SegmentStore

Direct Known Subclasses:

FileStore, ReadOnlyFileStore

public abstract class AbstractFileStore
extends Object
implements SegmentStore, Closeable

The storage implementation for tar files.

Method Summary

Modifier and Type	Method and Description
org.apache.jackrabbit.oak.spi.blob.BlobStore	getBlobStore()
SegmentNodeState	getHead() Convenience method for accessing the root node for the current head.
SegmentReader	getReader()
abstract Revisions	getRevisions()
org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean	getSegmentCacheStats()
org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean	getStringCacheStats()
org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean	getTemplateCacheStats()
SegmentTracker	getTracker()
abstract SegmentWriter	getWriter()
SegmentId	newBulkSegmentId() Create a new SegmentId for a segment of type "bulk".
SegmentId	newDataSegmentId() Create a new SegmentId for a segment of type "data".
SegmentId	newSegmentId(long msb, long lsb) Create a SegmentId represented by the given MSB/LSB pair.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.segment.SegmentStore

containsSegment, readSegment, writeSegment

Methods inherited from interface java.io.Closeable

close

Method Detail

getSegmentCacheStats

@Nonnull
public org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean getSegmentCacheStats()

getStringCacheStats

@Nonnull
public org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean getStringCacheStats()

getTemplateCacheStats

@Nonnull
public org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean getTemplateCacheStats()

getTracker

@Nonnull
public SegmentTracker getTracker()

getWriter

@Nonnull
public abstract SegmentWriter getWriter()

getReader

@Nonnull
public SegmentReader getReader()

getRevisions

public abstract Revisions getRevisions()

Returns:

the Revisions object bound to the current store.

getHead

@Nonnull
public SegmentNodeState getHead()

Convenience method for accessing the root node for the current head. This is equivalent to

 fileStore.getReader().readHeadState(fileStore.getRevisions())
 

Returns:

the current head node state

newSegmentId

@Nonnull
public SegmentId newSegmentId(long msb,
                                       long lsb)

Description copied from interface: SegmentStore

Create a SegmentId represented by the given MSB/LSB pair.

Specified by:

newSegmentId in interface SegmentStore

Parameters:

msb - The most significant bits of the SegmentId.

lsb - The least significant bits of the SegmentId.

Returns:

A non-null instance of SegmentId.

newBulkSegmentId

@Nonnull
public SegmentId newBulkSegmentId()

Description copied from interface: SegmentStore

Create a new SegmentId for a segment of type "bulk".

Specified by:

newBulkSegmentId in interface SegmentStore

Returns:

A non-null instance of SegmentId.

newDataSegmentId

@Nonnull
public SegmentId newDataSegmentId()

Description copied from interface: SegmentStore

Create a new SegmentId for a segment of type "data".

Specified by:

newDataSegmentId in interface SegmentStore

Returns:

A non-null instance of SegmentId.

getBlobStore

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

Returns:

the external BlobStore (if configured) with this store, null otherwise.