com.sleepycat.je.txn
Class TxnEnd

java.lang.Object
  com.sleepycat.je.txn.TxnEnd

All Implemented Interfaces:

LoggableObject, LogReadable, LogWritable

Direct Known Subclasses:

TxnAbort, TxnCommit, TxnPrepare

public abstract class TxnEnd
extends Object
implements LoggableObject, LogReadable

This class writes out a transaction commit or transaction end record.

Field Summary

protected long	id
protected Timestamp	time

Constructor Summary

TxnEnd()
For constructing from the log

TxnEnd(long id, long lastLsn)

Method Summary

boolean	countAsObsoleteWhenLogged() Returns true if this item should be counted as obsoleted when logged.
void	dumpLog(StringBuffer sb, boolean verbose) Write the object into the string buffer for log dumping.
long	getId()
(package private) long	getLastLsn()
int	getLogSize()
abstract LogEntryType	getLogType() All objects that are reponsible for a generating a type of log entry must implement this.
protected abstract String	getTagName()
long	getTransactionId()
boolean	logEntryIsTransactional()
boolean	marshallOutsideWriteLatch() Return true if this item can be marshalled outside the log write latch.
void	postLogWork(long justLoggedLsn) Do any processing we need to do after logging, while under the logging latch.
void	readFromLog(ByteBuffer logBuffer, byte entryTypeVersion) Initialize this object from the data in itemBuf.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected long id

time

protected Timestamp time

Constructor Detail

TxnEnd

TxnEnd(long id,
       long lastLsn)

TxnEnd

public TxnEnd()

For constructing from the log

Method Detail

getId

public long getId()

getLastLsn

long getLastLsn()

getTagName

protected abstract String getTagName()

getLogType

public abstract LogEntryType getLogType()

Description copied from interface: LoggableObject

All objects that are reponsible for a generating a type of log entry must implement this.

Specified by:

getLogType in interface LoggableObject

Returns:

the type of log entry

See Also:

LoggableObject.getLogType()

marshallOutsideWriteLatch

public boolean marshallOutsideWriteLatch()

Description copied from interface: LoggableObject

Return true if this item can be marshalled outside the log write latch.

Specified by:

marshallOutsideWriteLatch in interface LoggableObject

See Also:

Can be marshalled outside the log write latch.

countAsObsoleteWhenLogged

public boolean countAsObsoleteWhenLogged()

Description copied from interface: LoggableObject

Returns true if this item should be counted as obsoleted when logged. This currently applies to deleted LNs only.

Specified by:

countAsObsoleteWhenLogged in interface LoggableObject

See Also:

LoggableObject.countAsObsoleteWhenLogged()

postLogWork

public void postLogWork(long justLoggedLsn)

Description copied from interface: LoggableObject

Do any processing we need to do after logging, while under the logging latch.

Specified by:

postLogWork in interface LoggableObject

See Also:

LoggableObject.postLogWork(long)

getLogSize

public int getLogSize()

Specified by:

getLogSize in interface LogWritable

Returns:

number of bytes used to store this object.

See Also:

LogWritable.getLogSize()

writeToLog

public void writeToLog(ByteBuffer logBuffer)

Description copied from interface: LogWritable

Serialize this object into the buffer.

Specified by:

writeToLog in interface LogWritable

Parameters:

logBuffer - is the destination buffer

See Also:

LogWritable.writeToLog(java.nio.ByteBuffer)

readFromLog

public void readFromLog(ByteBuffer logBuffer,
                        byte entryTypeVersion)

Description copied from interface: LogReadable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface LogReadable

See Also:

LogReadable.readFromLog(java.nio.ByteBuffer, byte)

dumpLog

public void dumpLog(StringBuffer sb,
                    boolean verbose)

Description copied from interface: LogReadable

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 LogReadable

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

See Also:

LogReadable.dumpLog(java.lang.StringBuffer, boolean)

logEntryIsTransactional

public boolean logEntryIsTransactional()

Specified by:

logEntryIsTransactional in interface LogReadable

Returns:

true if the LogEntry is a transactional log entry type.

See Also:

LogReadable.logEntryIsTransactional()

getTransactionId

public long getTransactionId()

Specified by:

getTransactionId in interface LogReadable

Returns:

return the transaction id if this log entry is transactional, 0 otherwise.

See Also:

LogReadable.getTransactionId()