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 package org.apache.logging.log4j.core.appender.rolling; 18 19 import org.apache.logging.log4j.core.LogEvent; 20 21 /** 22 * A <code>TriggeringPolicy</code> controls the conditions under which rollover 23 * occurs. Such conditions include time of day, file size, an 24 * external event, the log request or a combination thereof. 25 * 26 * @see AbstractTriggeringPolicy 27 */ 28 public interface TriggeringPolicy /* TODO 3.0: extends LifeCycle */ { 29 30 /** 31 * Initializes this triggering policy. 32 * @param manager The RollingFileManager. 33 */ 34 35 void initialize(final RollingFileManager manager); 36 37 /** 38 * Determines if a rollover may be appropriate at this time. If 39 * true is returned, RolloverPolicy.rollover will be called but it 40 * can determine that a rollover is not warranted. 41 * 42 * @param logEvent A reference to the current log event. 43 * @return true if a rollover should occur. 44 */ 45 boolean isTriggeringEvent(final LogEvent logEvent); 46 }