Package org.apache.bookkeeper.bookie

Class BookieImpl

java.lang.Object

org.apache.bookkeeper.bookie.BookieImpl

All Implemented Interfaces:

Bookie

Direct Known Subclasses:

ReadOnlyBookie

public class BookieImpl
extends Object
implements Bookie

Implements a bookie.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BookieImpl.NopWriteCallback

Nested classes/interfaces inherited from interface org.apache.bookkeeper.bookie.Bookie

Bookie.NoEntryException, Bookie.NoLedgerException

Field Summary

Fields

Modifier and Type	Field	Description
protected final Supplier<BookieServiceInfo>	bookieServiceInfoProvider
(package private) final ServerConfiguration	conf
(package private) LedgerDirsMonitor	dirsMonitor
(package private) final boolean	entryLogPerLedgerEnabled
(package private) final HandleFactory	handles
(package private) final List<File>	journalDirectories
(package private) final List<Journal>	journals
(package private) final LedgerStorage	ledgerStorage
(package private) ReentrantLock	lock
static final long	METAENTRY_ID_FENCE_KEY
static final long	METAENTRY_ID_FORCE_LEDGER
(package private) static final long	METAENTRY_ID_LEDGER_EXPLICITLAC
static final long	METAENTRY_ID_LEDGER_KEY
(package private) final RegistrationManager	registrationManager
(package private) AtomicBoolean	shutdownTriggered
protected StateManager	stateManager
(package private) final StatsLogger	statsLogger
(package private) final SyncThread	syncThread

Constructor Summary

Constructors

Constructor	Description
BookieImpl(ServerConfiguration conf, RegistrationManager registrationManager, LedgerStorage storage, DiskChecker diskChecker, LedgerDirsManager ledgerDirsManager, LedgerDirsManager indexDirsManager, StatsLogger statsLogger, io.netty.buffer.ByteBufAllocator allocator, Supplier<BookieServiceInfo> bookieServiceInfoProvider)

Method Summary

Modifier and Type	Method	Description
void	addEntry(io.netty.buffer.ByteBuf entry, boolean ackBeforeSync, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx, byte[] masterKey)	Add entry to a ledger.
void	cancelWaitForLastAddConfirmedUpdate(long ledgerId, Watcher<LastAddConfirmedUpdateNotification> watcher)
static void	checkDirectoryStructure(File dir)
io.netty.buffer.ByteBuf	createExplicitLACEntry(long ledgerId, io.netty.buffer.ByteBuf explicitLac)
io.netty.buffer.ByteBuf	createMasterKeyEntry(long ledgerId, byte[] masterKey)
CompletableFuture<Boolean>	fenceLedger(long ledgerId, byte[] masterKey)	Fences a ledger.
void	forceLedger(long ledgerId, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx)	Force sync given 'ledgerId' entries on the journal to the disk.
static boolean	format(ServerConfiguration conf, boolean isInteractive, boolean force)	Format the bookie server data.
io.netty.buffer.ByteBufAllocator	getAllocator()
static BookieSocketAddress	getBookieAddress(ServerConfiguration conf)	Return the configured address of the bookie.
static BookieId	getBookieId(ServerConfiguration conf)
static File[]	getCurrentDirectories(File[] dirs)
static File	getCurrentDirectory(File dir)
int	getExitCode()	Returns exit code - cause of failure.
io.netty.buffer.ByteBuf	getExplicitLac(long ledgerId)
(package private) LedgerDirsManager	getIndexDirsManager()
List<Journal>	getJournals()
LedgerDirsManager	getLedgerDirsManager()
(package private) LedgerDescriptor	getLedgerForEntry(io.netty.buffer.ByteBuf entry, byte[] masterKey)	Retrieve the ledger descriptor for the ledger which entry should be added to.
LedgerStorage	getLedgerStorage()
PrimitiveIterator.OfLong	getListOfEntriesOfLedger(long ledgerId)
BookieStateManager	getStateManager()
long	getTotalDiskSpace()
long	getTotalFreeSpace()
(package private) StateManager	initializeStateManager()
boolean	isAlive()
boolean	isAvailableForHighPriorityWrites()	Check whether Bookie is available for high priority writes.
boolean	isReadOnly()
boolean	isRunning()
void	join()
static LedgerStorage	mountLedgerStorageOffline(ServerConfiguration conf, LedgerStorage ledgerStorage)	Initialize LedgerStorage instance without checkpointing for use within the shell and other RO users.
static BookieImpl	newBookieImpl(ServerConfiguration conf, RegistrationManager registrationManager, LedgerStorage storage, DiskChecker diskChecker, LedgerDirsManager ledgerDirsManager, LedgerDirsManager indexDirsManager, StatsLogger statsLogger, io.netty.buffer.ByteBufAllocator allocator, Supplier<BookieServiceInfo> bookieServiceInfoProvider)
io.netty.buffer.ByteBuf	readEntry(long ledgerId, long entryId)
(package private) void	readJournal()
long	readLastAddConfirmed(long ledgerId)
void	recoveryAddEntry(io.netty.buffer.ByteBuf entry, BookkeeperInternalCallbacks.WriteCallback cb, Object ctx, byte[] masterKey)	Add entry to a ledger, even if the ledger has previous been fenced.
void	run()
void	setExplicitLac(io.netty.buffer.ByteBuf entry, BookkeeperInternalCallbacks.WriteCallback writeCallback, Object ctx, byte[] masterKey)
int	shutdown()
(package private) int	shutdown(int exitCode)
void	start()
(package private) void	triggerBookieShutdown(int exitCode)
boolean	waitForLastAddConfirmedUpdate(long ledgerId, long previousLAC, Watcher<LastAddConfirmedUpdateNotification> watcher)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

