Package org.apache.bookkeeper.mledger

Interface ManagedLedgerFactory

All Known Implementing Classes:

ManagedLedgerFactoryImpl

@LimitedPrivate
@Stable
public interface ManagedLedgerFactory

A factory to open/create managed ledgers and delete them.

Method Summary

Modifier and Type	Method	Description
void	asyncDelete(String name, CompletableFuture<ManagedLedgerConfig> mlConfigFuture, AsyncCallbacks.DeleteLedgerCallback callback, Object ctx)	Delete a managed ledger.
void	asyncDelete(String name, AsyncCallbacks.DeleteLedgerCallback callback, Object ctx)	Delete a managed ledger.
CompletableFuture<Boolean>	asyncExists(String ledgerName)	Check managed ledger has been initialized before.
void	asyncGetManagedLedgerInfo(String name, AsyncCallbacks.ManagedLedgerInfoCallback callback, Object ctx)	Asynchronously get the current metadata info for a managed ledger.
void	asyncOpen(String name, AsyncCallbacks.OpenLedgerCallback callback, Object ctx)	Asynchronous open method.
void	asyncOpen(String name, ManagedLedgerConfig config, AsyncCallbacks.OpenLedgerCallback callback, Supplier<CompletableFuture<Boolean>> mlOwnershipChecker, Object ctx)	Asynchronous open method.
void	asyncOpenReadOnlyCursor(String managedLedgerName, Position startPosition, ManagedLedgerConfig config, AsyncCallbacks.OpenReadOnlyCursorCallback callback, Object ctx)	Open a ReadOnlyCursor positioned to the earliest entry for the specified managed ledger.
void	asyncOpenReadOnlyManagedLedger(String managedLedgerName, AsyncCallbacks.OpenReadOnlyManagedLedgerCallback callback, ManagedLedgerConfig config, Object ctx)	Asynchronous open a Read-only managedLedger.
void	delete(String name)	Delete a managed ledger.
void	delete(String name, CompletableFuture<ManagedLedgerConfig> mlConfigFuture)	Delete a managed ledger.
long	getCacheEvictionTimeThreshold()
EntryCacheManager	getEntryCacheManager()
ManagedLedgerInfo	getManagedLedgerInfo(String name)	Get the current metadata info for a managed ledger.
CompletableFuture<Map<String,String>>	getManagedLedgerPropertiesAsync(String name)
ManagedLedger	open(String name)	Open a managed ledger.
ManagedLedger	open(String name, ManagedLedgerConfig config)	Open a managed ledger.
ReadOnlyCursor	openReadOnlyCursor(String managedLedgerName, Position startPosition, ManagedLedgerConfig config)	Open a ReadOnlyCursor positioned to the earliest entry for the specified managed ledger.
void	shutdown()	Releases all the resources maintained by the ManagedLedgerFactory.
CompletableFuture<Void>	shutdownAsync()	This method tries it's best to releases all the resources maintained by the ManagedLedgerFactory.
void	updateCacheEvictionTimeThreshold(long cacheEvictionTimeThresholdNanos)	update cache evictionTimeThreshold.

Method Details

open

ManagedLedger open(String name)
            throws InterruptedException,
ManagedLedgerException

Open a managed ledger. If the managed ledger does not exist, a new one will be automatically created. Uses the default configuration parameters.

Parameters:

name - the unique name that identifies the managed ledger

Returns:

the managed ledger

Throws:

ManagedLedgerException

InterruptedException

open

ManagedLedger open(String name,
 ManagedLedgerConfig config)
            throws InterruptedException,
ManagedLedgerException

Open a managed ledger. If the managed ledger does not exist, a new one will be automatically created.

Parameters:

name - the unique name that identifies the managed ledger

config - managed ledger configuration

Returns:

the managed ledger

Throws:

ManagedLedgerException

InterruptedException

asyncOpen

void asyncOpen(String name,
 AsyncCallbacks.OpenLedgerCallback callback,
 Object ctx)

Asynchronous open method.

Parameters:

name - the unique name that identifies the managed ledger

callback - callback object

ctx - opaque context

See Also:

• open(String)

asyncOpen

void asyncOpen(String name,
 ManagedLedgerConfig config,
 AsyncCallbacks.OpenLedgerCallback callback,
 Supplier<CompletableFuture<Boolean>> mlOwnershipChecker,
 Object ctx)

Asynchronous open method.

Parameters:

name - the unique name that identifies the managed ledger

config - managed ledger configuration

callback - callback object

mlOwnershipChecker - checks ml-ownership in case updating ml-metadata fails due to ownership conflict

ctx - opaque context

See Also:

• open(String, ManagedLedgerConfig)

