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

Class OffloadIndexBlockV2BuilderImpl

java.lang.Object

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

All Implemented Interfaces:

OffloadIndexBlockBuilder, OffloadIndexBlockV2Builder

public class OffloadIndexBlockV2BuilderImpl
extends Object
implements OffloadIndexBlockBuilder, OffloadIndexBlockV2Builder

Interface for builder of index block used for offload a ledger to long term storage.

Constructor Summary

Constructors

Constructor and Description
OffloadIndexBlockV2BuilderImpl()

Method Summary

Modifier and Type	Method and Description
OffloadIndexBlockBuilder	addBlock(long firstEntryId, int partId, int blockSize) Add one payload block related information into index block.
OffloadIndexBlockV2Builder	addBlock(long ledgerId, long firstEntryId, int partId, int blockSize) Add one payload block related information into index block.
OffloadIndexBlockV2BuilderImpl	addLedgerMeta(Long ledgerId, MLDataFormats.ManagedLedgerInfo.LedgerInfo metadata) Build index block with the passed in ledger metadata.
OffloadIndexBlock	build() Finalize the immutable OffloadIndexBlock.
OffloadIndexBlockV2	buildV2() Finalize the immutable OffloadIndexBlock.
OffloadIndexBlockV2	fromStream(InputStream is) Construct OffloadIndex from an InputStream.
OffloadIndexBlockV2BuilderImpl	withDataBlockHeaderLength(long dataHeaderLength) Specify the length of the block headers in the data object.
OffloadIndexBlockV2BuilderImpl	withDataObjectLength(long dataObjectLength) Specify the length of data object this index is associated with.
OffloadIndexBlockV2BuilderImpl	withLedgerMetadata(org.apache.bookkeeper.client.api.LedgerMetadata metadata) Build index block with the passed in ledger metadata.

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.OffloadIndexBlockBuilder

create

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

create

Constructor Detail

OffloadIndexBlockV2BuilderImpl

public OffloadIndexBlockV2BuilderImpl()

Method Detail

withDataObjectLength

public OffloadIndexBlockV2BuilderImpl withDataObjectLength(long dataObjectLength)

Description copied from interface: OffloadIndexBlockBuilder

Specify the length of data object this index is associated with.

Specified by:

withDataObjectLength in interface OffloadIndexBlockBuilder

Specified by:

withDataObjectLength in interface OffloadIndexBlockV2Builder

Parameters:

dataObjectLength - the length of the data object

withDataBlockHeaderLength

public OffloadIndexBlockV2BuilderImpl withDataBlockHeaderLength(long dataHeaderLength)

Description copied from interface: OffloadIndexBlockBuilder

Specify the length of the block headers in the data object.

Specified by:

withDataBlockHeaderLength in interface OffloadIndexBlockBuilder

Specified by:

withDataBlockHeaderLength in interface OffloadIndexBlockV2Builder

Parameters:

dataHeaderLength - the length of the headers

withLedgerMetadata

public OffloadIndexBlockV2BuilderImpl withLedgerMetadata(org.apache.bookkeeper.client.api.LedgerMetadata metadata)

Description copied from interface: OffloadIndexBlockBuilder

Build index block with the passed in ledger metadata.

Specified by:

withLedgerMetadata in interface OffloadIndexBlockBuilder

Parameters:

metadata - the ledger metadata

addLedgerMeta

public OffloadIndexBlockV2BuilderImpl addLedgerMeta(Long ledgerId,
                                                    MLDataFormats.ManagedLedgerInfo.LedgerInfo metadata)

Description copied from interface: OffloadIndexBlockV2Builder

Build index block with the passed in ledger metadata.

Specified by:

addLedgerMeta in interface OffloadIndexBlockV2Builder

metadata - the ledger metadata

addBlock

public OffloadIndexBlockBuilder addBlock(long firstEntryId,
                                         int partId,
                                         int blockSize)

Description copied from interface: OffloadIndexBlockBuilder

Add one payload block related information into index block. It contains the first entryId in payload block, the payload block Id, and payload block size. This information will be used to consist one index entry in OffloadIndexBlock.

Specified by:

addBlock in interface OffloadIndexBlockBuilder

Parameters:

firstEntryId - the first entryId in payload block

partId - the payload block Id

blockSize - the payload block size

addBlock

public OffloadIndexBlockV2Builder addBlock(long ledgerId,
                                           long firstEntryId,
                                           int partId,
                                           int blockSize)

Description copied from interface: OffloadIndexBlockV2Builder

Add one payload block related information into index block. It contains the first entryId in payload block, the payload block Id, and payload block size. This information will be used to consist one index entry in OffloadIndexBlock.

Specified by:

addBlock in interface OffloadIndexBlockV2Builder

firstEntryId - the first entryId in payload block

partId - the payload block Id

blockSize - the payload block size

fromStream

public OffloadIndexBlockV2 fromStream(InputStream is)
                               throws IOException

Description copied from interface: OffloadIndexBlockBuilder

Construct OffloadIndex from an InputStream.

Specified by:

fromStream in interface OffloadIndexBlockBuilder

Specified by:

fromStream in interface OffloadIndexBlockV2Builder

Throws:

IOException

build

public OffloadIndexBlock build()

Description copied from interface: OffloadIndexBlockBuilder

Finalize the immutable OffloadIndexBlock.

Specified by:

build in interface OffloadIndexBlockBuilder

buildV2

public OffloadIndexBlockV2 buildV2()

Description copied from interface: OffloadIndexBlockV2Builder

Finalize the immutable OffloadIndexBlock.

Specified by:

buildV2 in interface OffloadIndexBlockV2Builder