Package org.apache.pulsar.broker.delayed.bucket

Class BookkeeperBucketSnapshotStorage

java.lang.Object

org.apache.pulsar.broker.delayed.bucket.BookkeeperBucketSnapshotStorage

All Implemented Interfaces:

BucketSnapshotStorage

public class BookkeeperBucketSnapshotStorage
extends Object
implements BucketSnapshotStorage

Constructor Summary

Constructors

Constructor	Description
BookkeeperBucketSnapshotStorage(PulsarService pulsar)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the bucket snapshot storage service.
CompletableFuture<Long>	createBucketSnapshot(SnapshotMetadata snapshotMetadata, List<SnapshotSegment> bucketSnapshotSegments, String bucketKey, String topicName, String cursorName)	Create a delayed message index bucket snapshot with metadata and bucketSnapshotSegments.
CompletableFuture<Void>	deleteBucketSnapshot(long bucketId)	Delete delayed message index bucket snapshot by bucketId.
CompletableFuture<Long>	getBucketSnapshotLength(long bucketId)	Get total byte length of delayed message index bucket snapshot.
CompletableFuture<SnapshotMetadata>	getBucketSnapshotMetadata(long bucketId)	Get delayed message index bucket snapshot metadata.
CompletableFuture<List<SnapshotSegment>>	getBucketSnapshotSegment(long bucketId, long firstSegmentEntryId, long lastSegmentEntryId)	Get a sequence of delayed message index bucket snapshot segments.
void	start()	Start the bucket snapshot storage service.

Methods inherited from class java.lang.Object

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

Constructor Details

BookkeeperBucketSnapshotStorage

public BookkeeperBucketSnapshotStorage(PulsarService pulsar)

Method Details

createBucketSnapshot

public CompletableFuture<Long> createBucketSnapshot(SnapshotMetadata snapshotMetadata,
 List<SnapshotSegment> bucketSnapshotSegments,
 String bucketKey,
 String topicName,
 String cursorName)

Description copied from interface: BucketSnapshotStorage

Create a delayed message index bucket snapshot with metadata and bucketSnapshotSegments.

Specified by:

createBucketSnapshot in interface BucketSnapshotStorage

Parameters:

snapshotMetadata - the metadata of snapshot

bucketSnapshotSegments - the list of snapshot segments

bucketKey - the key of bucket is used to generate custom storage metadata

topicName - the name of topic is used to generate custom storage metadata

cursorName - the name of cursor is used to generate custom storage metadata

Returns:

the future with bucketId(ledgerId).

getBucketSnapshotMetadata

public CompletableFuture<SnapshotMetadata> getBucketSnapshotMetadata(long bucketId)

Description copied from interface: BucketSnapshotStorage

Get delayed message index bucket snapshot metadata.

Specified by:

getBucketSnapshotMetadata in interface BucketSnapshotStorage

Parameters:

bucketId - the bucketId of snapshot

Returns:

the future with snapshot expanded metadata

getBucketSnapshotSegment

public CompletableFuture<List<SnapshotSegment>> getBucketSnapshotSegment(long bucketId,
 long firstSegmentEntryId,
 long lastSegmentEntryId)

Description copied from interface: BucketSnapshotStorage

Get a sequence of delayed message index bucket snapshot segments.

Specified by:

getBucketSnapshotSegment in interface BucketSnapshotStorage

Parameters:

bucketId - the bucketId of snapshot

firstSegmentEntryId - entryId of first segment of sequence (include)

lastSegmentEntryId - entryId of last segment of sequence (include)

Returns:

the future with snapshot segment

getBucketSnapshotLength

public CompletableFuture<Long> getBucketSnapshotLength(long bucketId)

Description copied from interface: BucketSnapshotStorage

Get total byte length of delayed message index bucket snapshot.

Specified by:

getBucketSnapshotLength in interface BucketSnapshotStorage

Parameters:

bucketId - the bucketId of snapshot

Returns:

the future with byte length of snapshot

deleteBucketSnapshot

public CompletableFuture<Void> deleteBucketSnapshot(long bucketId)

Description copied from interface: BucketSnapshotStorage

Delete delayed message index bucket snapshot by bucketId.

Specified by:

deleteBucketSnapshot in interface BucketSnapshotStorage

Parameters:

bucketId - the bucketId of snapshot

start

public void start()
           throws Exception

Description copied from interface: BucketSnapshotStorage

Start the bucket snapshot storage service.

Specified by:

start in interface BucketSnapshotStorage

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: BucketSnapshotStorage

Close the bucket snapshot storage service.

Specified by:

close in interface BucketSnapshotStorage

Throws:

Exception