Package org.apache.bookkeeper.bookie

Interface Bookie

All Known Implementing Classes:

BookieImpl, ReadOnlyBookie

public interface Bookie

Interface for the bookie.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Bookie.NoEntryException	Exception is thrown when no such an entry is found in this bookie.
static class	Bookie.NoLedgerException	Exception is thrown when no such a ledger is found in this bookie.

Method Summary

Modifier and Type	Method	Description
void	addEntry(io.netty.buffer.ByteBuf entry, boolean ackBeforeSync, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx, byte[] masterKey)
void	cancelWaitForLastAddConfirmedUpdate(long ledgerId, Watcher<LastAddConfirmedUpdateNotification> watcher)
CompletableFuture<Boolean>	fenceLedger(long ledgerId, byte[] masterKey)	Fences a ledger.
void	forceLedger(long ledgerId, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx)
int	getExitCode()
io.netty.buffer.ByteBuf	getExplicitLac(long ledgerId)
LedgerStorage	getLedgerStorage()
PrimitiveIterator.OfLong	getListOfEntriesOfLedger(long ledgerId)
StateManager	getStateManager()
long	getTotalDiskSpace()
long	getTotalFreeSpace()
boolean	isAvailableForHighPriorityWrites()
boolean	isReadOnly()
boolean	isRunning()
void	join()
io.netty.buffer.ByteBuf	readEntry(long ledgerId, long entryId)
long	readLastAddConfirmed(long ledgerId)
void	recoveryAddEntry(io.netty.buffer.ByteBuf entry, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx, byte[] masterKey)
void	setExplicitLac(io.netty.buffer.ByteBuf entry, BookkeeperInternalCallbacks.WriteCallback writeCallback, Object ctx, byte[] masterKey)
int	shutdown()
void	start()
boolean	waitForLastAddConfirmedUpdate(long ledgerId, long previousLAC, Watcher<LastAddConfirmedUpdateNotification> watcher)

Method Details

start

void start()

join

void join()
   throws InterruptedException

Throws:

InterruptedException

isRunning

boolean isRunning()

getExitCode

int getExitCode()

shutdown

int shutdown()

isAvailableForHighPriorityWrites

boolean isAvailableForHighPriorityWrites()

isReadOnly

boolean isReadOnly()

addEntry

void addEntry(io.netty.buffer.ByteBuf entry,
 boolean ackBeforeSync,
 BookkeeperInternalCallbacks.WriteCallback cb,
 Object ctx,
 byte[] masterKey)
       throws IOException,
BookieException,
InterruptedException

Throws:

IOException

BookieException

InterruptedException

recoveryAddEntry

void recoveryAddEntry(io.netty.buffer.ByteBuf entry,
 BookkeeperInternalCallbacks.WriteCallback cb,
 Object ctx,
 byte[] masterKey)
               throws IOException,
BookieException,
InterruptedException

Throws:

IOException

BookieException

InterruptedException

forceLedger

void forceLedger(long ledgerId,
 BookkeeperInternalCallbacks.WriteCallback cb,
 Object ctx)

setExplicitLac

void setExplicitLac(io.netty.buffer.ByteBuf entry,
 BookkeeperInternalCallbacks.WriteCallback writeCallback,
 Object ctx,
 byte[] masterKey)
             throws IOException,
InterruptedException,
BookieException

Throws:

IOException

InterruptedException

BookieException

getExplicitLac

io.netty.buffer.ByteBuf getExplicitLac(long ledgerId)
                                throws IOException,
Bookie.NoLedgerException,
BookieException

Throws:

IOException

Bookie.NoLedgerException

BookieException

getTotalDiskSpace

long getTotalDiskSpace()
                throws IOException

Throws:

IOException

getTotalFreeSpace

long getTotalFreeSpace()
                throws IOException

Throws:

IOException

readEntry

io.netty.buffer.ByteBuf readEntry(long ledgerId,
 long entryId)
                           throws IOException,
Bookie.NoLedgerException,
BookieException

Throws:

IOException

Bookie.NoLedgerException

BookieException

readLastAddConfirmed

long readLastAddConfirmed(long ledgerId)
                   throws IOException,
BookieException

Throws:

IOException

BookieException

getListOfEntriesOfLedger

PrimitiveIterator.OfLong getListOfEntriesOfLedger(long ledgerId)
                                           throws IOException,
Bookie.NoLedgerException

Throws:

IOException

Bookie.NoLedgerException

fenceLedger

CompletableFuture<Boolean> fenceLedger(long ledgerId,
 byte[] masterKey)
                                throws IOException,
BookieException

Fences a ledger. From this point on, clients will be unable to write to this ledger. Only recoveryAddEntry will be able to add entries to the ledger. This method is idempotent. Once a ledger is fenced, it can never be unfenced. Fencing a fenced ledger has no effect.

Returns:

Throws:

IOException

BookieException

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

getStateManager

StateManager getStateManager()

getLedgerStorage

LedgerStorage getLedgerStorage()