Package org.apache.bookkeeper.meta
Class CleanupLedgerManager
java.lang.Object
org.apache.bookkeeper.meta.CleanupLedgerManager
- All Implemented Interfaces:
Closeable,AutoCloseable,LedgerManager
A ledger manager that cleans up resources upon closing.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.bookkeeper.meta.LedgerManager
LedgerManager.LedgerRange, LedgerManager.LedgerRangeIterator -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidasyncProcessLedgers(BookkeeperInternalCallbacks.Processor<Long> processor, org.apache.zookeeper.AsyncCallback.VoidCallback finalCb, Object context, int successRc, int failureRc) Loop to process all ledgers.voidclose()createLedgerMetadata(long lid, LedgerMetadata metadata) Create a new ledger with provided ledger id and metadata.(package private) intgetLedgerRanges(long zkOpTimeoutMs) Loop to scan a range of metadata from metadata storage.readLedgerMetadata(long ledgerId) Read ledger metadata of a specified ledger.voidregisterLedgerMetadataListener(long ledgerId, BookkeeperInternalCallbacks.LedgerMetadataListener listener) Register the ledger metadata listener on ledgerId.removeLedgerMetadata(long ledgerId, Version version) Remove a specified ledger metadata by ledgerId and version.voidunregisterLedgerMetadataListener(long ledgerId, BookkeeperInternalCallbacks.LedgerMetadataListener listener) Unregister the ledger metadata listener on ledgerId.writeLedgerMetadata(long ledgerId, LedgerMetadata metadata, Version currentVersion) Write ledger metadata.
-
Constructor Details
-
CleanupLedgerManager
-
-
Method Details
-
getUnderlying
-
registerLedgerMetadataListener
public void registerLedgerMetadataListener(long ledgerId, BookkeeperInternalCallbacks.LedgerMetadataListener listener) Description copied from interface:LedgerManagerRegister the ledger metadata listener on ledgerId.- Specified by:
registerLedgerMetadataListenerin interfaceLedgerManager- Parameters:
ledgerId- ledger id.listener- listener.
-
unregisterLedgerMetadataListener
public void unregisterLedgerMetadataListener(long ledgerId, BookkeeperInternalCallbacks.LedgerMetadataListener listener) Description copied from interface:LedgerManagerUnregister the ledger metadata listener on ledgerId.- Specified by:
unregisterLedgerMetadataListenerin interfaceLedgerManager- Parameters:
ledgerId- ledger id.listener- ledger metadata listener.
-
getCurrentFuturePromiseSize
int getCurrentFuturePromiseSize() -
createLedgerMetadata
public CompletableFuture<Versioned<LedgerMetadata>> createLedgerMetadata(long lid, LedgerMetadata metadata) Description copied from interface:LedgerManagerCreate a new ledger with provided ledger id and metadata.- Specified by:
createLedgerMetadatain interfaceLedgerManager- Parameters:
lid- Ledger id provided to be createdmetadata- Metadata provided when creating the new ledger- Returns:
- Future which, when completed returns the metadata of the newly created ledger.
Completed with an exception:
BKException.BKLedgerExistExceptionif given ledger id existBKException.ZKException/BKException.BKMetadataSerializationExceptionfor other issues
-
removeLedgerMetadata
Description copied from interface:LedgerManagerRemove a specified ledger metadata by ledgerId and version.- Specified by:
removeLedgerMetadatain interfaceLedgerManager- Parameters:
ledgerId- Ledger Idversion- Ledger metadata version- Returns:
- Future which, when completed, denotes that the ledger metadata has been removed.
Completed with an exception:
BKException.BKMetadataVersionExceptionif version doesn't matchBKException.BKNoSuchLedgerExistsOnMetadataServerExceptionif ledger not existBKException.ZKExceptionfor other issues
-
readLedgerMetadata
Description copied from interface:LedgerManagerRead ledger metadata of a specified ledger.- Specified by:
readLedgerMetadatain interfaceLedgerManager- Parameters:
ledgerId- Ledger Id- Returns:
- Future which, when completed, contains the requested versioned metadata.
Completed with an exception::
BKException.BKNoSuchLedgerExistsOnMetadataServerExceptionif ledger not existBKException.ZKExceptionfor other issues
-
writeLedgerMetadata
public CompletableFuture<Versioned<LedgerMetadata>> writeLedgerMetadata(long ledgerId, LedgerMetadata metadata, Version currentVersion) Description copied from interface:LedgerManagerWrite ledger metadata.- Specified by:
writeLedgerMetadatain interfaceLedgerManager- Parameters:
ledgerId- Ledger Idmetadata- Ledger Metadata to writecurrentVersion- The version of the metadata we expect to be overwriting.- Returns:
- Future which, when completed, contains the newly written metadata.
Completed with an exception:
BKException.BKMetadataVersionExceptionif version in metadata doesn't matchBKException.ZKExceptionfor other issue
-
asyncProcessLedgers
public void asyncProcessLedgers(BookkeeperInternalCallbacks.Processor<Long> processor, org.apache.zookeeper.AsyncCallback.VoidCallback finalCb, Object context, int successRc, int failureRc) Description copied from interface:LedgerManagerLoop to process all ledgers.-
After all ledgers were processed, finalCb will be triggered:
- if all ledgers are processed done with OK, success rc will be passed to finalCb.
- if some ledgers are processed failed, failure rc will be passed to finalCb.
- Specified by:
asyncProcessLedgersin interfaceLedgerManager- Parameters:
processor- Ledger Processor to process a specific ledgerfinalCb- Callback triggered after all ledgers are processedcontext- Context of final callbacksuccessRc- Success RC code passed to finalCb when callbackfailureRc- Failure RC code passed to finalCb when exceptions occurred.
-
getLedgerRanges
Description copied from interface:LedgerManagerLoop to scan a range of metadata from metadata storage.- Specified by:
getLedgerRangesin interfaceLedgerManager- Parameters:
zkOpTimeoutMs- Iterator considers timeout while fetching ledger-range from zk.- Returns:
- will return a iterator of the Ranges
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException
-