org.eclipse.hyades.logging.java
Class CommonBaseEventLogRecord

java.lang.Object
  java.util.logging.LogRecord
      org.eclipse.hyades.logging.java.CommonBaseEventLogRecord

All Implemented Interfaces:

IExternalizableToXml, java.io.Serializable

public final class CommonBaseEventLogRecord

extends java.util.logging.LogRecord

implements IExternalizableToXml

Extension of the Java Logging java.util.logging.LogRecord class used to encapsulate a Common Base Event v1.0.1 or org.eclipse.hyades.logging.events.cbe.CommonBaseEvent within a java.util.logging.LogRecord.

This extension class is required to log org.eclipse.hyades.logging.events.cbe.CommonBaseEvent instances through the Java Logging infrastructure.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances are created via the the single argument constructor that accepts a org.eclipse.hyades.logging.events.cbe.CommonBaseEvent reference. Alternatively, org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances may be created via the the double argument constructor that accepts org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and java.util.logging.Level references. The following java.util.logging.LogRecord properties are mapped to the parameter org.eclipse.hyades.logging.events.cbe.CommonBaseEvent based on its internal state or the java.util.logging.LogRecord default values (see the associated setter APIs for each property for mapping details):

java.util.logging.LogRecord Property	Value
level	SEVERE if the parameter Common Base Event's severity is set and is greater or equal to 50, WARNING if the parameter Common Base Event's severity is set and is between 30 and 49 (inclusive) or INFO if the parameter Common Base Event's severity is set and is less than or equal to 29 or OFF if the parameter Common Base Event's severity is not set.
sequenceNumber	A new unique value in increasing order within a JVM as initialized by the java.util.logging.LogRecord super class.
threadID	A new unique value for the current thread as initialized by the java.util.logging.LogRecord super class.
millis	The current time in milliseconds as initialized by the java.util.logging.LogRecord super class if the parameter Common Base Event's creationTime is not set.

NOTE: If the parameter Common Base Event log record is null, a java.util.logging.LogRecord will be constructed with a OFF level, null message with no Common Base Event capabilities.

NOTE: Using any of the deprecated constructors results in resorting to the java.util.logging.LogRecord programming model (e.g. no Common Base Event capabilities).

NOTE: If the parameter Common Base Event log record does not contain either a Situation and/or SourceComponentId property, default properties will be constructed to ensure a well-formed Common Base Event.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
level	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:level" ExtendedDataElement[0...n].Type = "noValue" ExtendedDataElement[0...n].Children[0].Name = "name" ExtendedDataElement[0...n].Children[0].Type = "string" ExtendedDataElement[0...n].Children[0].Values[0] = <level's name> ExtendedDataElement[0...n].Children[1].Name = "value" ExtendedDataElement[0...n].Children[0].Type = "int" ExtendedDataElement[0...n].Children[0].Values[0] = <level's numerical value>
loggerName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:loggerName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <logger's name>
message#	Unresolved (e.g. not localized or formatted) messages: MsgDataElement.MsgCatalogId = <message> - or - Resolved (e.g. localized and formatted) messages: msg = <message>
millis	creationTime = <millis>
parameters*	MsgDataElement.MsgCatalogTokens = <string representation of parameters>
resourceBundle*#	[not mapped]
resourceBundleName	MsgDataElement.MsgCatalog = <resource bundle name> MsgDataElement.MsgCatalogType = "Java"
sequenceNumber	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sequenceNumber" ExtendedDataElement[0...n].Type = "long" ExtendedDataElement[0...n].Values[0] = <sequence number>
sourceClassName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sourceClassName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <source class name>
sourceMethodName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sourceMethodName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <source method name>
threadID	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:threadID" ExtendedDataElement[0...n].Type = "int" ExtendedDataElement[0...n].Values[0] = <thread ID>
thrown*	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:stackTrace" ExtendedDataElement[0...n].Type = "stringArray" ExtendedDataElement[0...n].Values[0...n] = [< java.lang.Throwable's class name>[: < java.lang.Throwable's localized message>]] ExtendedDataElement[0...n].Values[(n + 1)...m] = < java.lang.Throwable's stackTraceElement[0...(m - (n + 1))]>] ExtendedDataElement[0...n].Children[0...m].Name = "Cause" ExtendedDataElement[0...n].Children[0...n].Type = "stringArray" ExtendedDataElement[0...n].Children[0...m].Values[0...n] = <cause's class name>[: <cause's localized message>] ExtendedDataElement[0...n].Children[0...m].Values[(n + 1)...m] = <cause's stackTraceElement[0...(m - (n + 1))]> [children[0] = <cause's cause>]

* java.util.logging.LogRecord property is stored in java.util.logging.LogRecord super class to eliminate loss of data.

# When the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is set to a non-null resource bundle name, the non-null java.util.logging.LogRecord.message property is assumed to be resolved (e.g. localized and formatted) and set to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property. Conversely, when the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is not set (e.g. null resource bundle name), the non-null java.util.logging.LogRecord.message property is assumed to be unresolved (e.g. no localized or formatted) and set to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property. Furthermore, when the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is set to a non-null resource bundle name, the java.util.logging.LogRecord.message property is assumed to be resolved (e.g. localized and formatted) and moved from the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property. Conversely, when the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is set to a null resource bundle name, the java.util.logging.LogRecord.message property is assumed to be unresolved (e.g. no localized or formatted) and moved from the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property. Noteworthy, the java.util.logging.LogRecord.resourceBundle is not used to determine if the java.util.logging.LogRecord.message property is resolved (e.g. localized and formatted) since the resource bundle name (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) cannot be resolved from the java.util.logging.LogRecord.resourceBundle thereby generating an invalid Common Base Event (e.g. org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId without the required org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog).

If the Extended Data Element's values property is larger than 1024 characters, the string is segmented into a String array of 1024-character elements and set on the Extended Data Element. However, if the Extended Data Element's values property is 1024 or less characters, the string is set directly on the first element a String array and set on the Extended Data Element. As such, the type property is set to stringArray.

Names identifying the associated org.eclipse.hyades.logging.events.cbe.ExtendedDataElement properties in the encapsulated Common Base Event for the java.util.logging.LogRecord properties are provided as static string constants. These name properties are prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: When setting associated org.eclipse.hyades.logging.events.cbe.ExtendedDataElement properties in the encapsulated Common Base Event, multiple like-named org.eclipse.hyades.logging.events.cbe.ExtendedDataElement are permitted but no there is no guarantee which org.eclipse.hyades.logging.events.cbe.ExtendedDataElement is retrieved when calling this class' getter APIs. That is, the predefined names for the org.eclipse.hyades.logging.events.cbe.ExtendedDataElement (e.g. static string constants) are intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

NOTE: The Java Logging classes must be on the CLASSPATH at run-time to utilize this extension class.

Since:

April 1, 2003

See Also:

LogRecord, CommonBaseEvent, IExternalizableToXml, Serialized Form

Field Summary

