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  package org.apache.logging.log4j.core.appender.rolling;
    18
    19  /**
    20   * A <code>RollingPolicy</code> specifies the actions taken on a logging file rollover.
    21   *
    22   */
    23  public interface RolloverStrategy {
    24      /**
    25       * Prepare for a rollover.  This method is called prior to closing the active log file, performs any necessary
    26       * preliminary actions and describes actions needed after close of current log file.
    27       *
    28       * @param manager The RollingFileManager name for current active log file.
    29       * @return Description of pending rollover, may be null to indicate no rollover at this time.
    30       * @throws SecurityException if denied access to log files.
    31     */
    32      RolloverDescription rollover(final RollingFileManager manager) throws SecurityException;
    33  }