Module org.glassfish.main.jul

Package org.glassfish.main.jul.formatter

Class LogFormatDetector

java.lang.Object

org.glassfish.main.jul.formatter.LogFormatDetector

public class LogFormatDetector
extends Object

Detector of known standardized log formats.

Author:

David Matejcek

Field Summary

Fields

Modifier and Type	Field	Description
static final String	P_LEVEL_NAME	Pattern string for Level name: usually upper case letters.
static final String	P_LEVEL_VALUE	Pattern string for Level value: usually int value.
static final String	P_LOGGER_NAME	Pattern string for usual Logger name: if present, contains letters and dots.
static final String	P_MESSAGE_KEY	Pattern string for usual message key used with resource bundles: if present, letters, dots and numbers.
static final String	P_PRODUCT_ID	Pattern string for a product id: any non-mandatory text.
static final String	P_TIME	Pattern string for usual time format: HH:mm:ss.SSS
static final String	P_TIMESTAMP	Pattern string for usual ISO-8601 timestamp format: 2021-05-20T12:45:33.123456Z
static final String	P_TIMEZONE	Pattern string for usual time zone format: +02:00, +0200 or Z

Constructor Summary

Constructors

Constructor	Description
LogFormatDetector()

Method Summary

Modifier and Type	Method	Description
String	detectFormatter(File logFile, Charset expectedCharset)
String	detectFormatter(String firstLine)
boolean	isCompressedFile(String filename)	Determines whether the given file is compressed (name ends with .gz).
boolean	isODLFormatLogHeader(String firstLine)
boolean	isOneLineLFormatLogHeader(String firstLine)
boolean	isUniformFormatLogHeader(String firstLine)

Methods inherited from class java.lang.Object

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

Field Details

P_TIME

public static final String P_TIME

Pattern string for usual time format: HH:mm:ss.SSS

See Also:

• Constant Field Values

P_TIMEZONE

public static final String P_TIMEZONE

Pattern string for usual time zone format: +02:00, +0200 or Z

See Also:

• Constant Field Values

P_TIMESTAMP

public static final String P_TIMESTAMP

Pattern string for usual ISO-8601 timestamp format: 2021-05-20T12:45:33.123456Z

See Also:

• Constant Field Values

P_LEVEL_NAME

public static final String P_LEVEL_NAME

Pattern string for Level name: usually upper case letters.

See Also:

• Constant Field Values

P_LEVEL_VALUE

public static final String P_LEVEL_VALUE

Pattern string for Level value: usually int value.

See Also:

• Constant Field Values

P_LOGGER_NAME

public static final String P_LOGGER_NAME

Pattern string for usual Logger name: if present, contains letters and dots.

See Also:

• Constant Field Values

P_MESSAGE_KEY

public static final String P_MESSAGE_KEY

Pattern string for usual message key used with resource bundles: if present, letters, dots and numbers.

See Also:

• Constant Field Values

P_PRODUCT_ID

public static final String P_PRODUCT_ID

Pattern string for a product id: any non-mandatory text.

See Also:

• Constant Field Values

Constructor Details

LogFormatDetector

public LogFormatDetector()

Method Details

detectFormatter

public String detectFormatter(File logFile,
 Charset expectedCharset)

Parameters:

logFile -

expectedCharset -

Returns:

full class name of the concrete detected Formatter or null if the file is null or could not be read.

detectFormatter

public String detectFormatter(String firstLine)

Parameters:

firstLine -

Returns:

null for unknown file format, full class name otherwise.

isODLFormatLogHeader

public boolean isODLFormatLogHeader(String firstLine)

Parameters:

firstLine -

Returns:

true if the given line is probably a beginning of a ODL log record.

isOneLineLFormatLogHeader

public boolean isOneLineLFormatLogHeader(String firstLine)

Parameters:

firstLine -

Returns:

true if the given line is probably a beginning of a OneLineFormatter's log record.

isUniformFormatLogHeader

public boolean isUniformFormatLogHeader(String firstLine)

Parameters:

firstLine -

Returns:

true if the given line is probably a beginning of a Uniform log record.

isCompressedFile

public boolean isCompressedFile(String filename)

Determines whether the given file is compressed (name ends with .gz).

Parameters:

filename -

Returns:

true if the filename ends with ".gz"