Module org.glassfish.main.jul

Package org.glassfish.main.jul.handler

Class LogCollectorHandler

java.lang.Object

java.util.logging.Handler

org.glassfish.main.jul.handler.LogCollectorHandler

public class LogCollectorHandler
extends Handler

This special Handler can be used for testing purposes. It collects log records passing through the given Logger instance.

Author:

David Matejcek

Constructor Summary

Constructors

Constructor	Description
LogCollectorHandler(Logger loggerToFollow)	Creates a LogRecord collector handler with the capacity of 100 records and maximal wait time 5 seconds.
LogCollectorHandler(Logger loggerToFollow, int capacity, int maxWait)

Method Summary

Modifier and Type	Method	Description
void	close()	Unattaches the handler from the logger and drops all collected log records.
void	flush()
List<GlassFishLogRecord>	getAll()	Creates a list of all records and resets the buffer.
<R> List<R>	getAll(Function<LogRecord,R> mappingFunction)	Creates a list of all records and resets the buffer.
GlassFishLogRecord	pop()	Removes the first record in the buffer and returns it.
void	publish(LogRecord record)
void	reset()	Drops all collected records.

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Constructor Details

LogCollectorHandler

public LogCollectorHandler(Logger loggerToFollow)

Creates a LogRecord collector handler with the capacity of 100 records and maximal wait time 5 seconds.

Parameters:

loggerToFollow - this handler will be added to this logger.

See Also:

• LogRecordBuffer

LogCollectorHandler

public LogCollectorHandler(Logger loggerToFollow,
 int capacity,
 int maxWait)

Parameters:

loggerToFollow - this handler will be added to this logger.

capacity - capacity of the buffer.

maxWait - maximal time in seconds to wait for the free capacity. If < 1, can wait forever.

See Also:

• LogRecordBuffer

Method Details

publish

public void publish(LogRecord record)

Specified by:

publish in class Handler

flush

public void flush()

Specified by:

flush in class Handler

close

public void close()
           throws SecurityException

Unattaches the handler from the logger and drops all collected log records.

Specified by:

close in class Handler

Throws:

SecurityException

pop

public GlassFishLogRecord pop()

Removes the first record in the buffer and returns it.

Returns:

the first GlassFishLogRecord in the buffer or null if the buffer is empty.

getAll

public List<GlassFishLogRecord> getAll()

Creates a list of all records and resets the buffer.

Returns:

all collected records

getAll

public <R> List<R> getAll(Function<LogRecord,R> mappingFunction)

Creates a list of all records and resets the buffer.

Type Parameters:

R - expected item type

Parameters:

mappingFunction -

Returns:

all collected records

reset

public void reset()

Drops all collected records.