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

Class OffloadIndexBlockImpl

java.lang.Object

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, OffloadIndexBlock, OffloadIndexBlockV2

public class OffloadIndexBlockImpl
extends java.lang.Object
implements OffloadIndexBlock

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bookkeeper.mledger.offload.jcloud.OffloadIndexBlock

OffloadIndexBlock.IndexInputStream

Method Summary

Modifier and Type	Method	Description
void	close()
static OffloadIndexBlockImpl	get(int magic, java.io.DataInputStream stream)
static OffloadIndexBlockImpl	get(org.apache.bookkeeper.client.api.LedgerMetadata metadata, long dataObjectLength, long dataHeaderLength, java.util.List<OffloadIndexEntryImpl> entries)
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.
static int	getIndexMagicWord()
org.apache.bookkeeper.client.api.LedgerMetadata	getLedgerMetadata()	Get LedgerMetadata.
void	recycle()
OffloadIndexBlock.IndexInputStream	toStream()	Get the content of the index block as InputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.mledger.offload.jcloud.OffloadIndexBlock

getIndexEntryForEntry, getLedgerMetadata, getStartEntryId

Method Detail

get

public static OffloadIndexBlockImpl get(org.apache.bookkeeper.client.api.LedgerMetadata metadata,
                                        long dataObjectLength,
                                        long dataHeaderLength,
                                        java.util.List<OffloadIndexEntryImpl> entries)

get

public static OffloadIndexBlockImpl get(int magic,
                                        java.io.DataInputStream stream)
                                 throws java.io.IOException

Throws:

java.io.IOException

recycle

public void recycle()

getIndexEntryForEntry

public OffloadIndexEntry getIndexEntryForEntry(long messageEntryId)
                                        throws java.io.IOException

Description copied from interface: OffloadIndexBlock

Get the related OffloadIndexEntry that contains the given messageEntryId.

Specified by:

getIndexEntryForEntry in interface OffloadIndexBlock

Parameters:

messageEntryId - the entry id of message

Returns:

the offload index entry

Throws:

java.io.IOException

getEntryCount

public int getEntryCount()

Description copied from interface: OffloadIndexBlock

Get the entry count that contained in this index Block.

Specified by:

getEntryCount in interface OffloadIndexBlock

Specified by:

getEntryCount in interface OffloadIndexBlockV2

getLedgerMetadata

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

Description copied from interface: OffloadIndexBlock

Get LedgerMetadata.

Specified by:

getLedgerMetadata in interface OffloadIndexBlock

getDataObjectLength

public long getDataObjectLength()

Description copied from interface: OffloadIndexBlock

Get the total size of the data object.

Specified by:

getDataObjectLength in interface OffloadIndexBlock

Specified by:

getDataObjectLength in interface OffloadIndexBlockV2

getDataBlockHeaderLength

public long getDataBlockHeaderLength()

Description copied from interface: OffloadIndexBlock

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

Specified by:

getDataBlockHeaderLength in interface OffloadIndexBlock

Specified by:

getDataBlockHeaderLength in interface OffloadIndexBlockV2

toStream

public OffloadIndexBlock.IndexInputStream toStream()
                                            throws java.io.IOException

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

Specified by:

toStream in interface OffloadIndexBlock

Specified by:

toStream in interface OffloadIndexBlockV2

Throws:

java.io.IOException

getIndexMagicWord

public static int getIndexMagicWord()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable