org.apache.bookkeeper.mledger.intercept

Interface ManagedLedgerInterceptor

@InterfaceAudience.LimitedPrivate
 @InterfaceStability.Stable
public interface ManagedLedgerInterceptor

Interceptor for ManagedLedger.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ManagedLedgerInterceptor.PayloadProcessorHandle A reference handle to the payload processor

Method Summary

Modifier and Type	Method and Description
OpAddEntry	beforeAddEntry(OpAddEntry op, int numberOfMessages) Intercept an OpAddEntry and return an OpAddEntry.
CompletableFuture<Void>	onManagedLedgerLastLedgerInitialize(String name, LedgerHandle ledgerHandle) Intercept when ManagedLedger is initialized.
void	onManagedLedgerPropertiesInitialize(Map<String,String> propertiesMap) Intercept when ManagedLedger is initialized.
void	onUpdateManagedLedgerInfo(Map<String,String> propertiesMap)
default ManagedLedgerInterceptor.PayloadProcessorHandle	processPayloadBeforeEntryCache(io.netty.buffer.ByteBuf dataReadFromLedger) Intercept after entry is read from ledger, before it gets cached.
default ManagedLedgerInterceptor.PayloadProcessorHandle	processPayloadBeforeLedgerWrite(OpAddEntry ledgerWriteOp, io.netty.buffer.ByteBuf dataToBeStoredInLedger) Intercept before payload gets written to ledger

Method Detail

beforeAddEntry

OpAddEntry beforeAddEntry(OpAddEntry op,
                          int numberOfMessages)

Intercept an OpAddEntry and return an OpAddEntry.

Parameters:

op - an OpAddEntry to be intercepted.

numberOfMessages -

Returns:

an OpAddEntry.

onManagedLedgerPropertiesInitialize

void onManagedLedgerPropertiesInitialize(Map<String,String> propertiesMap)

Intercept when ManagedLedger is initialized.

Parameters:

propertiesMap - map of properties.

onManagedLedgerLastLedgerInitialize

CompletableFuture<Void> onManagedLedgerLastLedgerInitialize(String name,
                                                            LedgerHandle ledgerHandle)

Intercept when ManagedLedger is initialized.

Parameters:

name - name of ManagedLedger

ledgerHandle - a LedgerHandle.

onUpdateManagedLedgerInfo

void onUpdateManagedLedgerInfo(Map<String,String> propertiesMap)

Parameters:

propertiesMap - map of properties.

processPayloadBeforeEntryCache

default ManagedLedgerInterceptor.PayloadProcessorHandle processPayloadBeforeEntryCache(io.netty.buffer.ByteBuf dataReadFromLedger)

Intercept after entry is read from ledger, before it gets cached.

Parameters:

dataReadFromLedger - data from ledger

Returns:

handle to the processor

processPayloadBeforeLedgerWrite

default ManagedLedgerInterceptor.PayloadProcessorHandle processPayloadBeforeLedgerWrite(OpAddEntry ledgerWriteOp,
                                                                                        io.netty.buffer.ByteBuf dataToBeStoredInLedger)

Intercept before payload gets written to ledger

Parameters:

ledgerWriteOp - OpAddEntry used to trigger ledger write.

dataToBeStoredInLedger - data to be stored in ledger

Returns:

handle to the processor