static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_LEVEL Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's level.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_LEVEL_NAME Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's child which contains the java.util.logging.LogRecord's level's name.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_LEVEL_VALUE Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's child which contains the java.util.logging.LogRecord's level's value.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_LOGGER_NAME Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's logger name.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_NAMESPACE Instance variable which holds the name space property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement s.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_SEQUENCE_NUMBER Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's sequence number.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_SOURCE_CLASS_NAME Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's source class name.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_SOURCE_METHOD_NAME Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's source method name.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_THREAD_ID Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's thread ID.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_THROWN Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's thrown.
static java.lang.String	EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME Deprecated. As of 3.1, this property is no longer relevant (see #setThrown(Throwable)).

Constructor Summary

CommonBaseEventLogRecord(CommonBaseEvent commonBaseEvent)
Single parameter constructor to create a Common Base Event log record with the parameter Common Base Event.

CommonBaseEventLogRecord(CommonBaseEvent commonBaseEvent, java.util.logging.Level level)
Double parameter constructor to create a Common Base Event log record with the parameter Common Base Event and a specified logging level.

CommonBaseEventLogRecord(java.util.logging.Level level)
Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

CommonBaseEventLogRecord(java.util.logging.Level level, java.lang.String message)
Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

CommonBaseEventLogRecord(java.util.logging.LogRecord logRecord)
Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

Method Summary

java.lang.String	externalizeCanonicalXmlDocString() Generates the formatted XML document representation of the encapsulated Common Base Event property.
java.lang.String	externalizeCanonicalXmlString() Generates the formatted XML fragment representation of the encapsulated Common Base Event property.
CommonBaseEvent	getCommonBaseEvent() Gets the value of the commonBaseEvent instance variable.
java.util.logging.Level	getLevel() Gets the level filter from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	getLoggerName() Gets the log record's associated logger name from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	getMessage() Gets the string log message from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
long	getMillis() Gets the time stamp in milliseconds from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.Object[]	getParameters() Gets the array of message parameters from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	getResourceBundleName() Gets the level filter from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
long	getSequenceNumber() Gets the unique sequence number from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	getSourceClassName() Gets the name of the source class from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	getSourceMethodName() Gets the name of the source method from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
int	getThreadID() Gets the unique ID of an associated thread from the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setCommonBaseEvent(CommonBaseEvent commonBaseEvent) Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level) constructors.
void	setLevel(java.util.logging.Level level) Sets the non-null parameter level filter on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setLoggerName(java.lang.String name) Sets the log record's associated logger name on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setMessage(java.lang.String message) Sets the string log message on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setMillis(long millis) Sets the time stamp in milliseconds on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setParameters(java.lang.Object[] parameters) Sets the array of message parameters on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setResourceBundleName(java.lang.String name) Sets the name of the resource bundle on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setSequenceNumber(long seq) Sets the unique sequence number on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setSourceClassName(java.lang.String sourceClassName) Sets the name of the source class on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setSourceMethodName(java.lang.String sourceMethodName) Sets the name of the source method on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setThreadID(int threadID) Sets the unique ID of an associated thread on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
void	setThrown(java.lang.Throwable thrown) Sets an exception on the encapsulated Common Base Event or java.util.logging.LogRecord super class.
java.lang.String	toString() Returns the textual representation of this CommonBaseEventLogRecord.

Methods inherited from class java.util.logging.LogRecord

getResourceBundle, getThrown, setResourceBundle

Methods inherited from class java.lang.Object

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

Field Detail

EXTENDED_DATA_ELEMENT_NAME_NAMESPACE

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_NAMESPACE

Instance variable which holds the name space property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement s.

This namespace is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord to easily identify org.eclipse.hyades.logging.events.cbe.ExtendedDataElement s associated with java.util.logging.LogRecord properties.

See Also:

Constant Field Values

EXTENDED_DATA_ELEMENT_NAME_LEVEL

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_LEVEL

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's level.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_LEVEL_NAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_LEVEL_NAME

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's child which contains the java.util.logging.LogRecord's level's name.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_LEVEL_VALUE

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_LEVEL_VALUE

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's child which contains the java.util.logging.LogRecord's level's value.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_LOGGER_NAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_LOGGER_NAME

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's logger name.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_SEQUENCE_NUMBER

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_SEQUENCE_NUMBER

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's sequence number.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_SOURCE_CLASS_NAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_SOURCE_CLASS_NAME

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's source class name.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_SOURCE_METHOD_NAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_SOURCE_METHOD_NAME

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's source method name.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_THREAD_ID

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_THREAD_ID

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's thread ID.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_THROWN

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_THROWN

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's org.eclipse.hyades.logging.events.cbe.ExtendedDataElement which contains the java.util.logging.LogRecord's thrown.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME

