Package org.apache.bookkeeper.proto

Classes related to the Bookkeeper protocol.

Interface Summary

Interface	Description
BookieAddressResolver	Maps a logical BookieId to a ResolvedBookieSocketAddress that it to a network address.
BookieClient	Low level client for talking to bookies.
BookieConnectionPeer	Represents the connection to a BookKeeper client, from the Bookie side.
BookieProtocol	The packets of the Bookie protocol all have a 4-byte integer indicating the type of request or response at the very beginning of the packet followed by a payload.
BookieProtoEncoding.EnDecoder	An encoder/decoder interface for the Bookkeeper protocol.
BookkeeperInternalCallbacks.BatchedReadEntryCallback	Declaration of a callback implementation for calls from BookieClient objects.
BookkeeperInternalCallbacks.ForceLedgerCallback	Force callback interface.
BookkeeperInternalCallbacks.GenericCallback<T>	A generic callback interface.
BookkeeperInternalCallbacks.GetBookieInfoCallback	This is a callback interface for fetching metadata about a bookie.
BookkeeperInternalCallbacks.GetListOfEntriesOfLedgerCallback	A callback interface for GetListOfEntriesOfLedger command.
BookkeeperInternalCallbacks.LedgerMetadataListener	Listener on ledger metadata changes.
BookkeeperInternalCallbacks.Processor<T>	Processor to process a specific element.
BookkeeperInternalCallbacks.ReadEntryCallback	Declaration of a callback implementation for calls from BookieClient objects.
BookkeeperInternalCallbacks.ReadEntryCallbackCtx	Declaration of a callback interface for the Last Add Confirmed context of a reader.
BookkeeperInternalCallbacks.ReadEntryListener	Listener on entries responded.
BookkeeperInternalCallbacks.ReadLacCallback	A last-add-confirmed (LAC) reader callback interface.
BookkeeperInternalCallbacks.StartTLSCallback	A callback interface for a STARTTLS command.
BookkeeperInternalCallbacks.WriteCallback	A writer callback interface.
BookkeeperInternalCallbacks.WriteLacCallback	A last-add-confirmed (LAC) writer callback interface.
BookkeeperProtocol.AddRequestOrBuilder
BookkeeperProtocol.AddResponseOrBuilder
BookkeeperProtocol.AuthMessageOrBuilder
BookkeeperProtocol.BKPacketHeaderOrBuilder
BookkeeperProtocol.ContextPairOrBuilder
BookkeeperProtocol.ForceLedgerRequestOrBuilder
BookkeeperProtocol.ForceLedgerResponseOrBuilder
BookkeeperProtocol.GetBookieInfoRequestOrBuilder
BookkeeperProtocol.GetBookieInfoResponseOrBuilder
BookkeeperProtocol.GetListOfEntriesOfLedgerRequestOrBuilder
BookkeeperProtocol.GetListOfEntriesOfLedgerResponseOrBuilder
BookkeeperProtocol.ReadLacRequestOrBuilder
BookkeeperProtocol.ReadLacResponseOrBuilder
BookkeeperProtocol.ReadRequestOrBuilder
BookkeeperProtocol.ReadResponseOrBuilder
BookkeeperProtocol.RequestOrBuilder
BookkeeperProtocol.ResponseOrBuilder
BookkeeperProtocol.StartTLSRequestOrBuilder
BookkeeperProtocol.StartTLSResponseOrBuilder
BookkeeperProtocol.WriteLacRequestOrBuilder
BookkeeperProtocol.WriteLacResponseOrBuilder
ClientConnectionPeer	Represents the connection to a Bookie, from the client side.
ConnectionPeer	Represents the connection to a BookKeeper client, from the Bookie side.
DataFormats.AuditorVoteFormatOrBuilder
DataFormats.BookieServiceInfoFormat.EndpointOrBuilder
DataFormats.BookieServiceInfoFormatOrBuilder
DataFormats.CheckAllLedgersFormatOrBuilder
DataFormats.CookieFormatOrBuilder
DataFormats.LedgerMetadataFormat.cMetadataMapEntryOrBuilder
DataFormats.LedgerMetadataFormat.SegmentOrBuilder
DataFormats.LedgerMetadataFormatOrBuilder
DataFormats.LedgerRereplicationLayoutFormatOrBuilder
DataFormats.LockDataFormatOrBuilder
DataFormats.PlacementPolicyCheckFormatOrBuilder
DataFormats.ReplicasCheckFormatOrBuilder
DataFormats.UnderreplicatedLedgerFormatOrBuilder
PerChannelBookieClientFactory	Factory to create PerChannelBookieClient.
PerChannelBookieClientPool	An interface to manage channel pooling for bookie client.

