Package org.apache.bookkeeper.mledger.impl

Interface MetaStore

All Known Implementing Classes:

MetaStoreImpl

public interface MetaStore

Interface that describes the operations that the ManagedLedger need to do on the metadata store.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MetaStore.MetaStoreCallback<T>
static interface	MetaStore.UpdateCallback<T>
static interface	MetaStore.UpdateLedgersIdsCallback

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	asyncExists(String ledgerName)	Check ledger exists.
void	asyncGetCursorInfo(String ledgerName, String cursorName, MetaStore.MetaStoreCallback<MLDataFormats.ManagedCursorInfo> callback)	Get the ledger id associated with a cursor.
void	asyncRemoveCursor(String ledgerName, String cursorName, MetaStore.MetaStoreCallback<Void> callback)	Drop the persistent state of a consumer from the metadata store.
void	asyncUpdateCursorInfo(String ledgerName, String cursorName, MLDataFormats.ManagedCursorInfo info, Stat stat, MetaStore.MetaStoreCallback<Void> callback)	Update the persisted position of a cursor.
void	asyncUpdateLedgerIds(String ledgerName, MLDataFormats.ManagedLedgerInfo mlInfo, Stat stat, MetaStore.MetaStoreCallback<Void> callback)
void	getCursors(String ledgerName, MetaStore.MetaStoreCallback<List<String>> callback)	Get the list of cursors registered on a ManagedLedger.
void	getManagedLedgerInfo(String ledgerName, boolean createIfMissing, Map<String,String> properties, MetaStore.MetaStoreCallback<MLDataFormats.ManagedLedgerInfo> callback)	Get the metadata used by the ManagedLedger.
default void	getManagedLedgerInfo(String ledgerName, boolean createIfMissing, MetaStore.MetaStoreCallback<MLDataFormats.ManagedLedgerInfo> callback)	Get the metadata used by the ManagedLedger.
CompletableFuture<Map<String,String>>	getManagedLedgerPropertiesAsync(String name)	Get managed ledger properties from meta store.
Iterable<String>	getManagedLedgers()	Get a list of all the managed ledgers in the system.
void	removeManagedLedger(String ledgerName, MetaStore.MetaStoreCallback<Void> callback)	Drop the persistent state for the ManagedLedger and all its associated consumers.
void	unwatchManagedLedgerInfo(String ledgerName)	Unwatch the metadata changes for ledgerName.
void	watchManagedLedgerInfo(String ledgerName, MetaStore.UpdateCallback<MLDataFormats.ManagedLedgerInfo> callback)	Watch the metadata used by the ManagedLedger.

Method Details

getManagedLedgerInfo

default void getManagedLedgerInfo(String ledgerName,
 boolean createIfMissing,
 MetaStore.MetaStoreCallback<MLDataFormats.ManagedLedgerInfo> callback)

Get the metadata used by the ManagedLedger.

Parameters:

ledgerName - the name of the ManagedLedger

createIfMissing - whether the managed ledger metadata should be created if it doesn't exist already

Throws:

ManagedLedgerException.MetaStoreException

getManagedLedgerInfo

void getManagedLedgerInfo(String ledgerName,
 boolean createIfMissing,
 Map<String,String> properties,
 MetaStore.MetaStoreCallback<MLDataFormats.ManagedLedgerInfo> callback)

Get the metadata used by the ManagedLedger.

Parameters:

ledgerName - the name of the ManagedLedger

createIfMissing - whether the managed ledger metadata should be created if it doesn't exist already

properties - ledger properties

Throws:

ManagedLedgerException.MetaStoreException

watchManagedLedgerInfo

void watchManagedLedgerInfo(String ledgerName,
 MetaStore.UpdateCallback<MLDataFormats.ManagedLedgerInfo> callback)

Watch the metadata used by the ManagedLedger.

Parameters:

ledgerName -

callback -

unwatchManagedLedgerInfo

void unwatchManagedLedgerInfo(String ledgerName)

Unwatch the metadata changes for ledgerName.

Parameters:

ledgerName -

asyncUpdateLedgerIds

void asyncUpdateLedgerIds(String ledgerName,
 MLDataFormats.ManagedLedgerInfo mlInfo,
 Stat stat,
 MetaStore.MetaStoreCallback<Void> callback)

Parameters:

ledgerName - the name of the ManagedLedger

mlInfo - managed ledger info

stat - version object associated with current state

callback - callback object

getCursors

void getCursors(String ledgerName,
 MetaStore.MetaStoreCallback<List<String>> callback)

Get the list of cursors registered on a ManagedLedger.

Parameters:

ledgerName - the name of the ManagedLedger

asyncGetCursorInfo

void asyncGetCursorInfo(String ledgerName,
 String cursorName,
 MetaStore.MetaStoreCallback<MLDataFormats.ManagedCursorInfo> callback)

Get the ledger id associated with a cursor.

This ledger id will contains the mark-deleted position for the cursor.

Parameters:

ledgerName -

cursorName -

callback -

asyncUpdateCursorInfo

void asyncUpdateCursorInfo(String ledgerName,
 String cursorName,
 MLDataFormats.ManagedCursorInfo info,
 Stat stat,
 MetaStore.MetaStoreCallback<Void> callback)

Update the persisted position of a cursor.

Parameters:

ledgerName - the name of the ManagedLedger

cursorName -

info -

stat -

callback - the callback

Throws:

ManagedLedgerException.MetaStoreException

asyncRemoveCursor

void asyncRemoveCursor(String ledgerName,
 String cursorName,
 MetaStore.MetaStoreCallback<Void> callback)

Drop the persistent state of a consumer from the metadata store.

Parameters:

ledgerName - the name of the ManagedLedger

cursorName - the cursor name

callback - callback object

removeManagedLedger

void removeManagedLedger(String ledgerName,
 MetaStore.MetaStoreCallback<Void> callback)

Drop the persistent state for the ManagedLedger and all its associated consumers.

Parameters:

ledgerName - the name of the ManagedLedger

callback - callback object

getManagedLedgers

Iterable<String> getManagedLedgers()
                            throws ManagedLedgerException.MetaStoreException

Get a list of all the managed ledgers in the system.

Returns:

an Iterable of the names of the managed ledgers

Throws:

ManagedLedgerException.MetaStoreException

asyncExists

CompletableFuture<Boolean> asyncExists(String ledgerName)

Check ledger exists.

Parameters:

ledgerName - String

Returns:

a future represents the result of the operation. an instance of Boolean is returned if the operation succeeds.

getManagedLedgerPropertiesAsync

CompletableFuture<Map<String,String>> getManagedLedgerPropertiesAsync(String name)

Get managed ledger properties from meta store.

Parameters:

name - ledgerName

Returns:

a future represents the result of the operation.