public static final java.lang.String EXTENDED_DATA_ELEMENT_NAME_THROWN_STACK_FRAME

Deprecated. As of 3.1, this property is no longer relevant (see #setThrown(Throwable)).

Instance variable which holds the name property of the encapsulated org.eclipse.hyades.logging.events.cbe.CommonBaseEvent's child org.eclipse.hyades.logging.events.cbe.ExtendedDataElement (s) which contain stack frames from the java.util.logging.LogRecord's thrown.

This name property is prefixed by the CommonBaseEventLogRecord: namespace (see EXTENDED_DATA_ELEMENT_NAME_NAMESPACE).

NOTE: The value of this org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 's name property is intended for use only by org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

See Also:

Constant Field Values

Constructor Detail

CommonBaseEventLogRecord

public CommonBaseEventLogRecord(CommonBaseEvent commonBaseEvent)

Single parameter constructor to create a Common Base Event log record with the parameter Common Base Event.

The following java.util.logging.LogRecord properties are mapped to the parameter Common Base Event log record based on its internal state or the java.util.logging.LogRecord default values (see the associated setter APIs for each property for mapping details):

java.util.logging.LogRecord Property	Value
level	SEVERE if the parameter Common Base Event's severity is set and is greater or equal to 50, WARNING if the parameter Common Base Event's severity is set and is between 30 and 49 (inclusive) or INFO if the parameter Common Base Event's severity is set and is less than or equal to 29 or OFF if the parameter Common Base Event's severity is not set.	sequenceNumber	A new unique value in increasing order within a JVM as initialized by the java.util.logging.LogRecord super class.	threadID	A new unique value for the current thread as initialized by the java.util.logging.LogRecord super class.	millis	The current time in milliseconds as initialized by the java.util.logging.LogRecord super class if the parameter Common Base Event's creationTime is not set.

NOTE: If the parameter Common Base Event log record is null, a java.util.logging.LogRecord will be constructed with a OFF level, null message and no Common Base Event capabilities.

NOTE: If the parameter Common Base Event log record does not contain either a Situation and/or SourceComponentId property, default properties will be constructed to ensure a well-formed Common Base Event.

Parameters:

commonBaseEvent - The Common Base Event of the newly created log record.

CommonBaseEventLogRecord

public CommonBaseEventLogRecord(CommonBaseEvent commonBaseEvent,
                                java.util.logging.Level level)

Double parameter constructor to create a Common Base Event log record with the parameter Common Base Event and a specified logging level.

The following java.util.logging.LogRecord properties are mapped to the parameter Common Base Event log record based on its internal state or the java.util.logging.LogRecord default values (see the associated setter APIs for each property for mapping details):

java.util.logging.LogRecord Property	Value
level	Based on the parameter java.util.logging.Level.	sequenceNumber	A new unique value in increasing order within a JVM as initialized by the java.util.logging.LogRecord super class.	threadID	A new unique value for the current thread as initialized by the java.util.logging.LogRecord super class.	millis	The current time in milliseconds as initialized by the java.util.logging.LogRecord super class if the parameter Common Base Event's creationTime is not set.

NOTE: If the parameter Common Base Event log record is null, a java.util.logging.LogRecord will be constructed with a OFF level, null message and no Common Base Event capabilities.

NOTE: If the parameter Common Base Event log record does not contain either a Situation and/or SourceComponentId property, default properties will be constructed to ensure a well-formed Common Base Event.

Parameters:

commonBaseEvent - The Common Base Event of the newly created log record.

level - The logging level of the newly created log record.

CommonBaseEventLogRecord

public CommonBaseEventLogRecord(java.util.logging.Level level,
                                java.lang.String message)

Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

Constructor to create a Common Base Event log record with the parameter logging level and message.

Using this constructor will result in the construction of a java.util.logging.LogRecord with no Common Base Event capabilities.

Parameters:

level - The logging level of the newly created log record.

message - The log message of the newly created log record.

CommonBaseEventLogRecord

public CommonBaseEventLogRecord(java.util.logging.Level level)

Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

Constructor to create a Common Base Event log record with the parameter logging level.

Using this constructor will result in the construction of a java.util.logging.LogRecord with no Common Base Event capabilities.

Parameters:

level - The logging level of the newly created log record.

CommonBaseEventLogRecord

public CommonBaseEventLogRecord(java.util.logging.LogRecord logRecord)

Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level).

Constructor to create a Common Base Event log record with the parameter java.util.logging.LogRecord.

Using this constructor will result in the construction of a java.util.logging.LogRecord with no Common Base Event capabilities.

Parameters:

logRecord - The java.util.logging.LogRecord of the newly created log record.

Method Detail

setCommonBaseEvent

public void setCommonBaseEvent(CommonBaseEvent commonBaseEvent)

Deprecated. Use CommonBaseEventLogRecord(CommonBaseEvent) or CommonBaseEventLogRecord(CommonBaseEvent, Level) constructors.

Sets value of the commonBaseEvent instance variable to the specified value.

Parameters:

commonBaseEvent - The new value of the commonBaseEvent instance variable.

setLevel

public void setLevel(java.util.logging.Level level)

Sets the non-null parameter level filter on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

This API will throw a java.lang.NullPointerException is the parameter level filter is null.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property

org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property

level

ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:level" ExtendedDataElement[0...n].Type = "noValue" ExtendedDataElement[0...n].Children[0].Name = "name" ExtendedDataElement[0...n].Children[0].Type = "string" ExtendedDataElement[0...n].Children[0].Values[0] = <level's name> ExtendedDataElement[0...n].Children[1].Name = "value" ExtendedDataElement[0...n].Children[0].Type = "int" ExtendedDataElement[0...n].Children[0].Values[0] = <level's numerical value>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

level - The non-null level filter, for example ALL.

See Also:

LogRecord.setLevel(java.util.logging.Level)

setLoggerName

public void setLoggerName(java.lang.String name)

Sets the log record's associated logger name on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
loggerName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:loggerName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <logger's name>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

name - The log record's associated logger name.

See Also:

LogRecord.setLoggerName(java.lang.String)

setMessage

public void setMessage(java.lang.String message)

Sets the string log message on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
msg	Unresolved (e.g. not localized or formatted) messages: MsgDataElement.MsgCatalogId = <message> - or - Resolved (e.g. localized and formatted) messages: msg = <message>

When the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is set to a non-null resource bundle name, the parameter message is assumed to be resolved (e.g. localized and formatted) and set to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property. Conversely, when the java.util.logging.LogRecord.resourceBundleName (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) is not set (e.g. null resource bundle name), the parameter message is assumed to be unresolved (e.g. no localized or formatted) and set to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property. Noteworthy, the java.util.logging.LogRecord.resourceBundle is not used to determine if the java.util.logging.LogRecord.message property is resolved (e.g. localized and formatted) since the resource bundle name (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) cannot be resolved from the java.util.logging.LogRecord.resourceBundle thereby generating an invalid Common Base Event (e.g. org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId without the required org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog).

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

message - The string log message.

See Also:

LogRecord.setMessage(java.lang.String)

setMillis

public void setMillis(long millis)

Sets the time stamp in milliseconds on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
millis	creationTime = <millis>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

millis - The time stamp in milliseconds.

See Also:

LogRecord.setMillis(long)

setParameters

public void setParameters(java.lang.Object[] parameters)

Sets the array of message parameters on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
parameters*	MsgDataElement.MsgCatalogTokens = <string representation of parameters>

* java.util.logging.LogRecord property is stored in java.util.logging.LogRecord super class to eliminate loss of data.

NOTE: This API delegates to both the associated API in the java.util.logging.LogRecord super class and the encapsulated Common Base Event.

Parameters:

parameters - The array of message parameters.

See Also:

LogRecord.setParameters(java.lang.Object[])

setResourceBundleName

public void setResourceBundleName(java.lang.String name)

Sets the name of the resource bundle on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
resourceBundleName	MsgDataElement.MsgCatalog = <resource bundle name>	MsgDataElement.MsgCatalogType = "Java"

When this method is invoked with a non-null resource bundle name, the java.util.logging.LogRecord.message property is assumed to be resolved (e.g. localized and formatted) and moved from the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property. Conversely, when this method is invoked with a null resource bundle name, the java.util.logging.LogRecord.message property is assumed to be unresolved (e.g. no localized or formatted) and moved from the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId property to the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msg property. Noteworthy, the java.util.logging.LogRecord.resourceBundle is not used to determine if the java.util.logging.LogRecord.message property is resolved (e.g. localized and formatted) since the resource bundle name (e.g org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog) cannot be resolved from the java.util.logging.LogRecord.resourceBundle thereby generating an invalid Common Base Event (e.g. org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalogId without the required org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.msgDataElement.MsgCatalog).

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

name - The name of the resource bundle.

See Also:

LogRecord.setResourceBundleName(java.lang.String)

setSequenceNumber

public void setSequenceNumber(long seq)

Sets the unique sequence number on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
sequenceNumber	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sequenceNumber" ExtendedDataElement[0...n].Type = "long" ExtendedDataElement[0...n].Values[0] = <sequence number>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

seq - The unique sequence number.

See Also:

LogRecord.setSequenceNumber(long)

setSourceClassName

public void setSourceClassName(java.lang.String sourceClassName)

Sets the name of the source class on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
sourceClassName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sourceClassName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <source class name>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

sourceClassName - The name of the source class.

See Also:

LogRecord.setSourceClassName(java.lang.String)

setSourceMethodName

public void setSourceMethodName(java.lang.String sourceMethodName)

Sets the name of the source method on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
sourceMethodName	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:sourceMethodName" ExtendedDataElement[0...n].Type = "string" ExtendedDataElement[0...n].Values[0] = <source method name>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

sourceMethodName - The name of the source method.

See Also:

LogRecord.setSourceMethodName(java.lang.String)

setThreadID

public void setThreadID(int threadID)

Sets the unique ID of an associated thread on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property	org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property
threadID	ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:threadID" ExtendedDataElement[0...n].Type = "int" ExtendedDataElement[0...n].Values[0] = <thread ID>

If the encapsulated Common Base Event log record is null, this API will delegate to the associated API in the java.util.logging.LogRecord super class.

Parameters:

threadID - The unique ID of an associated thread.

See Also:

LogRecord.setThreadID(int)

setThrown

public void setThrown(java.lang.Throwable thrown)

Sets an exception on the encapsulated Common Base Event or java.util.logging.LogRecord super class.

org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances map java.util.logging.LogRecord properties in the encapsulated Common Base Event using the following mapping:

java.util.logging.LogRecord Property

org.eclipse.hyades.logging.events.cbe.CommonBaseEvent Property

thrown*

