    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements. See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache license, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License. You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the license for the specific language governing permissions and
    015     * limitations under the license.
    016     */
    017    package org.apache.logging.log4j.core.appender.rolling;
    018
    019    /**
    020     * A <code>RollingPolicy</code> specifies the actions taken on a logging file rollover.
    021     *
    022     */
    023    public interface RolloverStrategy {
    024        /**
    025         * Prepare for a rollover.  This method is called prior to closing the active log file, performs any necessary
    026         * preliminary actions and describes actions needed after close of current log file.
    027         *
    028         * @param manager The RollingFileManager name for current active log file.
    029         * @return Description of pending rollover, may be null to indicate no rollover at this time.
    030         * @throws SecurityException if denied access to log files.
    031       */
    032        RolloverDescription rollover(final RollingFileManager manager) throws SecurityException;
    033    }