org.apache.log4j.rolling
Interface RollingPolicy
- All Superinterfaces:
- OptionHandler
- All Known Implementing Classes:
- RollingPolicyBase
- public interface RollingPolicy
- extends OptionHandler
A RollingPolicy
specifies the actions taken
on a logging file rollover.
- Since:
- 1.3
- Author:
- Ceki Gülcü, Curt Arnold
initialize
public RolloverDescription initialize(String file,
boolean append)
throws SecurityException
- Initialize the policy and return any initial actions for rolling file appender..
- Parameters:
file
- current value of RollingFileAppender.getFile().append
- current value of RollingFileAppender.getAppend().- Returns:
- Description of the initialization, may be null to indicate
no initialization needed.
- Throws:
SecurityException
- if denied access to log files.
rollover
public RolloverDescription rollover(String activeFile)
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:
activeFile
- file 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.
Copyright © 2000-2006 Apache Software Foundation.
Licensed under the Apache License, Version 2.0.