View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.log4j.rolling;
19  
20  import org.apache.log4j.spi.OptionHandler;
21  
22  
23  /***
24   * A <code>RollingPolicy</code> specifies the actions taken
25   * on a logging file rollover.
26   *
27   * @author Ceki G&uuml;lc&uuml;
28   * @author Curt Arnold
29   * */
30  public interface RollingPolicy extends OptionHandler {
31    /***
32     * Initialize the policy and return any initial actions for rolling file appender..
33     *
34     * @param file current value of RollingFileAppender.getFile().
35     * @param append current value of RollingFileAppender.getAppend().
36     * @return Description of the initialization, may be null to indicate
37     * no initialization needed.
38     * @throws SecurityException if denied access to log files.
39     */
40    public RolloverDescription initialize(
41      final String file, final boolean append) throws SecurityException;
42  
43    /***
44     * Prepare for a rollover.  This method is called prior to
45     * closing the active log file, performs any necessary
46     * preliminary actions and describes actions needed
47     * after close of current log file.
48     *
49     * @param activeFile file name for current active log file.
50     * @return Description of pending rollover, may be null to indicate no rollover
51     * at this time.
52     * @throws SecurityException if denied access to log files.
53     */
54    public RolloverDescription rollover(final String activeFile) throws SecurityException;
55  }