journalDirectories

final List<File> journalDirectories

conf

final ServerConfiguration conf

syncThread

final SyncThread syncThread

ledgerStorage

final LedgerStorage ledgerStorage

registrationManager

final RegistrationManager registrationManager

journals

final List<Journal> journals

handles

final HandleFactory handles

entryLogPerLedgerEnabled

final boolean entryLogPerLedgerEnabled

METAENTRY_ID_LEDGER_KEY

public static final long METAENTRY_ID_LEDGER_KEY

See Also:

• Constant Field Values

METAENTRY_ID_FENCE_KEY

public static final long METAENTRY_ID_FENCE_KEY

See Also:

• Constant Field Values

METAENTRY_ID_FORCE_LEDGER

public static final long METAENTRY_ID_FORCE_LEDGER

See Also:

• Constant Field Values

METAENTRY_ID_LEDGER_EXPLICITLAC

static final long METAENTRY_ID_LEDGER_EXPLICITLAC

See Also:

• Constant Field Values

bookieServiceInfoProvider

protected final Supplier<BookieServiceInfo> bookieServiceInfoProvider

dirsMonitor

LedgerDirsMonitor dirsMonitor

stateManager

protected StateManager stateManager

statsLogger

final StatsLogger statsLogger

shutdownTriggered

AtomicBoolean shutdownTriggered

lock

ReentrantLock lock

Constructor Details

BookieImpl

public BookieImpl(ServerConfiguration conf,
 RegistrationManager registrationManager,
 LedgerStorage storage,
 DiskChecker diskChecker,
 LedgerDirsManager ledgerDirsManager,
 LedgerDirsManager indexDirsManager,
 StatsLogger statsLogger,
 io.netty.buffer.ByteBufAllocator allocator,
 Supplier<BookieServiceInfo> bookieServiceInfoProvider)
           throws IOException,
InterruptedException,
BookieException

Throws:

IOException

InterruptedException

BookieException

Method Details

checkDirectoryStructure

public static void checkDirectoryStructure(File dir)
                                    throws IOException

Throws:

IOException

getBookieId

public static BookieId getBookieId(ServerConfiguration conf)
                            throws UnknownHostException

Throws:

UnknownHostException

getBookieAddress

public static BookieSocketAddress getBookieAddress(ServerConfiguration conf)
                                            throws UnknownHostException

Return the configured address of the bookie.

Throws:

UnknownHostException

getLedgerDirsManager

public LedgerDirsManager getLedgerDirsManager()

getIndexDirsManager

LedgerDirsManager getIndexDirsManager()

getTotalDiskSpace

public long getTotalDiskSpace()
                       throws IOException

Specified by:

getTotalDiskSpace in interface Bookie

Throws:

IOException

getTotalFreeSpace

public long getTotalFreeSpace()
                       throws IOException

Specified by:

getTotalFreeSpace in interface Bookie

Throws:

IOException

getCurrentDirectory

public static File getCurrentDirectory(File dir)

getCurrentDirectories

public static File[] getCurrentDirectories(File[] dirs)

mountLedgerStorageOffline

public static LedgerStorage mountLedgerStorageOffline(ServerConfiguration conf,
 LedgerStorage ledgerStorage)
                                               throws IOException

Initialize LedgerStorage instance without checkpointing for use within the shell and other RO users. ledgerStorage must not have already been initialized.

The caller is responsible for disposing of the ledgerStorage object.

Parameters:

conf - Bookie config.

ledgerStorage - Instance to initialize.

Returns:

Passed ledgerStorage instance

Throws:

IOException

newBookieImpl

public static BookieImpl newBookieImpl(ServerConfiguration conf,
 RegistrationManager registrationManager,
 LedgerStorage storage,
 DiskChecker diskChecker,
 LedgerDirsManager ledgerDirsManager,
 LedgerDirsManager indexDirsManager,
 StatsLogger statsLogger,
 io.netty.buffer.ByteBufAllocator allocator,
 Supplier<BookieServiceInfo> bookieServiceInfoProvider)
                                throws IOException,
InterruptedException,
BookieException

Throws:

IOException

InterruptedException

BookieException

initializeStateManager

StateManager initializeStateManager()
                             throws IOException

Throws:

IOException

readJournal

void readJournal()
          throws IOException,
BookieException

Throws:

IOException

BookieException

start

public void start()

Specified by:

start in interface Bookie

join

public void join()
          throws InterruptedException

Specified by:

join in interface Bookie

Throws:

InterruptedException

isAlive

public boolean isAlive()

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Bookie

isAvailableForHighPriorityWrites

public boolean isAvailableForHighPriorityWrites()

Check whether Bookie is available for high priority writes.

Specified by:

isAvailableForHighPriorityWrites in interface Bookie

Returns:

true if the bookie is able to take high priority writes.

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Bookie

run

public void run()

triggerBookieShutdown

void triggerBookieShutdown(int exitCode)

shutdown

public int shutdown()

Specified by:

shutdown in interface Bookie

shutdown

int shutdown(int exitCode)

getLedgerForEntry

LedgerDescriptor getLedgerForEntry(io.netty.buffer.ByteBuf entry,
 byte[] masterKey)
                            throws IOException,
BookieException

Retrieve the ledger descriptor for the ledger which entry should be added to. The LedgerDescriptor returned from this method should be eventually freed with #putHandle().

Throws:

BookieException - if masterKey does not match the master key of the ledger

IOException

createMasterKeyEntry

public io.netty.buffer.ByteBuf createMasterKeyEntry(long ledgerId,
 byte[] masterKey)

recoveryAddEntry

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

Add entry to a ledger, even if the ledger has previous been fenced. This should only happen in bookie recovery or ledger recovery cases, where entries are being replicates so that they exist on a quorum of bookies. The corresponding client side call for this is not exposed to users.

Specified by:

recoveryAddEntry in interface Bookie

Throws:

IOException

BookieException

InterruptedException

createExplicitLACEntry

public io.netty.buffer.ByteBuf createExplicitLACEntry(long ledgerId,
 io.netty.buffer.ByteBuf explicitLac)

setExplicitLac

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

Specified by:

setExplicitLac in interface Bookie

Throws:

IOException

InterruptedException

BookieException

getExplicitLac

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

Specified by:

getExplicitLac in interface Bookie

Throws:

IOException

Bookie.NoLedgerException

BookieException

forceLedger

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

Force sync given 'ledgerId' entries on the journal to the disk. It works like a regular addEntry with ackBeforeSync=false. This is useful for ledgers with DEFERRED_SYNC write flag.

Specified by:

forceLedger in interface Bookie

addEntry

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

Add entry to a ledger.

Specified by:

addEntry in interface Bookie

Throws:

IOException

BookieException

InterruptedException

fenceLedger

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

Specified by:

fenceLedger in interface Bookie

Returns:

Throws:

IOException

BookieException

readEntry

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

Specified by:

readEntry in interface Bookie

Throws:

IOException

Bookie.NoLedgerException

BookieException

readLastAddConfirmed

public long readLastAddConfirmed(long ledgerId)
                          throws IOException,
BookieException

Specified by:

readLastAddConfirmed in interface Bookie

Throws:

IOException

BookieException

waitForLastAddConfirmedUpdate

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

Specified by:

waitForLastAddConfirmedUpdate in interface Bookie

Throws:

IOException

cancelWaitForLastAddConfirmedUpdate

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

Specified by:

cancelWaitForLastAddConfirmedUpdate in interface Bookie

Throws:

IOException

getLedgerStorage

public LedgerStorage getLedgerStorage()

Specified by:

getLedgerStorage in interface Bookie

getStateManager

public BookieStateManager getStateManager()

Specified by:

getStateManager in interface Bookie

getAllocator

public io.netty.buffer.ByteBufAllocator getAllocator()

format

public static boolean format(ServerConfiguration conf,
 boolean isInteractive,
 boolean force)

Format the bookie server data.

Parameters:

conf - ServerConfiguration

isInteractive - Whether format should ask prompt for confirmation if old data exists or not.

force - If non interactive and force is true, then old data will be removed without confirm prompt.

Returns:

Returns true if the format is success else returns false

getExitCode

public int getExitCode()

Returns exit code - cause of failure.

Specified by:

getExitCode in interface Bookie

Returns:

ExitCode

getListOfEntriesOfLedger

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

Specified by:

getListOfEntriesOfLedger in interface Bookie

Throws:

IOException

Bookie.NoLedgerException

getJournals

public List<Journal> getJournals()