openReadOnlyCursor

ReadOnlyCursor openReadOnlyCursor(String managedLedgerName,
 Position startPosition,
 ManagedLedgerConfig config)
                           throws InterruptedException,
ManagedLedgerException

Open a ReadOnlyCursor positioned to the earliest entry for the specified managed ledger.

Parameters:

managedLedgerName -

startPosition - set the cursor on that particular position. If setting to `PositionImpl.earliest` it will be positioned on the first available entry.

Returns:

Throws:

InterruptedException

ManagedLedgerException

asyncOpenReadOnlyCursor

void asyncOpenReadOnlyCursor(String managedLedgerName,
 Position startPosition,
 ManagedLedgerConfig config,
 AsyncCallbacks.OpenReadOnlyCursorCallback callback,
 Object ctx)

Open a ReadOnlyCursor positioned to the earliest entry for the specified managed ledger.

Parameters:

managedLedgerName -

startPosition - set the cursor on that particular position. If setting to `PositionImpl.earliest` it will be positioned on the first available entry.

callback -

ctx -

asyncOpenReadOnlyManagedLedger

void asyncOpenReadOnlyManagedLedger(String managedLedgerName,
 AsyncCallbacks.OpenReadOnlyManagedLedgerCallback callback,
 ManagedLedgerConfig config,
 Object ctx)

Asynchronous open a Read-only managedLedger.

Parameters:

managedLedgerName - the unique name that identifies the managed ledger

callback -

config - the managed ledger configuration.

ctx - opaque context

getManagedLedgerInfo

ManagedLedgerInfo getManagedLedgerInfo(String name)
                                throws InterruptedException,
ManagedLedgerException

Get the current metadata info for a managed ledger.

Parameters:

name - the unique name that identifies the managed ledger

Throws:

InterruptedException

ManagedLedgerException

asyncGetManagedLedgerInfo

void asyncGetManagedLedgerInfo(String name,
 AsyncCallbacks.ManagedLedgerInfoCallback callback,
 Object ctx)

Asynchronously get the current metadata info for a managed ledger.

Parameters:

name - the unique name that identifies the managed ledger

callback - callback object

ctx - opaque context

delete

void delete(String name)
     throws InterruptedException,
ManagedLedgerException

Delete a managed ledger. If it's not open, it's metadata will get regardless deleted.

Parameters:

name -

Throws:

InterruptedException

ManagedLedgerException

delete

void delete(String name,
 CompletableFuture<ManagedLedgerConfig> mlConfigFuture)
     throws InterruptedException,
ManagedLedgerException

Delete a managed ledger. If it's not open, it's metadata will get regardless deleted.

Parameters:

name -

Throws:

InterruptedException

ManagedLedgerException

asyncDelete

void asyncDelete(String name,
 AsyncCallbacks.DeleteLedgerCallback callback,
 Object ctx)

Delete a managed ledger. If it's not open, it's metadata will get regardless deleted.

Parameters:

name -

Throws:

InterruptedException

ManagedLedgerException

asyncDelete

void asyncDelete(String name,
 CompletableFuture<ManagedLedgerConfig> mlConfigFuture,
 AsyncCallbacks.DeleteLedgerCallback callback,
 Object ctx)

Delete a managed ledger. If it's not open, it's metadata will get regardless deleted.

Parameters:

name -

Throws:

InterruptedException

ManagedLedgerException

shutdown

void shutdown()
       throws InterruptedException,
ManagedLedgerException

Releases all the resources maintained by the ManagedLedgerFactory.

Throws:

ManagedLedgerException

InterruptedException

shutdownAsync

CompletableFuture<Void> shutdownAsync()
                               throws ManagedLedgerException,
InterruptedException

This method tries it's best to releases all the resources maintained by the ManagedLedgerFactory. It will take longer time to shutdown than shutdown();

Throws:

ManagedLedgerException

InterruptedException

See Also:

• shutdown()

asyncExists

CompletableFuture<Boolean> asyncExists(String ledgerName)

Check managed ledger has been initialized before.

Parameters:

ledgerName - String

Returns:

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

getEntryCacheManager

EntryCacheManager getEntryCacheManager()

Returns:

return EntryCacheManager.

updateCacheEvictionTimeThreshold

void updateCacheEvictionTimeThreshold(long cacheEvictionTimeThresholdNanos)

update cache evictionTimeThreshold.

Parameters:

cacheEvictionTimeThresholdNanos - time threshold for eviction.

getCacheEvictionTimeThreshold

long getCacheEvictionTimeThreshold()

Returns:

time threshold for eviction.

getManagedLedgerPropertiesAsync

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

Returns:

properties of this managedLedger.