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.Appender;
21  import org.apache.log4j.spi.LoggingEvent;
22  import org.apache.log4j.spi.OptionHandler;
23  
24  
25  /***
26   * A <code>TriggeringPolicy</code> controls the conditions under which rollover
27   * occurs. Such conditions include time of day, file size, an
28   * external event, the log request or a combination thereof.
29   *
30   * @author Ceki G&uuml;lc&uuml;
31   * @author Curt Arnold
32   * 
33   */
34  public interface TriggeringPolicy extends OptionHandler {
35    /***
36     * Determines if a rollover may be appropriate at this time.  If
37     * true is returned, RolloverPolicy.rollover will be called but it
38     * can determine that a rollover is not warranted.
39     *
40     * @param appender A reference to the appender.
41     * @param event A reference to the currently event.
42     * @param filename The filename for the currently active log file.
43     * @param fileLength Length of the file in bytes.
44     * @return true if a rollover should occur.
45     */
46    public boolean isTriggeringEvent(
47      final Appender appender, final LoggingEvent event, final String filename,
48      final long fileLength);
49  }