org.apache.jackrabbit.oak.segment.remote

Class AbstractRemoteSegmentArchiveReader

java.lang.Object

org.apache.jackrabbit.oak.segment.remote.AbstractRemoteSegmentArchiveReader

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

public abstract class AbstractRemoteSegmentArchiveReader
extends Object
implements org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	hasGraph
protected Map<UUID,RemoteSegmentArchiveEntry>	index
protected org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor	ioMonitor

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteSegmentArchiveReader(org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor ioMonitor)

Method Summary

Modifier and Type	Method and Description
protected abstract File	archivePathAsFile() Returns the decoded file component of this archive.
void	close()
protected abstract long	computeArchiveIndexAndLength() Populates the archive index, summing up each entry's length.
boolean	containsSegment(long msb, long lsb)
protected abstract org.apache.jackrabbit.oak.commons.Buffer	doReadDataFile(String extension) Reads a data file inside the archive.
protected abstract void	doReadSegmentToBuffer(String segmentFileName, org.apache.jackrabbit.oak.commons.Buffer buffer) Reads the segment from the remote storage.
org.apache.jackrabbit.oak.commons.Buffer	getBinaryReferences()
int	getEntrySize(int size)
org.apache.jackrabbit.oak.commons.Buffer	getGraph()
boolean	hasGraph()
List<org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveEntry>	listSegments()
org.apache.jackrabbit.oak.commons.Buffer	readSegment(long msb, long lsb)

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.spi.persistence.SegmentArchiveReader

getName, length

Field Detail

ioMonitor

protected final org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor ioMonitor

index

protected final Map<UUID,RemoteSegmentArchiveEntry> index

hasGraph

protected Boolean hasGraph

Constructor Detail

AbstractRemoteSegmentArchiveReader

public AbstractRemoteSegmentArchiveReader(org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor ioMonitor)
                                   throws IOException

Throws:

IOException

Method Detail

readSegment

public org.apache.jackrabbit.oak.commons.Buffer readSegment(long msb,
                                                            long lsb)
                                                     throws IOException

Specified by:

readSegment in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

Throws:

IOException

containsSegment

public boolean containsSegment(long msb,
                               long lsb)

Specified by:

containsSegment in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

listSegments

public List<org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveEntry> listSegments()

Specified by:

listSegments in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

getGraph

public org.apache.jackrabbit.oak.commons.Buffer getGraph()
                                                  throws IOException

Specified by:

getGraph in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

Throws:

IOException

hasGraph

public boolean hasGraph()

Specified by:

hasGraph in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

getBinaryReferences

public org.apache.jackrabbit.oak.commons.Buffer getBinaryReferences()
                                                             throws IOException

Specified by:

getBinaryReferences in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

getEntrySize

public int getEntrySize(int size)

Specified by:

getEntrySize in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveReader

computeArchiveIndexAndLength

protected abstract long computeArchiveIndexAndLength()
                                              throws IOException

Populates the archive index, summing up each entry's length.

Returns:

length, the total length of the archive

Throws:

IOException

doReadSegmentToBuffer

protected abstract void doReadSegmentToBuffer(String segmentFileName,
                                              org.apache.jackrabbit.oak.commons.Buffer buffer)
                                       throws IOException

Reads the segment from the remote storage.

Parameters:

segmentFileName, - the name of the segment (msb + lsb) prefixed by its position in the archive

buffer, - the buffer to which to read

Throws:

IOException

doReadDataFile

protected abstract org.apache.jackrabbit.oak.commons.Buffer doReadDataFile(String extension)
                                                                    throws IOException

Reads a data file inside the archive. This entry is not a segment. Its full name is given by archive name + extension.

Parameters:

extension, - extension of the file

Returns:

the buffer containing the data file bytes

Throws:

IOException

archivePathAsFile

protected abstract File archivePathAsFile()

Returns the decoded file component of this archive.

Returns:

the decoded file component of this archive.