org.apache.jackrabbit.oak.segment.remote

Class AbstractRemoteSegmentArchiveWriter

java.lang.Object

org.apache.jackrabbit.oak.segment.remote.AbstractRemoteSegmentArchiveWriter

All Implemented Interfaces:

org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

public abstract class AbstractRemoteSegmentArchiveWriter
extends Object
implements org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	created
protected int	entries
protected Map<UUID,RemoteSegmentArchiveEntry>	index
protected org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor	ioMonitor
protected org.apache.jackrabbit.oak.segment.spi.monitor.FileStoreMonitor	monitor
protected Optional<SegmentWriteQueue>	queue
protected long	totalLength

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteSegmentArchiveWriter(org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor ioMonitor, org.apache.jackrabbit.oak.segment.spi.monitor.FileStoreMonitor monitor)

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterQueueClosed() Hook for executing additional actions after the segment write queue is closed.
protected abstract void	afterQueueFlushed() Hook for executing additional actions after the segment write queue is flushed.
void	close()
boolean	containsSegment(long msb, long lsb)
protected abstract org.apache.jackrabbit.oak.commons.Buffer	doReadArchiveEntry(RemoteSegmentArchiveEntry indexEntry) Reads a segment from remote storage into a buffer.
protected abstract void	doWriteArchiveEntry(RemoteSegmentArchiveEntry indexEntry, byte[] data, int offset, int size) Writes a segment to the remote storage.
protected abstract void	doWriteDataFile(byte[] data, String extension) Writes a data file inside the archive.
void	flush()
int	getEntryCount()
long	getLength()
boolean	isCreated()
org.apache.jackrabbit.oak.commons.Buffer	readSegment(long msb, long lsb)
void	writeBinaryReferences(@NotNull byte[] data)
void	writeDataFile(byte[] data, String extension)
void	writeGraph(@NotNull byte[] data)
void	writeSegment(long msb, long lsb, @NotNull byte[] data, int offset, int size, int generation, int fullGeneration, boolean compacted)

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

getName

Field Detail

ioMonitor

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

monitor

protected final org.apache.jackrabbit.oak.segment.spi.monitor.FileStoreMonitor monitor

queue

protected final Optional<SegmentWriteQueue> queue

index

protected Map<UUID,RemoteSegmentArchiveEntry> index

entries

protected int entries

totalLength

protected long totalLength

created

protected volatile boolean created

Constructor Detail

AbstractRemoteSegmentArchiveWriter

public AbstractRemoteSegmentArchiveWriter(org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitor ioMonitor,
                                          org.apache.jackrabbit.oak.segment.spi.monitor.FileStoreMonitor monitor)

Method Detail

writeSegment

public void writeSegment(long msb,
                         long lsb,
                         @NotNull
                         @NotNull byte[] data,
                         int offset,
                         int size,
                         int generation,
                         int fullGeneration,
                         boolean compacted)
                  throws IOException

Specified by:

writeSegment in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

Throws:

IOException

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

Throws:

IOException

containsSegment

public boolean containsSegment(long msb,
                               long lsb)

Specified by:

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

writeGraph

public void writeGraph(@NotNull
                       @NotNull byte[] data)
                throws IOException

Specified by:

writeGraph in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

Throws:

IOException

writeBinaryReferences

public void writeBinaryReferences(@NotNull
                                  @NotNull byte[] data)
                           throws IOException

Specified by:

writeBinaryReferences in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

Throws:

IOException

writeDataFile

public void writeDataFile(byte[] data,
                          String extension)
                   throws IOException

Throws:

IOException

getLength

public long getLength()

Specified by:

getLength in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

getEntryCount

public int getEntryCount()

Specified by:

getEntryCount in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

close

public void close()
           throws IOException

Specified by:

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

Throws:

IOException

isCreated

public boolean isCreated()

Specified by:

isCreated in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

flush

public void flush()
           throws IOException

Specified by:

flush in interface org.apache.jackrabbit.oak.segment.spi.persistence.SegmentArchiveWriter

Throws:

IOException

doWriteArchiveEntry

protected abstract void doWriteArchiveEntry(RemoteSegmentArchiveEntry indexEntry,
                                            byte[] data,
                                            int offset,
                                            int size)
                                     throws IOException

Writes a segment to the remote storage.

Parameters:

indexEntry, - the archive index entry to write

data, - the actual bytes in the entry

offset, - the start offset in the data.

size, - the number of bytes to write.

Throws:

IOException

doReadArchiveEntry

protected abstract org.apache.jackrabbit.oak.commons.Buffer doReadArchiveEntry(RemoteSegmentArchiveEntry indexEntry)
                                                                        throws IOException

Reads a segment from remote storage into a buffer.

Parameters:

indexEntry, - the archive index entry to read

Returns:

th buffer containing the segment bytes

Throws:

IOException

doWriteDataFile

protected abstract void doWriteDataFile(byte[] data,
                                        String extension)
                                 throws IOException

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

Parameters:

data, - bytes to write

extension, - the extension of the data file

Throws:

IOException

afterQueueClosed

protected abstract void afterQueueClosed()
                                  throws IOException

Hook for executing additional actions after the segment write queue is closed.

Throws:

IOException

afterQueueFlushed

protected abstract void afterQueueFlushed()
                                   throws IOException

Hook for executing additional actions after the segment write queue is flushed.

Throws:

IOException