A FileHandler implementation that uses a queue of log entries.

Configuration properties are inherited from the FileHandler class. This class does not add its own configuration properties for the logging configuration, but relies on the following system properties instead:

org.apache.juli.AsyncOverflowDropType Default value: 1
org.apache.juli.AsyncMaxRecordCount Default value: 10000

See the System Properties page in the configuration reference of Tomcat.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	AsyncFileHandler.DropFlushPolicy
private static class	AsyncFileHandler.DropLastPolicy
pack-priv static class	AsyncFileHandler.LoggerExecutorService

Field Summary

Modifier and Type	Field and Description
protected volatile boolean	closed
private final Object	closeLock
public static final int	DEFAULT_MAX_RECORDS
public static final int	DEFAULT_OVERFLOW_DROP_TYPE
private static final AsyncFileHandler.LoggerExecutorService	LOGGER_SERVICE
private final AsyncFileHandler.LoggerExecutorService	loggerService
public static final int	MAX_RECORDS
public static final int	OVERFLOW_DROP_CURRENT
public static final int	OVERFLOW_DROP_FIRST
public static final int	OVERFLOW_DROP_FLUSH
public static final int	OVERFLOW_DROP_LAST
public static final int	OVERFLOW_DROP_TYPE
pack-priv static final String	THREAD_PREFIX

Inherited from org.apache.juli.FileHandler:: DEFAULT_BUFFER_SIZE DEFAULT_MAX_DAYS writerLock

Constructor Summary

Access	Constructor and Description
public	AsyncFileHandler()
public	AsyncFileHandler(String directory, String prefix, String suffix)
public	AsyncFileHandler(String directory, String prefix, String suffix, Integer maxDays)
pack-priv	AsyncFileHandler(String directory, String prefix, String suffix, Integer maxDays, AsyncFileHandler.LoggerExecutorService loggerService)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.apache.juli.FileHandler.close. Close the currently open log file (if any).
public void	open() Overrides org.apache.juli.FileHandler.open. Open the new log file for the date specified by `date`.
public void	publish(LogRecord description of the log event record) Overrides org.apache.juli.FileHandler.publish. Format and publish a `LogRecord`.
protected void	publishInternal(LogRecord record)

Inherited from org.apache.juli.FileHandler:: closeWriter flush openWriter

Field Detail

closed	back to summary
protected volatile boolean closed

closeLock	back to summary
private final Object closeLock

DEFAULT_MAX_RECORDS	back to summary
public static final int DEFAULT_MAX_RECORDS

DEFAULT_OVERFLOW_DROP_TYPE	back to summary
public static final int DEFAULT_OVERFLOW_DROP_TYPE

LOGGER_SERVICE	back to summary
private static final AsyncFileHandler.LoggerExecutorService LOGGER_SERVICE

loggerService	back to summary
private final AsyncFileHandler.LoggerExecutorService loggerService

MAX_RECORDS	back to summary
public static final int MAX_RECORDS

OVERFLOW_DROP_CURRENT	back to summary
public static final int OVERFLOW_DROP_CURRENT

OVERFLOW_DROP_FIRST	back to summary
public static final int OVERFLOW_DROP_FIRST

OVERFLOW_DROP_FLUSH	back to summary
public static final int OVERFLOW_DROP_FLUSH

OVERFLOW_DROP_LAST	back to summary
public static final int OVERFLOW_DROP_LAST

OVERFLOW_DROP_TYPE	back to summary
public static final int OVERFLOW_DROP_TYPE

THREAD_PREFIX	back to summary
pack-priv static final String THREAD_PREFIX

Constructor Detail

AsyncFileHandler	back to summary
public AsyncFileHandler()

AsyncFileHandler	back to summary
public AsyncFileHandler(String directory, String prefix, String suffix)

AsyncFileHandler	back to summary
public AsyncFileHandler(String directory, String prefix, String suffix, Integer maxDays)

