org.apache.jackrabbit.oak.plugins.segment

Interface SegmentStore

All Known Implementing Classes:

FileStore, FileStore.ReadOnlyStore, HttpStore, MemoryStore

public interface SegmentStore

The backend storage interface used by the segment node store.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	containsSegment(SegmentId id) Checks whether the identified segment exists in this store.
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.
SegmentTracker	getTracker()
org.apache.jackrabbit.oak.api.Blob	readBlob(String reference) Read a blob from external storage.
Segment	readSegment(SegmentId segmentId) Reads the identified segment from this store.
boolean	setHead(SegmentNodeState base, SegmentNodeState head)
void	writeSegment(SegmentId id, byte[] bytes, int offset, int length) Writes the given segment to the segment store.

Method Detail

getTracker

SegmentTracker getTracker()

getHead

@Nonnull
SegmentNodeState getHead()

Returns the head state.

Returns:

head state

setHead

boolean setHead(SegmentNodeState base,
              SegmentNodeState head)

containsSegment

boolean containsSegment(SegmentId id)

Checks whether the identified segment exists in this store.

Parameters:

id - segment identifier

Returns:

true if the segment exists, false otherwise

readSegment

@CheckForNull
Segment readSegment(SegmentId segmentId)

Reads the identified segment from this store.

Parameters:

segmentId - segment identifier

Returns:

identified segment, or a SegmentNotFoundException thrown if not found

writeSegment

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

Writes the given segment to the segment store.

Parameters:

id - segment identifier

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

offset - start offset within the byte buffer

length - length of the segment

Throws:

IOException

close

void close()

readBlob

org.apache.jackrabbit.oak.api.Blob readBlob(String reference)

Read a blob from external storage.

Parameters:

reference - blob reference

Returns:

external blob

getBlobStore

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

Returns the external BlobStore (if configured) with this store

gc

void gc()

Triggers removal of segments that are no longer referenceable.