Uses of Class
org.apache.bookkeeper.client.LedgerHandle

Packages that use LedgerHandle

Package	Description
org.apache.bookkeeper.client	BookKeeper Client.
org.apache.bookkeeper.proto	Classes related to the Bookkeeper protocol.
org.apache.bookkeeper.replication	Classes for replicating Bookkeeper data.
org.apache.bookkeeper.streaming	A java io stream wrapper over bookkeeper ledgers.
org.apache.bookkeeper.tools.cli.commands.bookie	Commands to operate a single bookie.

Uses of LedgerHandle in org.apache.bookkeeper.client

Subclasses of LedgerHandle in org.apache.bookkeeper.client

Modifier and Type	Class	Description
class	LedgerHandleAdv	Ledger Advanced handle extends LedgerHandle to provide API to add entries with user supplied entryIds.
(package private) class	ReadOnlyLedgerHandle	Read only ledger handle.

Fields in org.apache.bookkeeper.client declared as LedgerHandle

Modifier and Type	Field	Description
(package private) final LedgerHandle	BookKeeperAdmin.LedgerEntriesIterator.handle
(package private) final LedgerHandle	ExplicitLacFlushPolicy.ExplicitLacFlushPolicyImpl.lh
(package private) final LedgerHandle	ForceLedgerOp.lh
(package private) LedgerHandle	LedgerCreateOp.lh
(package private) final LedgerHandle	LedgerFragmentReplicator.SingleFragmentCallback.lh
(package private) final LedgerHandle	LedgerRecoveryOp.lh
(package private) LedgerHandle	PendingAddOp.lh
(package private) LedgerHandle	PendingReadLacOp.lh
(package private) LedgerHandle	PendingWriteLacOp.lh
(package private) LedgerHandle	ReadOpBase.lh
(package private) LedgerHandle	SyncCounter.lh
(package private) final LedgerHandle	TryReadLastConfirmedOp.lh

Fields in org.apache.bookkeeper.client with type parameters of type LedgerHandle

Modifier and Type	Field	Description
(package private) final CompletableFuture<LedgerHandle>	LedgerRecoveryOp.promise

Methods in org.apache.bookkeeper.client that return LedgerHandle

Modifier and Type	Method	Description
LedgerHandle	BookKeeper.createLedger(int ensSize, int writeQuorumSize, int ackQuorumSize, BookKeeper.DigestType digestType, byte[] passwd)	Synchronous call to create ledger.
LedgerHandle	BookKeeper.createLedger(int ensSize, int writeQuorumSize, int ackQuorumSize, BookKeeper.DigestType digestType, byte[] passwd, Map<String,byte[]> customMetadata)	Synchronous call to create ledger.
LedgerHandle	BookKeeper.createLedger(int ensSize, int qSize, BookKeeper.DigestType digestType, byte[] passwd)	Synchronous call to create ledger.
LedgerHandle	BookKeeper.createLedger(BookKeeper.DigestType digestType, byte[] passwd)	Creates a new ledger.
LedgerHandle	BookKeeper.createLedgerAdv(int ensSize, int writeQuorumSize, int ackQuorumSize, BookKeeper.DigestType digestType, byte[] passwd)	Synchronous call to create ledger.
LedgerHandle	BookKeeper.createLedgerAdv(int ensSize, int writeQuorumSize, int ackQuorumSize, BookKeeper.DigestType digestType, byte[] passwd, Map<String,byte[]> customMetadata)	Synchronous call to create ledger.
LedgerHandle	BookKeeper.createLedgerAdv(long ledgerId, int ensSize, int writeQuorumSize, int ackQuorumSize, BookKeeper.DigestType digestType, byte[] passwd, Map<String,byte[]> customMetadata)	Synchronously creates a new ledger using the interface which accepts a ledgerId as input.
(package private) LedgerHandle	SyncCounter.getLh()
LedgerHandle	BookKeeper.openLedger(long lId, BookKeeper.DigestType digestType, byte[] passwd)	Synchronous open ledger call.
LedgerHandle	BookKeeper.openLedger(long lId, BookKeeper.DigestType digestType, byte[] passwd, boolean keepUpdateMetadata)	Synchronous open ledger call.
LedgerHandle	BookKeeperAdmin.openLedger(long lId)	Open a ledger as an administrator.
LedgerHandle	BookKeeper.openLedgerNoRecovery(long lId, BookKeeper.DigestType digestType, byte[] passwd)	Synchronous, unsafe open ledger call.
LedgerHandle	BookKeeperAdmin.openLedgerNoRecovery(long lId)	Open a ledger as an administrator without recovering the ledger.

Methods in org.apache.bookkeeper.client that return types with arguments of type LedgerHandle

Modifier and Type	Method	Description
CompletableFuture<LedgerHandle>	LedgerRecoveryOp.initiate()

Methods in org.apache.bookkeeper.client with parameters of type LedgerHandle

Modifier and Type	Method	Description
void	AsyncCallback.AddCallback.addComplete(int rc, LedgerHandle lh, long entryId, Object ctx)	Callback to implement if latency information is not desired.
void	LedgerRecoveryOp.addComplete(int rc, LedgerHandle lh, long entryId, Object ctx)
void	SyncCallbackUtils.SyncAddCallback.addComplete(int rc, LedgerHandle lh, long entry, Object ctx)	Implementation of callback interface for synchronous read method.
default void	AsyncCallback.AddCallback.addCompleteWithLatency(int rc, LedgerHandle lh, long entryId, long qwcLatency, Object ctx)	Callback declaration which additionally passes quorum write complete latency.
void	AsyncCallback.AddCallbackWithLatency.addCompleteWithLatency(int rc, LedgerHandle lh, long entryId, long qwcLatency, Object ctx)	Callback declaration which additionally passes quorum write complete latency.
void	AsyncCallback.AddLacCallback.addLacComplete(int rc, LedgerHandle lh, Object ctx)	Callback declaration.
void	SyncCallbackUtils.LastAddConfirmedCallback.addLacComplete(int rc, LedgerHandle lh, Object ctx)	Implementation of callback interface for synchronous read method.
(package private) void	LedgerFragmentReplicator.batchRecoverLedgerFragmentEntry(long startEntryId, long endEntryId, LedgerHandle lh, org.apache.zookeeper.AsyncCallback.VoidCallback ledgerFragmentMcb, Set<BookieId> newBookies, BiConsumer<Long,Long> onReadEntryFailureCallback)
void	LedgerChecker.checkLedger(LedgerHandle lh, BookkeeperInternalCallbacks.GenericCallback<Set<LedgerFragment>> cb)	Check that all the fragments in the passed in ledger, and report those which are missing.
void	LedgerChecker.checkLedger(LedgerHandle lh, BookkeeperInternalCallbacks.GenericCallback<Set<LedgerFragment>> cb, long percentageOfLedgerFragmentToBeVerified)
void	AsyncCallback.CloseCallback.closeComplete(int rc, LedgerHandle lh, Object ctx)	Callback definition.
void	LedgerHandle.NoopCloseCallback.closeComplete(int rc, LedgerHandle lh, Object ctx)
void	SyncCallbackUtils.SyncCloseCallback.closeComplete(int rc, LedgerHandle lh, Object ctx)	Close callback method.
(package private) static PendingAddOp	PendingAddOp.create(LedgerHandle lh, ClientContext clientCtx, List<BookieId> ensemble, io.netty.buffer.ByteBuf payload, EnumSet<WriteFlag> writeFlags, AsyncCallback.AddCallbackWithLatency cb, Object ctx)
void	AsyncCallback.CreateCallback.createComplete(int rc, LedgerHandle lh, Object ctx)	Declaration of callback method.
void	SyncCallbackUtils.SyncCreateAdvCallback.createComplete(int rc, LedgerHandle lh, Object ctx)	Create callback implementation for synchronous create call.
void	SyncCallbackUtils.SyncCreateCallback.createComplete(int rc, LedgerHandle lh, Object ctx)	Create callback implementation for synchronous create call.
LedgerMetadata	BookKeeperAdmin.getLedgerMetadata(LedgerHandle lh)
void	LedgerRecoveryOp.onEntryComplete(int rc, LedgerHandle lh, LedgerEntry entry, Object ctx)
void	AsyncCallback.OpenCallback.openComplete(int rc, LedgerHandle lh, Object ctx)	Callback for asynchronous call to open ledger.
(package private) void	LedgerOpenOp.openComplete(int rc, LedgerHandle lh)
void	SyncCallbackUtils.SyncOpenCallback.openComplete(int rc, LedgerHandle lh, Object ctx)	Callback method for synchronous open operation.
void	AsyncCallback.ReadCallback.readComplete(int rc, LedgerHandle lh, Enumeration<LedgerEntry> seq, Object ctx)	Callback declaration.
void	SyncCallbackUtils.SyncReadCallback.readComplete(int rc, LedgerHandle lh, Enumeration<LedgerEntry> seq, Object ctx)	Implementation of callback interface for synchronous read method.
(package private) void	LedgerFragmentReplicator.recoverLedgerFragmentEntry(Long entryId, LedgerHandle lh, org.apache.zookeeper.AsyncCallback.VoidCallback ledgerFragmentEntryMcb, Set<BookieId> newBookies, BiConsumer<Long,Long> onReadEntryFailureCallback)	This method asynchronously recovers a specific ledger entry by reading the values via the BookKeeper Client (which would read it from the other replicas) and then writing it to the chosen new bookie.
(package private) void	LedgerFragmentReplicator.replicate(LedgerHandle lh, LedgerFragment lf, org.apache.zookeeper.AsyncCallback.VoidCallback ledgerFragmentMcb, Set<BookieId> targetBookieAddresses, BiConsumer<Long,Long> onReadEntryFailureCallback)	This method replicate a ledger fragment which is a contiguous portion of a ledger that was stored in an ensemble that included the failed bookie.
void	BookKeeperAdmin.replicateLedgerFragment(LedgerHandle lh, LedgerFragment ledgerFragment, BiConsumer<Long,Long> onReadEntryFailureCallback)	Replicate the Ledger fragment to target Bookie passed.
(package private) void	SyncCounter.setLh(LedgerHandle lh)
(package private) static Set<LedgerFragment>	LedgerFragmentReplicator.splitIntoSubFragments(LedgerHandle lh, LedgerFragment ledgerFragment, long rereplicationEntryBatchSize)	Split the full fragment into batched entry fragments by keeping rereplicationEntryBatchSize of entries in each one and can treat them as sub fragments.

