Package org.apache.bookkeeper.bookie

Interface LedgerCache

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

InterleavedStorageRegenerateIndexOp.DryRunLedgerCache, LedgerCacheImpl

public interface LedgerCache
extends Closeable

This class maps a ledger entry number into a location (entrylogid, offset) in an entry log file. It does user level caching to more efficiently manage disk head scheduling.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LedgerCache.LedgerIndexMetadata	Represents summary of ledger metadata.
static class	LedgerCache.NoIndexForLedgerException	Specific exception to encode the case where the index is not present.
static interface	LedgerCache.PageEntries	Represents a page of the index.
static interface	LedgerCache.PageEntriesIterable	Iterable over index pages -- returns PageEntries rather than individual entries because getEntries() above needs to be able to throw an IOException.

Method Summary

Modifier and Type	Method	Description
void	cancelWaitForLastAddConfirmedUpdate(long ledgerId, Watcher<LastAddConfirmedUpdateNotification> watcher)
void	deleteLedger(long ledgerId)
void	flushLedger(boolean doAll)
PrimitiveIterator.OfLong	getEntriesIterator(long ledgerId)
long	getEntryOffset(long ledger, long entry)
io.netty.buffer.ByteBuf	getExplicitLac(long ledgerId)
Long	getLastAddConfirmed(long ledgerId)
long	getLastEntry(long ledgerId)
boolean	isFenced(long ledgerId)
boolean	ledgerExists(long ledgerId)
LedgerCache.PageEntriesIterable	listEntries(long ledgerId)
void	putEntryOffset(long ledger, long entry, long offset)
LedgerCache.LedgerIndexMetadata	readLedgerIndexMetadata(long ledgerId)
byte[]	readMasterKey(long ledgerId)
void	setExplicitLac(long ledgerId, io.netty.buffer.ByteBuf lac)
boolean	setFenced(long ledgerId)
void	setMasterKey(long ledgerId, byte[] masterKey)
long	updateLastAddConfirmed(long ledgerId, long lac)
boolean	waitForLastAddConfirmedUpdate(long ledgerId, long previousLAC, Watcher<LastAddConfirmedUpdateNotification> watcher)

Methods inherited from interface java.io.Closeable

close

Method Details

setFenced

boolean setFenced(long ledgerId)
           throws IOException

Throws:

IOException

isFenced

boolean isFenced(long ledgerId)
          throws IOException

Throws:

IOException

setMasterKey

void setMasterKey(long ledgerId,
 byte[] masterKey)
           throws IOException

Throws:

IOException

readMasterKey

byte[] readMasterKey(long ledgerId)
              throws IOException,
BookieException

Throws:

IOException

BookieException

ledgerExists

boolean ledgerExists(long ledgerId)
              throws IOException

Throws:

IOException

putEntryOffset

void putEntryOffset(long ledger,
 long entry,
 long offset)
             throws IOException

Throws:

IOException

getEntryOffset

long getEntryOffset(long ledger,
 long entry)
             throws IOException

Throws:

IOException

flushLedger

void flushLedger(boolean doAll)
          throws IOException

Throws:

IOException

getLastEntry

long getLastEntry(long ledgerId)
           throws IOException

Throws:

IOException

getLastAddConfirmed

Long getLastAddConfirmed(long ledgerId)
                  throws IOException

Throws:

IOException

updateLastAddConfirmed

long updateLastAddConfirmed(long ledgerId,
 long lac)
                     throws IOException

Throws:

IOException

waitForLastAddConfirmedUpdate

boolean waitForLastAddConfirmedUpdate(long ledgerId,
 long previousLAC,
 Watcher<LastAddConfirmedUpdateNotification> watcher)
                               throws IOException

Throws:

IOException

cancelWaitForLastAddConfirmedUpdate

void cancelWaitForLastAddConfirmedUpdate(long ledgerId,
 Watcher<LastAddConfirmedUpdateNotification> watcher)
                                  throws IOException

Throws:

IOException

deleteLedger

void deleteLedger(long ledgerId)
           throws IOException

Throws:

IOException

setExplicitLac

void setExplicitLac(long ledgerId,
 io.netty.buffer.ByteBuf lac)
             throws IOException

Throws:

IOException

getExplicitLac

io.netty.buffer.ByteBuf getExplicitLac(long ledgerId)

listEntries

LedgerCache.PageEntriesIterable listEntries(long ledgerId)
                                     throws IOException

Throws:

IOException

getEntriesIterator

PrimitiveIterator.OfLong getEntriesIterator(long ledgerId)
                                     throws IOException

Throws:

IOException

readLedgerIndexMetadata

LedgerCache.LedgerIndexMetadata readLedgerIndexMetadata(long ledgerId)
                                                 throws IOException

Throws:

IOException