org.lsst.ccs.bus.messages

Class LogMessage

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<String,String>

org.lsst.ccs.bus.messages.LogMessage

All Implemented Interfaces:

Serializable

public class LogMessage
extends BusMessage<String,String>

Log message to be sent on Log bus. The contained information is independent of the Logging implementation. Each LogMessage has an embedded String object representing the message to be sent over the buses. This String is the formatted version of the provided log message. The encoding process just returns null. So the embedded and encoded objects are the same. Additional information contained in each LogMessage:

• The formatted version of the original log message
• The name of the thread on which the message originated
• The name of the logger from which the message was sent
• The name of the source that originated the message. This is the name of the class followed by the method from which the message was sent
• The log level of the LogMessage

Author:

The LSST CCS Team.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.lsst.ccs.bus.messages.BusMessage

obj

Constructor Summary

Constructors

Constructor and Description
LogMessage(String threadName, String loggerName, String sourceName, String formattedDetails, String level) LogMessage constructor.

Method Summary

Modifier and Type	Method and Description
protected String	encodeObject(String obj) Subclasses must provide a specific implementation of the encoding process.
String	getEncodedData() Get the Encoded version of the embedded Object.
String	getFormattedDetails() The formatted version of the logged message.
String	getLevel() The level (or severity) of the LogMessage.
String	getLoggerName() Get the name of the logger used to record the LogMessage.
String	getSourceName() Get the source of the LogMessage.
String	getThreadName() Get the name of the thread on which the LogMessage originated.
String	toString() returns the "formatted details"

Methods inherited from class org.lsst.ccs.bus.messages.BusMessage

getCCSTimeStamp, getClassName, getDeserializationDuration, getDoneDeSerializationTime, getIncomingQueueInTimeStamp, getIncomingQueueOutTimeStamp, getObject, getOriginAgentInfo, getOutgoingQueueInTimeStamp, getOutgoingQueueOutTimeStamp, getSerializationDuration, getSerializationTime, getTransferDuration, setIncomingQueueInTimeStamp, setIncomingQueueOutTimeStamp, setOriginAgentInfo, setOutgoingQueueInTimeStamp, setOutgoingQueueOutTimeStamp, updateTimingInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

LogMessage

public LogMessage(String threadName,
                  String loggerName,
                  String sourceName,
                  String formattedDetails,
                  String level)

LogMessage constructor.

Parameters:

threadName - the name of the thread from which the LogMessage was created

loggerName - the name of the logger which issued the log

sourceName - concatenation of the form ClassName#methodName

formattedDetails - a formatted String that represents the Log record (can be text or xml) it is dependent on the Formatter of the Handler.

level - A string representing the Level

Method Detail

encodeObject

protected String encodeObject(String obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<String,String>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

getEncodedData

public String getEncodedData()

Description copied from class: BusMessage

Get the Encoded version of the embedded Object.

Overrides:

getEncodedData in class BusMessage<String,String>

Returns:

The Encoded version of the embedded Object.

getThreadName

public String getThreadName()

Get the name of the thread on which the LogMessage originated.

Returns:

The original thread name.

getLoggerName

public String getLoggerName()

Get the name of the logger used to record the LogMessage.

Returns:

The name of the logger.

getSourceName

public String getSourceName()

Get the source of the LogMessage.

Returns:

The name of the LogMessage source. By default this is ClassName#Method

getFormattedDetails

public String getFormattedDetails()

The formatted version of the logged message.

Returns:

The formatted version of the loggged message.

getLevel

public String getLevel()

The level (or severity) of the LogMessage.

Returns:

The level of the LogMessage.

toString

public String toString()

returns the "formatted details"

Overrides:

toString in class BusMessage<String,String>

Returns: