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

All Known Implementing Classes:

AbstractRolloverStrategy, DefaultRolloverStrategy

public interface RolloverStrategy

A RollingPolicy specifies the actions taken on a logging file rollover.

Method Summary

RolloverDescription

rollover(RollingFileManager manager) Prepare for a rollover.

Method Detail

rollover

RolloverDescription rollover(RollingFileManager manager)
                             throws SecurityException

Prepare for a rollover. This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.

Parameters:

manager - The RollingFileManager name for current active log file.

Returns:

Description of pending rollover, may be null to indicate no rollover at this time.

Throws:

SecurityException - if denied access to log files.