com.goldencode.p2j.util.logging

Class CentralLogFormatter

java.lang.Object

java.util.logging.Formatter

com.goldencode.p2j.util.logging.CentralLogFormatter

public class CentralLogFormatter
extends java.util.logging.Formatter

Extends the java formatter base class used by FileHandler. Exposes portions of the formatting logic to be reused by other formatters or directly by the CentralLogger. Provides a parse method to convert back formatted text into CentralLogRecord.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.SimpleDateFormat	DATETIME_FORMATTER The datetime formatter used for each log record.
private static java.lang.String	LINE_SEPARATOR The line separator for the operating system.
(package private) static java.lang.String	LOG_PARTS_DIVIDER The divider between different parts of the log message.

Constructor Summary

Constructors

Constructor and Description
CentralLogFormatter()

Method Summary

Modifier and Type	Method and Description
protected static ContextLogRecord.LogContext	describeContext(java.lang.Integer sessionId, java.lang.String userId, boolean excludeSMContext) Get a string which uniquely describes the current context.
(package private) static void	dumpMessage(java.lang.StringBuilder sb, java.util.logging.LogRecord record) Appends the log message to the string builder.
(package private) static void	dumpThrowable(java.lang.StringBuilder sb, java.lang.Throwable original) Dump all details of the throwable into the given string buffer.
java.lang.String	format(java.util.logging.LogRecord record) Transforms the log record to string.
(package private) static CentralLogRecord	parse(java.lang.String logLine) Convert back formatted text into CentralLogRecord.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Field Detail

LOG_PARTS_DIVIDER

static final java.lang.String LOG_PARTS_DIVIDER

The divider between different parts of the log message.

See Also:

Constant Field Values

DATETIME_FORMATTER

private static final java.text.SimpleDateFormat DATETIME_FORMATTER

The datetime formatter used for each log record. Similar to the one used in 4GL LOG-MANAGER.

LINE_SEPARATOR

private static final java.lang.String LINE_SEPARATOR

The line separator for the operating system.

Constructor Detail

CentralLogFormatter

public CentralLogFormatter()

Method Detail

describeContext

protected static ContextLogRecord.LogContext describeContext(java.lang.Integer sessionId,
                                                             java.lang.String userId,
                                                             boolean excludeSMContext)

Get a string which uniquely describes the current context. Consists of multiple parts: - the name of the logger mode, - (for clients with initialized native lib) process id, - thread name, - (when security manager has context initialized) session, thread and user id.

Parameters:

sessionId - The remote server session ID.

userId - The remote server user ID.

excludeSMContext - Flag to prevent deadlock on SecurityManager, ref #5703#note-77.

Returns:

Description of the context.

parse

static CentralLogRecord parse(java.lang.String logLine)

Convert back formatted text into CentralLogRecord.

Parameters:

logLine - The formatted log.

Returns:

CentralLogRecord parsed from the provided text.

dumpThrowable

static void dumpThrowable(java.lang.StringBuilder sb,
                          java.lang.Throwable original)

Dump all details of the throwable into the given string buffer. Includes exception type, message, complete stack trace, and chained throwables, if any.

Parameters:

sb - The string builder the throwable to be appended to.

original - The throwable to dump.

dumpMessage

static void dumpMessage(java.lang.StringBuilder sb,
                        java.util.logging.LogRecord record)

Appends the log message to the string builder.

Parameters:

sb - The string builder the message to be appended to.

record - The log record with the message or the message format and parameters.

format

public java.lang.String format(java.util.logging.LogRecord record)

Transforms the log record to string. A divider separates the different parts: - datetime, - log level, - logger name, - (optional) source class name, source method name, - message (no divider after it), - (optional) throwable.

Specified by:

format in class java.util.logging.Formatter

Parameters:

record - The log record.

Returns:

The string representation of the log record.