Class Summary

Class	Description
AuthHandler
AuthHandler.ClientSideHandler
AuthHandler.ServerSideHandler
AuthHandler.ServerSideHandler.AuthResponseCallback
AuthHandler.ServerSideHandler.AuthResponseCallbackLegacy
BatchedReadEntryProcessor
BKStats	Bookie Server Stats.
BKStats.OpStatData	A read view of stats, also used in CompositeViewData to expose to JMX.
BKStats.OpStats	Operation Statistics.
BookieClientImpl	Implements the client-side part of the BookKeeper protocol.
BookieNettyServer	Netty server for serving bookie requests.
BookieProtocol.AddResponse	A response that adds data.
BookieProtocol.AuthRequest	An authentication request.
BookieProtocol.AuthResponse	A response with an authentication message.
BookieProtocol.BatchedReadRequest	The request for reading data with batch optimization.
BookieProtocol.BatchedReadResponse	The response for batched read.
BookieProtocol.ErrorResponse	An error response.
BookieProtocol.PacketHeader	The first int of a packet is the header.
BookieProtocol.ParsedAddRequest	This is similar to add request, but it used when processing the request on the bookie side.
BookieProtocol.ReadRequest	A Request that reads data.
BookieProtocol.ReadResponse	A request that reads data.
BookieProtocol.Request	A Bookie request object.
BookieProtocol.Response	A response object.
BookieProtoEncoding	A class for encoding and decoding the Bookkeeper protocol.
BookieProtoEncoding.RequestDecoder	A request message decoder.
BookieProtoEncoding.RequestEncoder	A request message encoder.
BookieProtoEncoding.RequestEnDeCoderPreV3	An encoder/decoder for the Bookkeeper protocol before version 3.
BookieProtoEncoding.RequestEnDecoderV3	A request encoder/decoder for the Bookkeeper protocol version 3.
BookieProtoEncoding.ResponseDecoder	A response message decoder.
BookieProtoEncoding.ResponseEncoder	A response message encoder.
BookieProtoEncoding.ResponseEnDeCoderPreV3	A response encoder/decoder for the Bookkeeper protocol before version 3.
BookieProtoEncoding.ResponseEnDecoderV3	A response encoder/decoder for the Bookkeeper protocol version 3.
BookieRequestHandler	Serverside handler for bookkeeper requests.
BookieRequestProcessor	An implementation of the RequestProcessor interface.
BookieServer	Implements the server-side part of the BookKeeper protocol.
BookkeeperInternalCallbacks	Declaration of a callback interfaces used in bookkeeper client library but not exposed to the client application.
BookkeeperInternalCallbacks.FutureGetListOfEntriesOfLedger	Future for GetListOfEntriesOfLedger.
BookkeeperInternalCallbacks.GenericCallbackFuture<T>	Generic callback future.
BookkeeperInternalCallbacks.MultiCallback	This is a multi callback object that waits for all of the multiple async operations to complete.
BookkeeperInternalCallbacks.TimedGenericCallback<T>	A callback implementation with an internal timer.
BookkeeperProtocol
BookkeeperProtocol.AddRequest	Protobuf type AddRequest
BookkeeperProtocol.AddRequest.Builder	Protobuf type AddRequest
BookkeeperProtocol.AddResponse	Protobuf type AddResponse
BookkeeperProtocol.AddResponse.Builder	Protobuf type AddResponse
BookkeeperProtocol.AuthMessage	Protobuf type AuthMessage
BookkeeperProtocol.AuthMessage.Builder	Protobuf type AuthMessage
BookkeeperProtocol.BKPacketHeader	Packet header for all requests.
BookkeeperProtocol.BKPacketHeader.Builder	Packet header for all requests.
BookkeeperProtocol.ContextPair	Protobuf type ContextPair
BookkeeperProtocol.ContextPair.Builder	Protobuf type ContextPair
BookkeeperProtocol.ForceLedgerRequest	Protobuf type ForceLedgerRequest
BookkeeperProtocol.ForceLedgerRequest.Builder	Protobuf type ForceLedgerRequest
BookkeeperProtocol.ForceLedgerResponse	Protobuf type ForceLedgerResponse
BookkeeperProtocol.ForceLedgerResponse.Builder	Protobuf type ForceLedgerResponse
BookkeeperProtocol.GetBookieInfoRequest	Protobuf type GetBookieInfoRequest
BookkeeperProtocol.GetBookieInfoRequest.Builder	Protobuf type GetBookieInfoRequest
BookkeeperProtocol.GetBookieInfoResponse	Protobuf type GetBookieInfoResponse
BookkeeperProtocol.GetBookieInfoResponse.Builder	Protobuf type GetBookieInfoResponse
BookkeeperProtocol.GetListOfEntriesOfLedgerRequest	Protobuf type GetListOfEntriesOfLedgerRequest
BookkeeperProtocol.GetListOfEntriesOfLedgerRequest.Builder	Protobuf type GetListOfEntriesOfLedgerRequest
BookkeeperProtocol.GetListOfEntriesOfLedgerResponse	Protobuf type GetListOfEntriesOfLedgerResponse
BookkeeperProtocol.GetListOfEntriesOfLedgerResponse.Builder	Protobuf type GetListOfEntriesOfLedgerResponse
BookkeeperProtocol.ReadLacRequest	Protobuf type ReadLacRequest
BookkeeperProtocol.ReadLacRequest.Builder	Protobuf type ReadLacRequest
BookkeeperProtocol.ReadLacResponse	Protobuf type ReadLacResponse
BookkeeperProtocol.ReadLacResponse.Builder	Protobuf type ReadLacResponse
BookkeeperProtocol.ReadRequest	Protobuf type ReadRequest
BookkeeperProtocol.ReadRequest.Builder	Protobuf type ReadRequest
BookkeeperProtocol.ReadResponse	Protobuf type ReadResponse
BookkeeperProtocol.ReadResponse.Builder	Protobuf type ReadResponse
BookkeeperProtocol.Request	Protobuf type Request
BookkeeperProtocol.Request.Builder	Protobuf type Request
BookkeeperProtocol.Response	Protobuf type Response
BookkeeperProtocol.Response.Builder	Protobuf type Response
BookkeeperProtocol.StartTLSRequest	Protobuf type StartTLSRequest
BookkeeperProtocol.StartTLSRequest.Builder	Protobuf type StartTLSRequest
BookkeeperProtocol.StartTLSResponse	Protobuf type StartTLSResponse
BookkeeperProtocol.StartTLSResponse.Builder	Protobuf type StartTLSResponse
BookkeeperProtocol.WriteLacRequest	Protobuf type WriteLacRequest
BookkeeperProtocol.WriteLacRequest.Builder	Protobuf type WriteLacRequest
BookkeeperProtocol.WriteLacResponse	Protobuf type WriteLacResponse
BookkeeperProtocol.WriteLacResponse.Builder	Protobuf type WriteLacResponse
DataFormats
DataFormats.AuditorVoteFormat	Debug information for auditor votes
DataFormats.AuditorVoteFormat.Builder	Debug information for auditor votes
DataFormats.BookieServiceInfoFormat	information about services exposed by a Bookie.
DataFormats.BookieServiceInfoFormat.Builder	information about services exposed by a Bookie.
DataFormats.BookieServiceInfoFormat.Endpoint	Information about an endpoint.
DataFormats.BookieServiceInfoFormat.Endpoint.Builder	Information about an endpoint.
DataFormats.CheckAllLedgersFormat	information of checkAllLedgers execution
DataFormats.CheckAllLedgersFormat.Builder	information of checkAllLedgers execution
DataFormats.CookieFormat	Cookie format for storing cookie information
DataFormats.CookieFormat.Builder	Cookie format for storing cookie information
DataFormats.LedgerMetadataFormat	Metadata format for storing ledger information
DataFormats.LedgerMetadataFormat.Builder	Metadata format for storing ledger information
DataFormats.LedgerMetadataFormat.cMetadataMapEntry	Protobuf type LedgerMetadataFormat.cMetadataMapEntry
DataFormats.LedgerMetadataFormat.cMetadataMapEntry.Builder	Protobuf type LedgerMetadataFormat.cMetadataMapEntry
DataFormats.LedgerMetadataFormat.Segment	Protobuf type LedgerMetadataFormat.Segment
DataFormats.LedgerMetadataFormat.Segment.Builder	Protobuf type LedgerMetadataFormat.Segment
DataFormats.LedgerRereplicationLayoutFormat	Protobuf type LedgerRereplicationLayoutFormat
DataFormats.LedgerRereplicationLayoutFormat.Builder	Protobuf type LedgerRereplicationLayoutFormat
DataFormats.LockDataFormat	Debug information for locks
DataFormats.LockDataFormat.Builder	Debug information for locks
DataFormats.PlacementPolicyCheckFormat	information of PlacementPolicyCheck execution
DataFormats.PlacementPolicyCheckFormat.Builder	information of PlacementPolicyCheck execution
DataFormats.ReplicasCheckFormat	information of ReplicasCheck execution
DataFormats.ReplicasCheckFormat.Builder	information of ReplicasCheck execution
DataFormats.UnderreplicatedLedgerFormat	Protobuf type UnderreplicatedLedgerFormat
DataFormats.UnderreplicatedLedgerFormat.Builder	Protobuf type UnderreplicatedLedgerFormat
DefaultPerChannelBookieClientPool	Provide a simple round-robin style channel pool.
ForceLedgerProcessorV3
GetBookieInfoProcessorV3	A processor class for v3 bookie metadata packets.
GetListOfEntriesOfLedgerProcessorV3	A processor class for v3 entries of a ledger packets.
LocalBookiesRegistry	Local registry for embedded Bookies.
LongPollReadEntryProcessorV3	Processor handling long poll read entry request.
PacketProcessorBase<T extends BookieProtocol.Request>	A base class for bookeeper packet processors.
PacketProcessorBaseV3	A base class for bookkeeper protocol v3 packet processors.
PerChannelBookieClient	This class manages all details of connection to a particular bookie.
PerChannelBookieClient.ContextPreservingFutureListener	Decorator to preserve MDC for connection listener.
ReadEntryProcessor
ReadEntryProcessorV3
ReadLacProcessorV3	A read processor for v3 last add confirmed messages.
ReadLastConfirmedAndEntryContext	A BookkeeperInternalCallbacks.ReadEntryCallbackCtx for long poll read requests.
RequestStats	A umbrella class for request related stats.
RequestUtils	Utilities for requests.
ResponseBuilder
SimpleBookieServiceInfoProvider	Simple Implementation of BookieServiceInfo supplier.
WriteEntryProcessor	Processes add entry requests.
WriteEntryProcessorV3
WriteLacProcessorV3

Enum Summary

Enum	Description
BookkeeperProtocol.AddRequest.Flag	Protobuf enum AddRequest.Flag
BookkeeperProtocol.GetBookieInfoRequest.Flags	Protobuf enum GetBookieInfoRequest.Flags
BookkeeperProtocol.OperationType	Supported operations by this protocol.
BookkeeperProtocol.ProtocolVersion	Protocol Versions.
BookkeeperProtocol.ReadRequest.Flag	Protobuf enum ReadRequest.Flag
BookkeeperProtocol.StatusCode	Status codes.
DataFormats.LedgerMetadataFormat.DigestType	Protobuf enum LedgerMetadataFormat.DigestType
DataFormats.LedgerMetadataFormat.State	Protobuf enum LedgerMetadataFormat.State
PerChannelBookieClient.ConnectionState

Exception Summary

Exception	Description
AuthHandler.AuthenticationException
BookieAddressResolver.BookieIdNotResolvedException	This error happens when there is not enough information to resolve a BookieId to a BookieSocketAddress, this can happen when the Bookie is down and it is not publishing its EndpointInfo.