ch.qos.logback.core.rolling.TriggeringPolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.core.rolling;

import java.io.File;
import ch.qos.logback.core.spi.LifeCycle;

/**
 * A TriggeringPolicy controls the conditions under which roll-over
 * occurs. Such conditions include time of day, file size, an
 * external event, the log request or a combination thereof.
 *
 * @author Ceki Gülcü
 */
// @deprecated This internal logback API is not supported by AEM as a Cloud Service.
@Deprecated(since = "2022-01-27")
public interface TriggeringPolicy extends LifeCycle {

    /**
     * Should roll-over be triggered at this time?
     *
     * @param activeFile A reference to the currently active log file.
     * @param event A reference to the currently event.
     * @return true if a roll-over should occur.
     */
    boolean isTriggeringEvent(final File activeFile, final E event);
}