Package org.apache.bookkeeper.mledger.impl

Class ManagedLedgerFactoryImpl

java.lang.Object

org.apache.bookkeeper.mledger.impl.ManagedLedgerFactoryImpl

All Implemented Interfaces:

ManagedLedgerFactory

public class ManagedLedgerFactoryImpl
extends Object
implements ManagedLedgerFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ManagedLedgerFactoryImpl.BookkeeperFactoryForCustomEnsemblePlacementPolicy	Factory to create Bookkeeper-client for a given ensemblePlacementPolicy.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConcurrentHashMap<String,CompletableFuture<ManagedLedgerImpl>>	ledgers
protected final ManagedLedgerFactoryMBeanImpl	mbean
protected final ConcurrentHashMap<String,org.apache.bookkeeper.mledger.impl.ManagedLedgerFactoryImpl.PendingInitializeManagedLedger>	pendingInitializeLedgers
protected final org.apache.bookkeeper.common.util.OrderedScheduler	scheduledExecutor

Constructor Summary

Constructors

Constructor	Description
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, BookKeeper bookKeeper)
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, BookKeeper bookKeeper, ManagedLedgerFactoryConfig config)
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, org.apache.bookkeeper.conf.ClientConfiguration bkClientConfiguration)
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, org.apache.bookkeeper.conf.ClientConfiguration bkClientConfiguration, ManagedLedgerFactoryConfig config)
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, ManagedLedgerFactoryImpl.BookkeeperFactoryForCustomEnsemblePlacementPolicy bookKeeperGroupFactory, ManagedLedgerFactoryConfig config)
ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore, ManagedLedgerFactoryImpl.BookkeeperFactoryForCustomEnsemblePlacementPolicy bookKeeperGroupFactory, ManagedLedgerFactoryConfig config, org.apache.bookkeeper.stats.StatsLogger statsLogger)

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.
BookKeeper	getBookKeeper()
long	getCacheEvictionTimeThreshold()
ManagedLedgerFactoryMXBean	getCacheStats()
ManagedLedgerFactoryConfig	getConfig()
EntryCacheManager	getEntryCacheManager()
ManagedLedgerInfo	getManagedLedgerInfo(String name)	Get the current metadata info for a managed ledger.
CompletableFuture<Map<String,String>>	getManagedLedgerPropertiesAsync(String name)
Map<String,ManagedLedgerImpl>	getManagedLedgers()	Helper for getting stats.
MetaStore	getMetaStore()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

scheduledExecutor

protected final org.apache.bookkeeper.common.util.OrderedScheduler scheduledExecutor

mbean

protected final ManagedLedgerFactoryMBeanImpl mbean

ledgers

protected final ConcurrentHashMap<String,CompletableFuture<ManagedLedgerImpl>> ledgers

pendingInitializeLedgers

protected final ConcurrentHashMap<String,org.apache.bookkeeper.mledger.impl.ManagedLedgerFactoryImpl.PendingInitializeManagedLedger> pendingInitializeLedgers

Constructor Details

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 org.apache.bookkeeper.conf.ClientConfiguration bkClientConfiguration)
                         throws Exception

Throws:

Exception

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 org.apache.bookkeeper.conf.ClientConfiguration bkClientConfiguration,
 ManagedLedgerFactoryConfig config)
                         throws Exception

Throws:

Exception

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 BookKeeper bookKeeper)
                         throws Exception

Throws:

Exception

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 BookKeeper bookKeeper,
 ManagedLedgerFactoryConfig config)
                         throws Exception

Throws:

Exception

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 ManagedLedgerFactoryImpl.BookkeeperFactoryForCustomEnsemblePlacementPolicy bookKeeperGroupFactory,
 ManagedLedgerFactoryConfig config)
                         throws Exception

Throws:

Exception

ManagedLedgerFactoryImpl

public ManagedLedgerFactoryImpl(MetadataStoreExtended metadataStore,
 ManagedLedgerFactoryImpl.BookkeeperFactoryForCustomEnsemblePlacementPolicy bookKeeperGroupFactory,
 ManagedLedgerFactoryConfig config,
 org.apache.bookkeeper.stats.StatsLogger statsLogger)
                         throws Exception

Throws:

Exception

Method Details

getManagedLedgers

public Map<String,ManagedLedgerImpl> getManagedLedgers()

Helper for getting stats.

Returns:

open

public ManagedLedger open(String name)
                   throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedLedgerFactory

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

Specified by:

open in interface ManagedLedgerFactory

Parameters:

name - the unique name that identifies the managed ledger

Returns:

the managed ledger

Throws:

ManagedLedgerException

InterruptedException

open

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

open in interface ManagedLedgerFactory

Parameters:

name - the unique name that identifies the managed ledger

config - managed ledger configuration

Returns:

the managed ledger

Throws:

ManagedLedgerException

InterruptedException

asyncOpen

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

Description copied from interface: ManagedLedgerFactory

Asynchronous open method.

Specified by:

asyncOpen in interface ManagedLedgerFactory

Parameters:

name - the unique name that identifies the managed ledger

callback - callback object

ctx - opaque context

See Also:

• ManagedLedgerFactory.open(String)

asyncOpen

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

Description copied from interface: ManagedLedgerFactory

Asynchronous open method.

Specified by:

asyncOpen in interface ManagedLedgerFactory

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:

• ManagedLedgerFactory.open(String, ManagedLedgerConfig)

asyncOpenReadOnlyManagedLedger

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

Description copied from interface: ManagedLedgerFactory

Asynchronous open a Read-only managedLedger.

Specified by:

asyncOpenReadOnlyManagedLedger in interface ManagedLedgerFactory

Parameters:

managedLedgerName - the unique name that identifies the managed ledger

config - the managed ledger configuration.

ctx - opaque context

openReadOnlyCursor

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

openReadOnlyCursor in interface ManagedLedgerFactory

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

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

asyncOpenReadOnlyCursor in interface ManagedLedgerFactory

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

shutdownAsync

public CompletableFuture<Void> shutdownAsync()
                                      throws ManagedLedgerException

Description copied from interface: ManagedLedgerFactory

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

Specified by:

shutdownAsync in interface ManagedLedgerFactory

Throws:

ManagedLedgerException

See Also:

• ManagedLedgerFactory.shutdown()

shutdown

public void shutdown()
              throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedLedgerFactory

Releases all the resources maintained by the ManagedLedgerFactory.

Specified by:

shutdown in interface ManagedLedgerFactory

Throws:

ManagedLedgerException

InterruptedException

asyncExists

public CompletableFuture<Boolean> asyncExists(String ledgerName)

Description copied from interface: ManagedLedgerFactory

Check managed ledger has been initialized before.

Specified by:

asyncExists in interface ManagedLedgerFactory

Parameters:

ledgerName - String

Returns:

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

getManagedLedgerInfo

public ManagedLedgerInfo getManagedLedgerInfo(String name)
                                       throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedLedgerFactory

Get the current metadata info for a managed ledger.

Specified by:

getManagedLedgerInfo in interface ManagedLedgerFactory

Parameters:

name - the unique name that identifies the managed ledger

Throws:

InterruptedException

ManagedLedgerException

asyncGetManagedLedgerInfo

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

Description copied from interface: ManagedLedgerFactory

Asynchronously get the current metadata info for a managed ledger.

Specified by:

asyncGetManagedLedgerInfo in interface ManagedLedgerFactory

Parameters:

name - the unique name that identifies the managed ledger

callback - callback object

ctx - opaque context

delete

public void delete(String name)
            throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedLedgerFactory

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

Specified by:

delete in interface ManagedLedgerFactory

Throws:

InterruptedException

ManagedLedgerException

delete

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

delete in interface ManagedLedgerFactory

Throws:

InterruptedException

ManagedLedgerException

asyncDelete

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

asyncDelete in interface ManagedLedgerFactory

asyncDelete

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

Description copied from interface: ManagedLedgerFactory

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

Specified by:

asyncDelete in interface ManagedLedgerFactory

getManagedLedgerPropertiesAsync

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

Specified by:

getManagedLedgerPropertiesAsync in interface ManagedLedgerFactory

Returns:

properties of this managedLedger.

getMetaStore

public MetaStore getMetaStore()

getConfig

public ManagedLedgerFactoryConfig getConfig()

getEntryCacheManager

public EntryCacheManager getEntryCacheManager()

Specified by:

getEntryCacheManager in interface ManagedLedgerFactory

Returns:

return EntryCacheManager.

updateCacheEvictionTimeThreshold

public void updateCacheEvictionTimeThreshold(long cacheEvictionTimeThresholdNanos)

Description copied from interface: ManagedLedgerFactory

update cache evictionTimeThreshold.

Specified by:

updateCacheEvictionTimeThreshold in interface ManagedLedgerFactory

Parameters:

cacheEvictionTimeThresholdNanos - time threshold for eviction.

getCacheEvictionTimeThreshold

public long getCacheEvictionTimeThreshold()

Specified by:

getCacheEvictionTimeThreshold in interface ManagedLedgerFactory

Returns:

time threshold for eviction.

getCacheStats

public ManagedLedgerFactoryMXBean getCacheStats()

getBookKeeper

public BookKeeper getBookKeeper()