AsyncFileHandler	back to summary
pack-priv AsyncFileHandler(String directory, String prefix, String suffix, Integer maxDays, AsyncFileHandler.LoggerExecutorService loggerService)

Method Detail

close	back to summary
public void close() Overrides org.apache.juli.FileHandler.close. Doc from org.apache.juli.FileHandler.close. Close the currently open log file (if any). Annotations @Override

back to summary

public void close()

Overrides org.apache.juli.FileHandler.close.

Doc from org.apache.juli.FileHandler.close.

Close the currently open log file (if any).

Annotations

@Override

open back to summary

open	back to summary
public void open() Overrides org.apache.juli.FileHandler.open. Doc from org.apache.juli.FileHandler.open. Open the new log file for the date specified by `date`. Annotations @Override

public void open()

Overrides org.apache.juli.FileHandler.open.

Doc from org.apache.juli.FileHandler.open.

Open the new log file for the date specified by date.

Annotations

@Override

publish back to summary

publish	back to summary
public void publish(LogRecord record) Overrides org.apache.juli.FileHandler.publish. Doc from org.apache.juli.FileHandler.publish. Format and publish a `LogRecord`. Parameters record:LogRecord description of the log event Annotations @Override

public void publish(LogRecord record)

Overrides org.apache.juli.FileHandler.publish.

Doc from org.apache.juli.FileHandler.publish.

Format and publish a LogRecord.

Parameters

record:LogRecord: description of the log event

Annotations

@Override

publishInternal	back to summary
protected void publishInternal(LogRecord record)

org.apache.juli back to summary

private Class AsyncFileHandler.DropFlushPolicy

Class Inheritance

extends Object
implements RejectedExecutionHandler

java.lang.Object
org.apache.juli.AsyncFileHandler.DropFlushPolicy

All Implemented Interfaces

java.util.concurrent.RejectedExecutionHandler

Constructor Summary

Access	Constructor and Description
private	DropFlushPolicy()

Method Summary

Modifier and Type	Method and Description
public void	rejectedExecution(Runnable the runnable task requested to be executed r, ThreadPoolExecutor the executor attempting to execute this task executor) Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Method that may be invoked by a `ThreadPoolExecutor` when `execute` cannot accept a task.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DropFlushPolicy	back to summary
private DropFlushPolicy()

Method Detail

rejectedExecution back to summary

rejectedExecution	back to summary
public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Doc from java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Method that may be invoked by a `ThreadPoolExecutor` when `execute` cannot accept a task. This may occur when no more threads or queue slots are available because their bounds would be exceeded, or upon shutdown of the Executor. In the absence of other alternatives, the method may throw an unchecked `RejectedExecutionException`, which will be propagated to the caller of `execute`. Parameters r:Runnable the runnable task requested to be executed executor:ThreadPoolExecutor the executor attempting to execute this task Annotations @Override

public void rejectedExecution(Runnable r, ThreadPoolExecutor executor)

Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution.

Doc from java.util.concurrent.RejectedExecutionHandler.rejectedExecution.

Method that may be invoked by a ThreadPoolExecutor when execute cannot accept a task. This may occur when no more threads or queue slots are available because their bounds would be exceeded, or upon shutdown of the Executor.

In the absence of other alternatives, the method may throw an unchecked RejectedExecutionException, which will be propagated to the caller of execute.

Parameters

r:Runnable: the runnable task requested to be executed
executor:ThreadPoolExecutor: the executor attempting to execute this task

Annotations

@Override

org.apache.juli back to summary

private Class AsyncFileHandler.DropLastPolicy

Class Inheritance

extends Object
implements RejectedExecutionHandler

java.lang.Object
org.apache.juli.AsyncFileHandler.DropLastPolicy

All Implemented Interfaces

java.util.concurrent.RejectedExecutionHandler

Constructor Summary

Access	Constructor and Description
private	DropLastPolicy()

Method Summary

Modifier and Type	Method and Description
public void	rejectedExecution(Runnable the runnable task requested to be executed r, ThreadPoolExecutor the executor attempting to execute this task executor) Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Method that may be invoked by a `ThreadPoolExecutor` when `execute` cannot accept a task.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DropLastPolicy	back to summary
private DropLastPolicy()

Method Detail

rejectedExecution back to summary

rejectedExecution	back to summary
public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Doc from java.util.concurrent.RejectedExecutionHandler.rejectedExecution. Method that may be invoked by a `ThreadPoolExecutor` when `execute` cannot accept a task. This may occur when no more threads or queue slots are available because their bounds would be exceeded, or upon shutdown of the Executor. In the absence of other alternatives, the method may throw an unchecked `RejectedExecutionException`, which will be propagated to the caller of `execute`. Parameters r:Runnable the runnable task requested to be executed executor:ThreadPoolExecutor the executor attempting to execute this task Annotations @Override

public void rejectedExecution(Runnable r, ThreadPoolExecutor executor)

Implements java.util.concurrent.RejectedExecutionHandler.rejectedExecution.

Doc from java.util.concurrent.RejectedExecutionHandler.rejectedExecution.

In the absence of other alternatives, the method may throw an unchecked RejectedExecutionException, which will be propagated to the caller of execute.

Parameters

r:Runnable: the runnable task requested to be executed
executor:ThreadPoolExecutor: the executor attempting to execute this task

Annotations

@Override

org.apache.juli back to summary

pack-priv Class AsyncFileHandler.LoggerExecutorService

Class Inheritance

extends ThreadPoolExecutor

java.lang.Object
java.util.concurrent.AbstractExecutorService
java.util.concurrent.ThreadPoolExecutor
org.apache.juli.AsyncFileHandler.LoggerExecutorService

Field Summary

Modifier and Type	Field and Description
private final AtomicInteger	handlerCount
private static final FileHandler.ThreadFactory	THREAD_FACTORY

Constructor Summary

Access	Constructor and Description
pack-priv	LoggerExecutorService(final int overflowDropType, final int maxRecords)

Method Summary

Modifier and Type	Method and Description
public void	deregisterHandler()
public LinkedBlockingDeque<Runnable>	getQueue() Overrides java.util.concurrent.ThreadPoolExecutor.getQueue. Returns the task queue used by this executor.
public void	registerHandler()

Field Detail

handlerCount	back to summary
private final AtomicInteger handlerCount

THREAD_FACTORY	back to summary
private static final FileHandler.ThreadFactory THREAD_FACTORY

Constructor Detail

LoggerExecutorService	back to summary
pack-priv LoggerExecutorService(final int overflowDropType, final int maxRecords)

Method Detail

deregisterHandler	back to summary
public void deregisterHandler()

getQueue	back to summary
public LinkedBlockingDeque<Runnable> getQueue() Overrides java.util.concurrent.ThreadPoolExecutor.getQueue. Doc from java.util.concurrent.ThreadPoolExecutor.getQueue. Returns the task queue used by this executor. Access to the task queue is intended primarily for debugging and monitoring. This queue may be in active use. Retrieving the task queue does not prevent queued tasks from executing. Returns:LinkedBlockingDeque<Runnable> the task queue Annotations @Override

getQueue

back to summary

public LinkedBlockingDeque<Runnable> getQueue()

Overrides java.util.concurrent.ThreadPoolExecutor.getQueue.

Doc from java.util.concurrent.ThreadPoolExecutor.getQueue.

Returns the task queue used by this executor. Access to the task queue is intended primarily for debugging and monitoring. This queue may be in active use. Retrieving the task queue does not prevent queued tasks from executing.

Returns:LinkedBlockingDeque<Runnable>

the task queue

Annotations

@Override

registerHandler	back to summary
public void registerHandler()

public Class AsyncFileHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AsyncFileHandler.DropFlushPolicy

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class AsyncFileHandler.DropLastPolicy

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class AsyncFileHandler.LoggerExecutorService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail