Package org.apache.bookkeeper.mledger.offload.jcloud.impl

Class BlobStoreManagedLedgerOffloader

java.lang.Object

org.apache.bookkeeper.mledger.offload.jcloud.impl.BlobStoreManagedLedgerOffloader

All Implemented Interfaces:

LedgerOffloader

public class BlobStoreManagedLedgerOffloader
extends Object
implements LedgerOffloader

Tiered Storage Offloader that is backed by a JCloud Blob Store.

The constructor takes an instance of TieredStorageConfiguration, which contains all of the configuration data necessary to connect to a JCloud Provider service.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bookkeeper.mledger.LedgerOffloader

LedgerOffloader.OffloadHandle, LedgerOffloader.OffloadResult

Field Summary

Fields inherited from interface org.apache.bookkeeper.mledger.LedgerOffloader

METADATA_PULSAR_CLUSTER_NAME, METADATA_SOFTWARE_GITSHA_KEY, METADATA_SOFTWARE_VERSION_KEY

Method Summary

Modifier and Type	Method	Description
void	close()
static BlobStoreManagedLedgerOffloader	create(TieredStorageConfiguration config, Map<String,String> userMetadata, org.apache.bookkeeper.common.util.OrderedScheduler scheduler, LedgerOffloaderStats offloaderStats)
CompletableFuture<Void>	deleteOffloaded(long ledgerId, UUID uid, Map<String,String> offloadDriverMetadata)
CompletableFuture<Void>	deleteOffloaded(UUID uid, Map<String,String> offloadDriverMetadata)
Map<String,String>	getOffloadDriverMetadata()
String	getOffloadDriverName()
org.apache.pulsar.common.policies.data.OffloadPolicies	getOffloadPolicies()
CompletableFuture<Void>	offload(org.apache.bookkeeper.client.api.ReadHandle readHandle, UUID uuid, Map<String,String> extraMetadata)	Upload the DataBlocks associated with the given ReadHandle using MultiPartUpload, Creating indexBlocks for each corresponding DataBlock that is uploaded.
CompletableFuture<org.apache.bookkeeper.client.api.ReadHandle>	readOffloaded(long ledgerId, UUID uid, Map<String,String> offloadDriverMetadata)
CompletableFuture<org.apache.bookkeeper.client.api.ReadHandle>	readOffloaded(long ledgerId, MLDataFormats.OffloadContext ledgerContext, Map<String,String> offloadDriverMetadata)
void	scanLedgers(OffloadedLedgerMetadataConsumer consumer, Map<String,String> offloadDriverMetadata)
CompletableFuture<LedgerOffloader.OffloadHandle>	streamingOffload(@NonNull ManagedLedger ml, UUID uuid, long beginLedger, long beginEntry, Map<String,String> driverMetadata)

Methods inherited from class java.lang.Object

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

Method Details

create

public static BlobStoreManagedLedgerOffloader create(TieredStorageConfiguration config,
 Map<String,String> userMetadata,
 org.apache.bookkeeper.common.util.OrderedScheduler scheduler,
 LedgerOffloaderStats offloaderStats)
                                              throws IOException

Throws:

IOException

getOffloadDriverName

public String getOffloadDriverName()

Specified by:

getOffloadDriverName in interface LedgerOffloader

getOffloadDriverMetadata

public Map<String,String> getOffloadDriverMetadata()

Specified by:

getOffloadDriverMetadata in interface LedgerOffloader

offload

public CompletableFuture<Void> offload(org.apache.bookkeeper.client.api.ReadHandle readHandle,
 UUID uuid,
 Map<String,String> extraMetadata)

Upload the DataBlocks associated with the given ReadHandle using MultiPartUpload, Creating indexBlocks for each corresponding DataBlock that is uploaded.

Specified by:

offload in interface LedgerOffloader

streamingOffload

public CompletableFuture<LedgerOffloader.OffloadHandle> streamingOffload(@NonNull
 @NonNull ManagedLedger ml,
 UUID uuid,
 long beginLedger,
 long beginEntry,
 Map<String,String> driverMetadata)

Specified by:

streamingOffload in interface LedgerOffloader

readOffloaded

public CompletableFuture<org.apache.bookkeeper.client.api.ReadHandle> readOffloaded(long ledgerId,
 UUID uid,
 Map<String,String> offloadDriverMetadata)

Specified by:

readOffloaded in interface LedgerOffloader

readOffloaded

public CompletableFuture<org.apache.bookkeeper.client.api.ReadHandle> readOffloaded(long ledgerId,
 MLDataFormats.OffloadContext ledgerContext,
 Map<String,String> offloadDriverMetadata)

Specified by:

readOffloaded in interface LedgerOffloader

deleteOffloaded

public CompletableFuture<Void> deleteOffloaded(long ledgerId,
 UUID uid,
 Map<String,String> offloadDriverMetadata)

Specified by:

deleteOffloaded in interface LedgerOffloader

deleteOffloaded

public CompletableFuture<Void> deleteOffloaded(UUID uid,
 Map<String,String> offloadDriverMetadata)

Specified by:

deleteOffloaded in interface LedgerOffloader

getOffloadPolicies

public org.apache.pulsar.common.policies.data.OffloadPolicies getOffloadPolicies()

Specified by:

getOffloadPolicies in interface LedgerOffloader

close

public void close()

Specified by:

close in interface LedgerOffloader

scanLedgers

public void scanLedgers(OffloadedLedgerMetadataConsumer consumer,
 Map<String,String> offloadDriverMetadata)
                 throws ManagedLedgerException

Specified by:

scanLedgers in interface LedgerOffloader

Throws:

ManagedLedgerException