com.sleepycat.je.log

Class Trace

java.lang.Object

com.sleepycat.je.log.BasicVersionedWriteLoggable

com.sleepycat.je.log.Trace

All Implemented Interfaces:

Loggable, VersionedWriteLoggable

public class Trace
extends BasicVersionedWriteLoggable

Trace logs event tracing messages into .jdb files. Only critical messages that should always be included in a log should use this functionality.

Constructor Summary

Constructors

Constructor and Description
Trace() Create a trace record that will be filled in from the log.
Trace(String msg) Create a new debug record.

Method Summary

Modifier and Type	Method and Description
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
boolean	equals(Object obj)
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize(int logVersion, boolean forReplication) Returns the number of bytes needed to store this object in the format for the specified log version.
String	getMessage()
long	getTransactionId()
int	hashCode() Just in case it's ever used as a hash key.
boolean	logicalEquals(Loggable other)
void	readFromLog(ByteBuffer itemBuffer, int entryVersion) Initialize this object from the data in itemBuf.
String	toString()
static void	trace(EnvironmentImpl envImpl, String message) Convenience method to create a log entry containing this trace msg.
static long	trace(EnvironmentImpl envImpl, Trace traceMsg) Trace a trace object, unit tests only.
static void	traceLazily(EnvironmentImpl envImpl, String message) Convenience method to create a log entry (lazily) containing this trace msg.
void	writeToLog(ByteBuffer logBuffer, int logVersion, boolean forReplication) Serializes this object into the specified buffer in the format for the specified log version.

Methods inherited from class com.sleepycat.je.log.BasicVersionedWriteLoggable

getLogSize, hasReplicationFormat, isReplicationFormatWorthwhile, writeToLog

Methods inherited from class java.lang.Object

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

Constructor Detail

Trace

public Trace(String msg)

Create a new debug record.

Trace

public Trace()

Create a trace record that will be filled in from the log.

Method Detail

getMessage

public String getMessage()

Returns:

message part of trace record.

trace

public static void trace(EnvironmentImpl envImpl,
                         String message)

Convenience method to create a log entry containing this trace msg.

trace

public static long trace(EnvironmentImpl envImpl,
                         Trace traceMsg)

Trace a trace object, unit tests only.

traceLazily

public static void traceLazily(EnvironmentImpl envImpl,
                               String message)

Convenience method to create a log entry (lazily) containing this trace msg. Lazy tracing is used when tracing is desired, but the .jdb files are not initialized.

getLastFormatChange

public int getLastFormatChange()

Description copied from interface: VersionedWriteLoggable

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

Returns:

the log version of the most recent format change

See Also:

ReplicableLogEntry.getLastFormatChange()

getEmbeddedLoggables

public Collection<VersionedWriteLoggable> getEmbeddedLoggables()

See Also:

ReplicableLogEntry.getEmbeddedLoggables()

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.

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 logVersion,
                       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.

Parameters:

logBuffer - the destination buffer

logVersion - the log version

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

readFromLog

public void readFromLog(ByteBuffer itemBuffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Parameters:

itemBuffer - the source buffer

entryVersion - the log version of the data

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.

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

getTransactionId

public long getTransactionId()

Returns:

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

logicalEquals

public boolean logicalEquals(Loggable other)

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Just in case it's ever used as a hash key.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object