com.bigdata.ha.msg

Class HAWriteMessage

java.lang.Object

com.bigdata.ha.msg.HAWriteMessageBase

com.bigdata.ha.msg.HAWriteMessage

All Implemented Interfaces:

IHAMessage, IHAWriteMessage, IHAWriteMessageBase, Externalizable, Serializable

public class HAWriteMessage
extends HAWriteMessageBase
implements IHAWriteMessage

A message carrying RMI metadata about a payload which will be replicated using a socket-level transfer facility.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
HAWriteMessage() De-serialization constructor.
HAWriteMessage(UUID uuid, long commitCounter, long commitTime, long sequence, int sze, int chk, StoreTypeEnum storeType, long quorumToken, int replicationFactor, long fileExtent, long firstOffset, String compressorKey)
HAWriteMessage(UUID uuid, long commitCounter, long commitTime, long sequence, int sze, int chk, StoreTypeEnum storeType, long quorumToken, long fileExtent, long firstOffset) Deprecated. by the version that accepts the compressor key.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
ByteBuffer	expand(ByteBuffer buffer) Applies associated IRecordCompressor (if any) to decompress the data
long	getCommitCounter() The commit counter for the opening root block associated with the write set for this message.
String	getCompressorKey() Return the associated IRecordCompressor key (if any).
long	getFileExtent() The length of the backing file on the disk.
long	getFirstOffset() The file offset at which the data will be written (WORM only or for Rebuild request).
long	getLastCommitTime() The commit time associated with this message.
long	getQuorumToken() The quorum token for which this message is valid.
int	getReplicationFactor() The replication factor for the quorum leader.
long	getSequence() The write cache buffer sequence number (reset to ZERO (0) for the first message after each commit and incremented for each buffer sent by the leader).
StoreTypeEnum	getStoreType() The type of backing store (RW or WORM).
UUID	getUUID() The UUID of the store to which this message belongs.
static boolean	isDataCompressed() Static method to indicate whether the message will reference compressed data.
void	readExternal(ObjectInput in)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class com.bigdata.ha.msg.HAWriteMessageBase

getChk, getSize, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bigdata.ha.msg.IHAWriteMessageBase

getChk, getSize

Field Detail

log

protected static final org.apache.log4j.Logger log

Constructor Detail

HAWriteMessage

public HAWriteMessage()

De-serialization constructor.

HAWriteMessage

public HAWriteMessage(UUID uuid,
              long commitCounter,
              long commitTime,
              long sequence,
              int sze,
              int chk,
              StoreTypeEnum storeType,
              long quorumToken,
              long fileExtent,
              long firstOffset)

Deprecated. by the version that accepts the compressor key.

Parameters:

uuid - The UUID associated with the backing store on the leader. This can be used to decide whether the message is for a given store, or (conversly) whether the receiver has already setup its root blocks based on the leader (and hence has the correct UUID for its local store).

commitCounter - The commit counter for the current root block for the write set which is being replicated by this message.

commitTime - The commit time for the current root block for the write set which is being replicated by this message.

sequence - The write cache block sequence number. This is reset to ZERO (0) for the first replicated write cache block in each write set.

sze - The #of bytes in the payload.

chk - The checksum of the payload.

storeType - The type of backing store (RW or WORM).

quorumToken - The quorum token for which this message is valid.

fileExtent - The length of the backing file on the disk.

firstOffset - The file offset at which the data will be written (WORM only).

HAWriteMessage

public HAWriteMessage(UUID uuid,
              long commitCounter,
              long commitTime,
              long sequence,
              int sze,
              int chk,
              StoreTypeEnum storeType,
              long quorumToken,
              int replicationFactor,
              long fileExtent,
              long firstOffset,
              String compressorKey)

Parameters:

uuid - The UUID associated with the backing store on the leader. This can be used to decide whether the message is for a given store, or (conversly) whether the receiver has already setup its root blocks based on the leader (and hence has the correct UUID for its local store).

commitCounter - The commit counter for the current root block for the write set which is being replicated by this message.

commitTime - The commit time for the current root block for the write set which is being replicated by this message.

sequence - The write cache block sequence number. This is reset to ZERO (0) for the first replicated write cache block in each write set.

sze - The #of bytes in the payload.

chk - The checksum of the payload.

storeType - The type of backing store (RW or WORM).

quorumToken - The quorum token for which this message is valid.

replicationFactor - The replication factor in effect for the leader.

fileExtent - The length of the backing file on the disk.

firstOffset - The file offset at which the data will be written (WORM only).

compressorKey - The key under which an IRecordCompressor has been registered against the CompressorRegistry -or- null for no compression.

Method Detail

getUUID

public UUID getUUID()

Description copied from interface: IHAWriteMessage

The UUID of the store to which this message belongs.

Specified by:

getUUID in interface IHAWriteMessage

getCommitCounter

public long getCommitCounter()

Description copied from interface: IHAWriteMessage

The commit counter for the opening root block associated with the write set for this message.

Specified by:

getCommitCounter in interface IHAWriteMessage

getLastCommitTime

public long getLastCommitTime()

Description copied from interface: IHAWriteMessage

The commit time associated with this message.

Specified by:

getLastCommitTime in interface IHAWriteMessage

getSequence

public long getSequence()

Description copied from interface: IHAWriteMessage

The write cache buffer sequence number (reset to ZERO (0) for the first message after each commit and incremented for each buffer sent by the leader).

Specified by:

getSequence in interface IHAWriteMessage

getStoreType

public StoreTypeEnum getStoreType()

Description copied from interface: IHAWriteMessage

The type of backing store (RW or WORM).

Specified by:

getStoreType in interface IHAWriteMessage

getQuorumToken

public long getQuorumToken()

Description copied from interface: IHAWriteMessage

The quorum token for which this message is valid.

Specified by:

getQuorumToken in interface IHAWriteMessage

getReplicationFactor

public int getReplicationFactor()

Description copied from interface: IHAWriteMessage

The replication factor for the quorum leader.

Specified by:

getReplicationFactor in interface IHAWriteMessage

getFileExtent

public long getFileExtent()

Description copied from interface: IHAWriteMessage

The length of the backing file on the disk.

Specified by:

getFileExtent in interface IHAWriteMessage

getFirstOffset

public long getFirstOffset()

Description copied from interface: IHAWriteMessage

The file offset at which the data will be written (WORM only or for Rebuild request).

Specified by:

getFirstOffset in interface IHAWriteMessage

getCompressorKey

public String getCompressorKey()

Description copied from interface: IHAWriteMessage

Return the associated IRecordCompressor key (if any).

Specified by:

getCompressorKey in interface IHAWriteMessage

toString

public String toString()

Overrides:

toString in class HAWriteMessageBase

isDataCompressed

public static boolean isDataCompressed()

Static method to indicate whether the message will reference compressed data.

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class HAWriteMessageBase

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class HAWriteMessageBase

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class HAWriteMessageBase

Throws:

IOException

expand

public ByteBuffer expand(ByteBuffer buffer)

Description copied from interface: IHAWriteMessage

Applies associated IRecordCompressor (if any) to decompress the data

Specified by:

expand in interface IHAWriteMessage