ExtendedDataElement[0...n].Name = "CommonBaseEventLogRecord:stackTrace" ExtendedDataElement[0...n].Type = "stringArray" ExtendedDataElement[0...n].Values[0...n] = [< java.lang.Throwable's class name>[: < java.lang.Throwable's localized message>]] ExtendedDataElement[0...n].Values[(n + 1)...m] = < java.lang.Throwable's stackTraceElement[0...(m - (n + 1))]>] ExtendedDataElement[0...n].Children[0...m].Name = "Cause" ExtendedDataElement[0...n].Children[0...n].Type = "stringArray" ExtendedDataElement[0...n].Children[0...m].Values[0...n] = <cause's class name>[: <cause's localized message>] ExtendedDataElement[0...n].Children[0...m].Values[(n + 1)...m] = <cause's stackTraceElement[0...(m - (n + 1))]> [children[0] = <cause's cause>]

* java.util.logging.LogRecord property is stored in java.util.logging.LogRecord super class to eliminate loss of data.

If the Extended Data Element's values property is larger than 1024 characters, the string is segmented into a String array of 1024-character elements and set on the Extended Data Element. However, if the Extended Data Element's values property is 1024 or less characters, the string is set directly on the first element a String array and set on the Extended Data Element. As such, the type property is set to stringArray.

NOTE: This API delegates to both the associated API in the java.util.logging.LogRecord super class and the encapsulated Common Base Event.

Parameters:

thrown - An exception associated with this log record.

See Also:

LogRecord.setThrown(java.lang.Throwable), EventHelpers.convertToExtendedDataElement(Throwable, String).

getCommonBaseEvent

public CommonBaseEvent getCommonBaseEvent()

Gets the value of the commonBaseEvent instance variable.

Returns:

The value of the commonBaseEvent instance variable.

getLevel

public java.util.logging.Level getLevel()

Gets the level filter from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The level filter, for example ALL.

See Also:

LogRecord.getLevel()

getLoggerName

public java.lang.String getLoggerName()

Gets the log record's associated logger name from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The log record's associated logger name.

See Also:

LogRecord.getLoggerName()

getMessage

public java.lang.String getMessage()

Gets the string log message from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The string log message.

See Also:

LogRecord.getMessage()

getMillis

public long getMillis()

Gets the time stamp in milliseconds from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The time stamp in milliseconds.

See Also:

LogRecord.getMillis()

getParameters

public java.lang.Object[] getParameters()

Gets the array of message parameters from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The array of message parameters.

See Also:

LogRecord.getParameters()

getResourceBundleName

public java.lang.String getResourceBundleName()

Gets the level filter from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

name of the resource bundle

See Also:

LogRecord.getResourceBundleName()

getSequenceNumber

public long getSequenceNumber()

Gets the unique sequence number from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The unique sequence number.

See Also:

LogRecord.getSequenceNumber()

getSourceClassName

public java.lang.String getSourceClassName()

Gets the name of the source class from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The name of the source class.

See Also:

LogRecord.getSourceClassName()

getSourceMethodName

public java.lang.String getSourceMethodName()

Gets the name of the source method from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The name of the source method.

See Also:

LogRecord.getSourceMethodName()

getThreadID

public int getThreadID()

Gets the unique ID of an associated thread from the encapsulated Common Base Event or java.util.logging.LogRecord super class.

See the associated setter API for more details on the mapping of this java.util.logging.LogRecord property.

Returns:

The unique ID of an associated thread.

See Also:

LogRecord.getThreadID()

externalizeCanonicalXmlString

public java.lang.String externalizeCanonicalXmlString()

Generates the formatted XML fragment representation of the encapsulated Common Base Event property.

The formatted XML fragment is the representation of the encapsulated Common Base Event instance variable and not the XML fragment representation of the complete java.util.logging.LogRecord.

Specified by:

externalizeCanonicalXmlString in interface IExternalizableToXml

Returns:

The XML fragment representation of the Common Base Event in this log record, or null if the value of the commonBaseEvent instance variable is set to null.

externalizeCanonicalXmlDocString

public java.lang.String externalizeCanonicalXmlDocString()

Generates the formatted XML document representation of the encapsulated Common Base Event property.

The formatted XML document is the representation of the encapsulated Common Base Event instance variable and not the XML document representation of the complete java.util.logging.LogRecord.

Specified by:

externalizeCanonicalXmlDocString in interface IExternalizableToXml

Returns:

The XML document representation of the Common Base Event in this log record, or null if the value of the commonBaseEvent instance variable is set to null.

toString

public java.lang.String toString()

Returns the textual representation of this CommonBaseEventLogRecord.

Returns:

Textual representation of this CommonBaseEventLogRecord.

See Also:

Object.toString()