Web Client 8.0.8

BufferAppender

BufferAppender

BufferAppender extends SimpleLogAppender and implements an internal buffer store for log messages. The messages can be extracted from the buffer when needed. The buffer size can be limited or unlimited. If limited it is implemented as a FIFO queue.

Constructor

new BufferAppender(level, category, size)

Constructor for BufferAppender.

Parameters:
Name Type Description
level String

The threshold level at which the SimpleLogAppender is created. It should be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL". If not or wrongly specified INFO is assumed.

category String

The category this appender should listen to. If not specified the appender will get log for every available category. See SimpleLogAppender#setCategoryFilter.

size Number

The maximum number of log messages stored in the internal buffer. If 0 or no value is passed, unlimited is assumed.

Extends

Methods

(protected) composeLine(category, level, mex, header) → {String}

Utility method that can be used by subclasses to join various info in a single line. The message will be composed this way: category + " | " + level + " | " + header + " | " + mex

Parameters:
Name Type Description
category String

the message category

level String

the message level

mex String

the message itself

header String

a custom header

Inherited From:
Returns:
Type
String

extractLog(sepopt) → {String}

Retrieve log messages from the buffer. The extracted messages are then removed from the internal buffer.

Parameters:
Name Type Attributes Description
sep String <optional>

separator string between the log messages in the result string. If null or not specified "\n" is used.

Returns:

a concatenated string of all the log messages that have been retrieved.

Type
String

getCategoryFilter() → {String}

Inquiry method that returns the category for this SimpleLogAppender instance. A SimpleLogAppender only receives log lines from the Logger associated to the returned category, unless "*" is returned, in which case it receives log from all loggers.

Inherited From:
Returns:

The category of this SimpleLogAppender instance, or "*".

Type
String

getLength() → {Number}

Gets the number of buffered lines

Returns:

the number of buffered lines

Type
Number

getLevel() → {String}

Inquiry method that returns the current threshold level of this SimpleLogAppender instance.

Inherited From:
Returns:

the level of this SimpleLogAppender instance. It will be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL".

Type
String

getLog(maxRowsopt, sepopt, levelopt) → {String}

Retrieve log messages from the buffer. The extracted messages are NOT removed from the internal buffer.

Parameters:
Name Type Attributes Description
maxRows Number <optional>

the number of log lines to be retrieved. If not specified all the available lines are retrieved.

sep String <optional>

separator string between the log messages in the result string. If not specified "\n" is used.

level String <optional>

the level of the log to be retrieved.

Returns:

a concatenated string of all the log messages that have been retrieved.

Type
String

log(category, level, mex, header)

Add a log message in the internal buffer.

Parameters:
Name Type Description
category String

the logger category that produced the given message.

level String

the logging level of the given message. It should be one of DEBUG INFO WARN ERROR FATAL.

mex String

the message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method.

header String

a header for the message

Overrides:

reset()

Operation method that resets the buffer making it empty.

setCategoryFilter(categoryopt)

Setter method that changes the current category of this SimpleLogAppender instance.
This SimpleLogAppender will only receive log lines from the Logger associated to the specified category, unless "*" is specified, in which case it will receive log from all loggers.
the filter can be changed at any time and will affect subsequent log lines.

Parameters:
Name Type Attributes Description
category String <optional>

the new category for this SimpleLogAppender, or "". If not specified "" is assumed

Inherited From:

setLevel(levelopt)

Setter method that changes the current threshold level of this SimpleLogAppender instance. The filter can be changed at any time and will affect subsequent log lines

Parameters:
Name Type Attributes Description
level String <optional>

The new level for this SimpleLogAppender instance. It should be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL". If not or wrongly specified INFO will be used.

Inherited From:

setLoggerProvider(loggerProvider)

Called by SimpleLoggerProvider to notify itself to a newly added appender.

Parameters:
Name Type Description
loggerProvider SimpleLoggerProvider

the SimpleLoggerProvider instance handling this appender.

Inherited From: