org.apache.logging.log4j.core.appender.rolling
Interface TriggeringPolicy

All Known Implementing Classes:

CompositeTriggeringPolicy, OnStartupTriggeringPolicy, SizeBasedTriggeringPolicy, TimeBasedTriggeringPolicy

public interface TriggeringPolicy

A TriggeringPolicy controls the conditions under which rollover occurs. Such conditions include time of day, file size, an external event, the log request or a combination thereof.

Method Summary

void	initialize(RollingFileManager manager) Initialize the Policy.
boolean	isTriggeringEvent(LogEvent event) Determines if a rollover may be appropriate at this time.

Method Detail

initialize

void initialize(RollingFileManager manager)

Initialize the Policy.

Parameters:

manager - The RollingFileManager.

isTriggeringEvent

boolean isTriggeringEvent(LogEvent event)

Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Parameters:

event - A reference to the currently event.

Returns:

true if a rollover should occur.