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.appender.rolling.action.Action; 20 21 /** 22 * Description of actions needed to complete rollover. 23 */ 24 public interface RolloverDescription { 25 /** 26 * Active log file name after rollover. 27 * 28 * @return active log file name after rollover. 29 */ 30 String getActiveFileName(); 31 32 /** 33 * Specifies if active file should be opened for appending. 34 * 35 * @return if true, active file should be opened for appending. 36 */ 37 boolean getAppend(); 38 39 /** 40 * Action to be completed after close of current active log file 41 * before returning control to caller. 42 * 43 * @return action, may be null. 44 */ 45 Action getSynchronous(); 46 47 /** 48 * Action to be completed after close of current active log file 49 * and before next rollover attempt, may be executed asynchronously. 50 * 51 * @return action, may be null. 52 */ 53 Action getAsynchronous(); 54 }