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

Interface OffloadIndexBlock

All Superinterfaces:

AutoCloseable, Closeable, OffloadIndexBlockV2

All Known Implementing Classes:

OffloadIndexBlockImpl

@Unstable
public interface OffloadIndexBlock
extends Closeable, OffloadIndexBlockV2

The Index block abstraction used for offload a ledger to long term storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OffloadIndexBlock.IndexInputStream	An input stream which knows the size of the stream upfront.

Method Summary

Modifier and Type	Method	Description
long	getDataBlockHeaderLength()	Get the length of the header in the blocks in the data object.
long	getDataObjectLength()	Get the total size of the data object.
int	getEntryCount()	Get the entry count that contained in this index Block.
OffloadIndexEntry	getIndexEntryForEntry(long messageEntryId)	Get the related OffloadIndexEntry that contains the given messageEntryId.
default OffloadIndexEntry	getIndexEntryForEntry(long ledgerId, long messageEntryId)	Get the related OffloadIndexEntry that contains the given messageEntryId.
org.apache.bookkeeper.client.api.LedgerMetadata	getLedgerMetadata()	Get LedgerMetadata.
default org.apache.bookkeeper.client.api.LedgerMetadata	getLedgerMetadata(long ledgerId)	Get LedgerMetadata.
default long	getStartEntryId(long ledgerId)
OffloadIndexBlock.IndexInputStream	toStream()	Get the content of the index block as InputStream.

Methods inherited from interface java.io.Closeable

close

Method Detail

toStream

OffloadIndexBlock.IndexInputStream toStream()
                                     throws IOException

Get the content of the index block as InputStream. Read out in format: | index_magic_header | index_block_len | index_entry_count | | data_object_size | segment_metadata_length | segment metadata | index entries ... |

Specified by:

toStream in interface OffloadIndexBlockV2

Throws:

IOException

getIndexEntryForEntry

OffloadIndexEntry getIndexEntryForEntry(long messageEntryId)
                                 throws IOException

Get the related OffloadIndexEntry that contains the given messageEntryId.

Parameters:

messageEntryId - the entry id of message

Returns:

the offload index entry

Throws:

IOException

getEntryCount

int getEntryCount()

Get the entry count that contained in this index Block.

Specified by:

getEntryCount in interface OffloadIndexBlockV2

getLedgerMetadata

org.apache.bookkeeper.client.api.LedgerMetadata getLedgerMetadata()

Get LedgerMetadata.

getDataObjectLength

long getDataObjectLength()

Get the total size of the data object.

Specified by:

getDataObjectLength in interface OffloadIndexBlockV2

getDataBlockHeaderLength

long getDataBlockHeaderLength()

Get the length of the header in the blocks in the data object.

Specified by:

getDataBlockHeaderLength in interface OffloadIndexBlockV2

getIndexEntryForEntry

default OffloadIndexEntry getIndexEntryForEntry(long ledgerId,
                                                long messageEntryId)
                                         throws IOException

Description copied from interface: OffloadIndexBlockV2

Get the related OffloadIndexEntry that contains the given messageEntryId.

Specified by:

getIndexEntryForEntry in interface OffloadIndexBlockV2

messageEntryId - the entry id of message

Returns:

the offload index entry

Throws:

IOException

getStartEntryId

default long getStartEntryId(long ledgerId)

Specified by:

getStartEntryId in interface OffloadIndexBlockV2

getLedgerMetadata

default org.apache.bookkeeper.client.api.LedgerMetadata getLedgerMetadata(long ledgerId)

Description copied from interface: OffloadIndexBlockV2

Get LedgerMetadata.

Specified by:

getLedgerMetadata in interface OffloadIndexBlockV2

Returns: