com.sleepycat.je.txn

Class VersionedWriteTxnEnd

java.lang.Object

com.sleepycat.je.txn.TxnEnd

com.sleepycat.je.txn.VersionedWriteTxnEnd

All Implemented Interfaces:

Loggable, VersionedWriteLoggable

Direct Known Subclasses:

TxnAbort, TxnCommit

public abstract class VersionedWriteTxnEnd
extends TxnEnd
implements VersionedWriteLoggable

Based class for commit and abort records, which are replicated. The log formats for commit and abort are identical.

Constructor Summary

Constructors

Constructor and Description
VersionedWriteTxnEnd() For constructing from the log.

Method Summary

Modifier and Type	Method and Description
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize()
int	getLogSize(int logVersion, boolean forReplication) Returns the number of bytes needed to store this object in the format for the specified log version.
boolean	hasReplicationFormat() Returns whether this format has a variant that is optimized for replication.
boolean	isReplicationFormatWorthwhile(ByteBuffer logBuffer, int srcVersion, int destVersion) Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication.
void	readFromLog(ByteBuffer logBuffer, int entryVersion) Initialize this object from the data in itemBuf.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.
void	writeToLog(ByteBuffer logBuffer, int entryVersion, boolean forReplication) Serializes this object into the specified buffer in the format for the specified log version.

Methods inherited from class com.sleepycat.je.txn.TxnEnd

getDTVLSN, getId, getMasterNodeId, getTagName, getTime, getTransactionId, hasLoggedEntries, setDTVLSN

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sleepycat.je.log.Loggable

getTransactionId, logicalEquals

Constructor Detail

VersionedWriteTxnEnd

public VersionedWriteTxnEnd()

For constructing from the log.

Method Detail

getLastFormatChange

public int getLastFormatChange()

Description copied from interface: VersionedWriteLoggable

Returns the log version of the most recent format change for this loggable item.

Specified by:

getLastFormatChange in interface VersionedWriteLoggable

Returns:

the log version of the most recent format change

See Also:

ReplicableLogEntry.getLastFormatChange()

getEmbeddedLoggables

public Collection<VersionedWriteLoggable> getEmbeddedLoggables()

Specified by:

getEmbeddedLoggables in interface VersionedWriteLoggable

See Also:

ReplicableLogEntry.getEmbeddedLoggables()

getLogSize

public int getLogSize()

Specified by:

getLogSize in interface Loggable

Returns:

number of bytes used to store this object.

writeToLog

public void writeToLog(ByteBuffer logBuffer)

Description copied from interface: Loggable

Serialize this object into the buffer.

Specified by:

writeToLog in interface Loggable

Parameters:

logBuffer - is the destination buffer

getLogSize

public int getLogSize(int logVersion,
                      boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Returns the number of bytes needed to store this object in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

getLogSize in interface VersionedWriteLoggable

Parameters:

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

Returns:

the number of bytes to store this object for the log version

writeToLog

public void writeToLog(ByteBuffer logBuffer,
                       int entryVersion,
                       boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Serializes this object into the specified buffer in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

writeToLog in interface VersionedWriteLoggable

Parameters:

logBuffer - the destination buffer

entryVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

readFromLog

public void readFromLog(ByteBuffer logBuffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface Loggable

Parameters:

logBuffer - the source buffer

entryVersion - the log version of the data

hasReplicationFormat

public boolean hasReplicationFormat()

Description copied from interface: VersionedWriteLoggable

Returns whether this format has a variant that is optimized for replication.

Specified by:

hasReplicationFormat in interface VersionedWriteLoggable

isReplicationFormatWorthwhile

public boolean isReplicationFormatWorthwhile(ByteBuffer logBuffer,
                                             int srcVersion,
                                             int destVersion)

Description copied from interface: VersionedWriteLoggable

Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication. Implementations should attempt to check efficiently, without instantiating the log entry object. Some implementations will simply return false.

WARNING: The logBuffer position must not be changed by this method.

WARNING: The shared LogEntry object is used for calling this method, and this method must not change any of the fields in the object.

Specified by:

isReplicationFormatWorthwhile in interface VersionedWriteLoggable

Parameters:

logBuffer - contains the entry that would be re-serialized.

srcVersion - the log version of entry in logBuffer.

destVersion - the version that would be used for re-serialization.

dumpLog

public void dumpLog(StringBuilder sb,
                    boolean verbose)

Description copied from interface: Loggable

Write the object into the string buffer for log dumping. Each object should be dumped without indentation or new lines and should be valid XML.

Specified by:

dumpLog in interface Loggable

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version