Constructors in org.apache.bookkeeper.client with parameters of type LedgerHandle

Modifier	Constructor	Description
(package private)	BatchedReadOp(LedgerHandle lh, ClientContext clientCtx, long startEntryId, int maxCount, long maxSize, boolean isRecoveryRead)
(package private)	ExplicitLacFlushPolicyImpl(LedgerHandle lh, ClientContext clientCtx)
(package private)	ForceLedgerOp(LedgerHandle lh, BookieClient bookieClient, List<BookieId> ensemble, CompletableFuture<Void> cb)
	LedgerFragment(LedgerHandle lh, long firstEntryId, long lastKnownEntryId, Set<Integer> bookieIndexes)
	LedgerRecoveryOp(LedgerHandle lh, ClientContext clientCtx)
(package private)	ListenerBasedPendingReadOp(LedgerHandle lh, ClientContext clientCtx, long startEntryId, long endEntryId, BookkeeperInternalCallbacks.ReadEntryListener listener, Object ctx, boolean isRecoveryRead)
(package private)	PendingReadLacOp(LedgerHandle lh, BookieClient bookieClient, List<BookieId> ensemble, PendingReadLacOp.LacCallback cb)
(package private)	PendingReadOp(LedgerHandle lh, ClientContext clientCtx, long startEntryId, long endEntryId, boolean isRecoveryRead)
(package private)	PendingWriteLacOp(LedgerHandle lh, ClientContext clientCtx, List<BookieId> ensemble, AsyncCallback.AddLacCallback cb, Object ctx)
(package private)	ReadLastConfirmedAndEntryOp(LedgerHandle lh, ClientContext clientCtx, List<BookieId> ensemble, ReadLastConfirmedAndEntryOp.LastConfirmedAndEntryCallback cb, long prevEntryId, long timeOutInMillis)
protected	ReadOpBase(LedgerHandle lh, ClientContext clientCtx, long startEntryId, long endEntryId, boolean isRecoveryRead)
(package private)	RecoveryReadOp(LedgerHandle lh, ClientContext clientCtx, long startEntryId, long endEntryId, BookkeeperInternalCallbacks.ReadEntryListener cb, Object ctx)
(package private)	SingleFragmentCallback(org.apache.zookeeper.AsyncCallback.VoidCallback ledgerFragmentsMcb, LedgerHandle lh, LedgerManager ledgerManager, long fragmentStartId, Map<BookieId,BookieId> oldBookie2NewBookie)
(package private)	TryReadLastConfirmedOp(LedgerHandle lh, BookieClient bookieClient, List<BookieId> ensemble, ReadLastConfirmedOp.LastConfirmedDataCallback cb, long lac)

Constructor parameters in org.apache.bookkeeper.client with type arguments of type LedgerHandle

Modifier	Constructor	Description
	SyncCreateCallback(CompletableFuture<? super LedgerHandle> future)
	SyncOpenCallback(CompletableFuture<? super LedgerHandle> future)

Uses of LedgerHandle in org.apache.bookkeeper.proto

Methods in org.apache.bookkeeper.proto with parameters of type LedgerHandle

Modifier and Type	Method	Description
void	BookkeeperInternalCallbacks.ReadEntryListener.onEntryComplete(int rc, LedgerHandle lh, LedgerEntry entry, Object ctx)	On given entry completed.

Uses of LedgerHandle in org.apache.bookkeeper.replication

Methods in org.apache.bookkeeper.replication with parameters of type LedgerHandle

Modifier and Type	Method	Description
(package private) Set<LedgerFragment>	ReplicationWorker.getUnderreplicatedFragments(LedgerHandle lh, Long ledgerVerificationPercentage)	Gets the under replicated fragments.

Uses of LedgerHandle in org.apache.bookkeeper.streaming

Constructors in org.apache.bookkeeper.streaming with parameters of type LedgerHandle

Modifier	Constructor	Description
	LedgerInputStream(LedgerHandle lh)	construct a outputstream from a ledger handle.
	LedgerInputStream(LedgerHandle lh, int size)	construct a outputstream from a ledger handle.
	LedgerOutputStream(LedgerHandle lh)	construct a outputstream from a ledger handle.
	LedgerOutputStream(LedgerHandle lh, int size)	construct a outputstream from a ledger handle.

Uses of LedgerHandle in org.apache.bookkeeper.tools.cli.commands.bookie

Methods in org.apache.bookkeeper.tools.cli.commands.bookie with parameters of type LedgerHandle

Modifier and Type	Method	Description
static void	SanityTestCommand.close(BookKeeper bk, LedgerHandle lh)