com.sleepycat.je.log

Interface Loggable

All Known Subinterfaces:

VersionedWriteLoggable

All Known Implementing Classes:

BasicVersionedWriteLoggable, BIN, CheckpointEnd, CheckpointStart, ChildReference, DatabaseId, DatabaseImpl, DbFileSummary, DBIN, DbOperationType, DbTree, DeltaInfo, DIN, DupCountLN, EmptyLogEntry, FileHeader, FileSummary, FileSummaryLN, IN, INDeleteInfo, INDupDeleteInfo, LN, MapLN, MasterTxn, Matchpoint, NameLN, Node, OldBINDelta, PackedOffsets, PreparedTxn, ReadonlyTxn, ReplayTxn, ReplicatedDatabaseConfig, RestoreRequired, RollbackEnd, RollbackStart, Trace, TrackedFileSummary, Tree, Txn, TxnAbort, TxnCommit, TxnEnd, TxnPrepare, VersionedLN, VersionedWriteTxnEnd, VLSN

public interface Loggable

A class that implements Loggable knows how to read and write itself into a ByteBuffer in a format suitable for the JE log or JE replication messages.

Classes that implement Loggable and are included in replication data should implement VersionedWriteLoggable.

Method Summary

Modifier and Type	Method and Description
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
int	getLogSize()
long	getTransactionId()
boolean	logicalEquals(Loggable other)
void	readFromLog(ByteBuffer itemBuffer, int entryVersion) Initialize this object from the data in itemBuf.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.

Method Detail

getLogSize

int getLogSize()

Returns:

number of bytes used to store this object.

writeToLog

void writeToLog(ByteBuffer logBuffer)

Serialize this object into the buffer.

Parameters:

logBuffer - is the destination buffer

readFromLog

void readFromLog(ByteBuffer itemBuffer,
                 int entryVersion)

Initialize this object from the data in itemBuf.

Parameters:

itemBuffer - the source buffer

entryVersion - the log version of the data

dumpLog

void dumpLog(StringBuilder sb,
             boolean verbose)

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.

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

getTransactionId

long getTransactionId()

Returns:

the transaction id embedded within this loggable object. Objects that have no transaction id should return 0.

logicalEquals

boolean logicalEquals(Loggable other)

Returns:

true if these two loggable items are logically the same. Used for replication testing.