Module com.aoapps.hodgepodge

Package com.aoapps.hodgepodge.logging

Class QueuedHandler

java.lang.Object

java.util.logging.Handler

com.aoapps.hodgepodge.logging.QueuedHandler

public abstract class QueuedHandler
extends Handler

An implementation of Handler that queues log records and handles them in the background. The log records are processed in the order received, regardless of level.

Configures itself similar to ConsoleHandler via HandlerUtil.configure(java.util.logging.Handler).

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueuedHandler(String executorThreadName)	Manages the queue internally.
protected	QueuedHandler(ExecutorService executor)	Uses the provided executor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	backgroundPublish(Formatter formatter, LogRecord rec, String fullReport)	This is called in a background thread.
void	close()
void	flush()	TODO: Could wait until all queued log records up to this moment have been handled.
protected static ExecutorService	newExecutor(String executorThreadName)	Creates a new executor.
void	publish(LogRecord rec)
protected static void	shutdownExecutor(ExecutorService executor)	Shuts down the executor, waiting up to one minute for tasks to complete.

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

QueuedHandler

protected QueuedHandler(String executorThreadName)

Manages the queue internally.

QueuedHandler

protected QueuedHandler(ExecutorService executor)

Uses the provided executor. The executor is not shutdown on close(); it is up to the caller to manage the executor lifecycle.

See Also:

• newExecutor(java.lang.String)
• shutdownExecutor(java.util.concurrent.ExecutorService)

Method Details

newExecutor

protected static ExecutorService newExecutor(String executorThreadName)

Creates a new executor. Must be shutdown when no longer needed.

shutdownExecutor

protected static void shutdownExecutor(ExecutorService executor)
                                throws SecurityException

Shuts down the executor, waiting up to one minute for tasks to complete.

Throws:

SecurityException

publish

public void publish(LogRecord rec)

Specified by:

publish in class Handler

See Also:

• StreamHandler.publish(java.util.logging.LogRecord)

flush

public void flush()

TODO: Could wait until all queued log records up to this moment have been handled. If new log records are added while we wait, don't wait for them.

Specified by:

flush in class Handler

close

public void close()
           throws SecurityException

Specified by:

close in class Handler

Throws:

SecurityException

backgroundPublish

protected abstract void backgroundPublish(Formatter formatter,
 LogRecord rec,
 String fullReport)
                                   throws Exception

This is called in a background thread.

Parameters:

formatter - the formatter at the time the record was queued

rec - the queued record

fullReport - the complete message generated by the formatter before the record was queued. The message is generated before so it can have accurate thread and time information.

Throws:

Exception