Package org.apache.bookkeeper.client

BookKeeper Client.

Interface Summary

Interface	Description
AsyncCallback	Defines all the callback interfaces for the async operations in bookkeeper client.
AsyncCallback.AddCallback	Async Callback for adding entries to ledgers.
AsyncCallback.AddCallbackWithLatency	Async Callback for adding entries to ledgers with latency information.
AsyncCallback.AddLacCallback	Async Callback for updating LAC for ledgers.
AsyncCallback.CloseCallback	Async Callback for closing ledgers.
AsyncCallback.CreateCallback	Async Callback for creating ledgers.
AsyncCallback.DeleteCallback	Async Callback for deleting ledgers.
AsyncCallback.IsClosedCallback	Async Callback for checking if a ledger is closed.
AsyncCallback.OpenCallback	Async Callback for opening ledgers.
AsyncCallback.ReadCallback	Async Callback for reading entries from ledgers.
AsyncCallback.ReadLastConfirmedAndEntryCallback	Async Callback for long polling read request.
AsyncCallback.ReadLastConfirmedCallback	Async Callback for reading LAC for ledgers.
AsyncCallback.RecoverCallback	Async Callback for recovering ledgers.
BKException.Code	Legacy interface which holds constants for BookKeeper error codes.
BookiesHealthInfo	This interface returns heuristics used to determine the health of a Bookkeeper server for read ordering.
BookiesListener	Listener for the available bookies changes.
BookieWatcher	Watch for Bookkeeper cluster status.
BookKeeperClientStats	List of constants for defining client stats names.
ClientContext	Collection of client objects used by LedgerHandle to interact with the outside world.
DistributionSchedule	This interface determines how entries are distributed among bookies.
DistributionSchedule.AckSet	An ack set represents the set of bookies from which a response must be received so that an entry can be considered to be replicated on a quorum.
DistributionSchedule.QuorumCoverageSet	Interface to keep track of which bookies in an ensemble, an action has been performed for.
DistributionSchedule.WriteSet	A write set represents the set of bookies to which a request will be written.
EnsemblePlacementPolicy	EnsemblePlacementPolicy encapsulates the algorithm that bookkeeper client uses to select a number of bookies from the cluster as an ensemble for storing entries.
ExplicitLacFlushPolicy
ITopologyAwareEnsemblePlacementPolicy<T extends Node>	Interface for topology aware ensemble placement policy.
ITopologyAwareEnsemblePlacementPolicy.Ensemble<T extends Node>	Ensemble used to hold the result of an ensemble selected for placement.
ITopologyAwareEnsemblePlacementPolicy.Predicate<T extends Node>	Predicate used when choosing an ensemble.
MetadataUpdateLoop.LocalValueUpdater
MetadataUpdateLoop.MetadataTransform
MetadataUpdateLoop.NeedsUpdatePredicate
PendingReadLacOp.LacCallback
RackChangeNotifier	Notifier used by the RackawareEnsemblePlacementPolicy to get notified if a rack changes for a bookie.
ReadLastConfirmedAndEntryOp.LastConfirmedAndEntryCallback	Wrapper to get all recovered data from the request.
ReadLastConfirmedOp.LastConfirmedDataCallback	Wrapper to get all recovered data from the request.
SpeculativeRequestExecutionPolicy	Define a policy for speculative request execution.
SpeculativeRequestExecutor	Define an executor for issuing speculative requests.
TopologyAwareEnsemblePlacementPolicy.RRTopologyAwareCoverageEnsemble.CoverageSet
WeightedRandomSelection<T>
WeightedRandomSelection.WeightedObject

Class Summary

Class	Description
BatchedReadOp
BookieAddressResolverDisabled	Resolve legacy style BookieIDs to Network addresses.
BookieInfoReader	A utility class to read BookieInfoReader.BookieInfo from bookies.
BookieInfoReader.BookieInfo	A class represents the information (e.g.
BookieWatcherImpl	This class is responsible for maintaining a consistent view of what bookies are available by reading Zookeeper (and setting watches on the bookie nodes).
BookKeeper	BookKeeper client.
BookKeeper.Builder	BookKeeper Client Builder to build client instances.
BookKeeperAdmin	Admin client for BookKeeper clusters.
BookKeeperAdmin.ResultCallBack	This is the class for getting the replication result.
BookKeeperAdmin.SyncObject
ClientInternalConf
DefaultBookieAddressResolver	Resolve BookieIDs to Network addresses.
DefaultEnsemblePlacementPolicy	Default Ensemble Placement Policy, which picks bookies randomly.
DefaultSpeculativeRequestExecutionPolicy	A default implementation of SpeculativeRequestExecutionPolicy.
DynamicWeightedRandomSelectionImpl<T>	DynamicWeightedRandomSelectionImpl class implements both getNextRandom overloaded methods.
EnsemblePlacementPolicy.PlacementResult<T>	Result of a placement calculation against a placement policy.
EnsembleUtils
ExplicitLacFlushPolicy.ExplicitLacFlushPolicyImpl
ForceLedgerOp	This represents a request to sync the ledger on every bookie.
LedgerChecker	A utility class to check the complete ledger and finds the UnderReplicated fragments if any.
LedgerCreateOp	Encapsulates asynchronous ledger create operation.
LedgerCreateOp.CreateBuilderImpl
LedgerDeleteOp	Encapsulates asynchronous ledger delete operation.
LedgerDeleteOp.DeleteBuilderImpl
LedgerEntry	Ledger entry.
LedgerFragment	Represents the entries of a segment of a ledger which are stored on subset of bookies in the segments bookie ensemble.
LedgerFragmentReplicator	This is the helper class for replicating the fragments from one bookie to another.
LedgerFragmentReplicator.SingleFragmentCallback	Callback for recovery of a single ledger fragment.
LedgerFragmentReplicator.Throttler
LedgerHandle	Ledger handle contains ledger metadata and is used to access the read and write operations to a ledger.
LedgerHandle.LastConfirmedCtx	Context objects for synchronous call to read last confirmed.
LedgerHandle.NoopCloseCallback
LedgerHandleAdv	Ledger Advanced handle extends LedgerHandle to provide API to add entries with user supplied entryIds.
LedgerHandleAdv.PendingOpsComparator
LedgerMetadataBuilder	Builder for building LedgerMetadata objects.
LedgerMetadataImpl	This class encapsulates all the ledger metadata that is persistently stored in metadata store.
LedgerMetadataUtils	Utilities for working with ledger metadata.
LedgerOpenOp	Encapsulates the ledger open operation.
LedgerOpenOp.OpenBuilderImpl
LedgerRecoveryOp	This class encapsulated the ledger recovery operation.
ListenerBasedPendingReadOp
MetadataUpdateLoop	Mechanism to safely update the metadata of a ledger.
PendingAddOp	This represents a pending add operation.
PendingReadLacOp	This represents a pending ReadLac operation.
PendingReadOp	Sequence of entries of a ledger that represents a pending read operation.
PendingWriteLacOp	This represents a pending WriteLac operation.
RackawareEnsemblePlacementPolicy	A placement policy implementation use rack information for placing ensembles.
RackawareEnsemblePlacementPolicyImpl	Simple rackware ensemble placement policy.
ReadLastConfirmedAndEntryOp	Long poll read operation.
ReadLastConfirmedOp	This class encapsulated the read last confirmed operation.
ReadOnlyLedgerHandle	Read only ledger handle.
ReadOpBase
ReadOpBase.ReadContext
RegionAwareEnsemblePlacementPolicy	A placement policy use region information in the network topology for placing ensembles.
RoundRobinDistributionSchedule	A specific DistributionSchedule that places entries in round-robin fashion.
SyncCallbackUtils	Utility for callbacks.
SyncCallbackUtils.FutureReadLastConfirmed
SyncCallbackUtils.FutureReadLastConfirmedAndEntry
SyncCallbackUtils.LastAddConfirmedCallback
SyncCallbackUtils.SyncAddCallback
SyncCallbackUtils.SyncCloseCallback
SyncCallbackUtils.SyncCreateAdvCallback
SyncCallbackUtils.SyncCreateCallback
SyncCallbackUtils.SyncDeleteCallback
SyncCallbackUtils.SyncOpenCallback
SyncCallbackUtils.SyncReadCallback
SyncCallbackUtils.SyncReadLastConfirmedCallback
SyncCounter	Implements objects to help with the synchronization of asynchronous calls.
TopologyAwareEnsemblePlacementPolicy
TopologyAwareEnsemblePlacementPolicy.DefaultResolver
TopologyAwareEnsemblePlacementPolicy.DNSResolverDecorator	Decorator for any existing dsn resolver.
TopologyAwareEnsemblePlacementPolicy.EnsembleForReplacementWithNoConstraints
TopologyAwareEnsemblePlacementPolicy.RRTopologyAwareCoverageEnsemble	A predicate checking the rack coverage for write quorum in RoundRobinDistributionSchedule, which ensures that a write quorum should be covered by at least two racks.
TopologyAwareEnsemblePlacementPolicy.TruePredicate
TryReadLastConfirmedOp	This op is try to read last confirmed without involving quorum coverage checking.
UpdateLedgerOp	Encapsulates updating the ledger metadata operation.
WeightedRandomSelectionImpl<T>
ZoneawareEnsemblePlacementPolicy	A placement policy implementation use zone information for placing ensembles.
ZoneawareEnsemblePlacementPolicyImpl	Simple zoneaware ensemble placement policy.
ZoneawareEnsemblePlacementPolicyImpl.ZoneAwareNodeLocation	Zone and UpgradeDomain pair of a node.

Enum Summary

Enum	Description
BookieInfoReader.State	Tracks whether there is an execution in progress as well as whether another is pending.
BookKeeper.DigestType	There are 3 digest types that can be used for verification.
EnsemblePlacementPolicy.PlacementPolicyAdherence	enum for PlacementPolicyAdherence.
LedgerFragment.ReplicateType	ReplicateType.

Exception Summary

Exception	Description
BKException	Class the enumerates all the possible error conditions.
BKException.BKAddEntryQuorumTimeoutException	Bookkeeper add entry quorum timeout exception.
BKException.BKBookieException	Bookkeeper bookie exception.
BKException.BKBookieHandleNotAvailableException	Bookkeeper bookie handle not available exception.
BKException.BKClientClosedException	Bookkeeper client closed exception.
BKException.BKDataUnknownException	Bookkeeper ledger in limbo and data may or may not exist.
BKException.BKDigestMatchException	Bookkeeper digest match exception.
BKException.BKDigestNotInitializedException	Bookkeeper digest not initialized exception.
BKException.BKDuplicateEntryIdException	Bookkeeper duplicate entry id exception.
BKException.BKIllegalOpException	Bookkeeper illegal operation exception.
BKException.BKIncorrectParameterException	Bookkeeper incorrect parameter exception.
BKException.BKInterruptedException	Bookkeeper interrupted exception.
BKException.BKLedgerClosedException	Bookkeeper ledger closed exception.
BKException.BKLedgerExistException	Bookkeeper ledger exist exception.
BKException.BKLedgerFencedException	Bookkeeper ledger fenced exception.
BKException.BKLedgerIdOverflowException	Bookkeeper ledger id overflow exception.
BKException.BKLedgerRecoveryException	Bookkeeper ledger recovery exception.
BKException.BKMetadataSerializationException	Bookkeeper metadata serialization exception.
BKException.BKMetadataVersionException	Bookkeeper metadata version exception.
BKException.BKNoSuchEntryException	Bookkeeper no such entry exception.
BKException.BKNoSuchLedgerExistsException	Bookkeeper no such ledger exists exception.
BKException.BKNoSuchLedgerExistsOnMetadataServerException	Bookkeeper no such ledger exists on metadata server exception.
BKException.BKNotEnoughBookiesException	Bookkeeper not enough bookies exception.
BKException.BKProtocolVersionException	Bookkeeper protocol version exception.
BKException.BKQuorumException	Bookkeeper quorum exception.
BKException.BKReadException	Bookkeeper read exception.
BKException.BKReplicationException	Bookkeeper replication exception.
BKException.BKSecurityException	Bookkeeper security exception.
BKException.BKTimeoutException	Bookkeeper timeout exception.
BKException.BKTooManyRequestsException	Bookkeeper too many requests exception.
BKException.BKUnauthorizedAccessException	Bookkeeper unauthorized access exception.
BKException.BKUnclosedFragmentException	Bookkeeper unclosed fragment exception.
BKException.BKUnexpectedConditionException	Bookkeeper unexpected condition exception.
BKException.BKWriteException	Bookkeeper write exception.
BKException.BKWriteOnReadOnlyBookieException	Bookkeeper write on readonly bookie exception.
BKException.MetaStoreException	Metastore exception.
BKException.ZKException	Zookeeper exception.
LedgerChecker.InvalidFragmentException