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 */
017package org.apache.logging.log4j.core.appender.routing;
018
019import org.apache.logging.log4j.core.LogEvent;
020
021/**
022 * Policy for purging routed appenders
023 */
024public interface PurgePolicy {
025
026        /**
027         * Activates purging appenders. Note that {@link PurgePolicy} implementations are responsible for invoking
028         * this method themselves.
029         */
030        void purge();
031
032        /**
033         * @param key routed appender key
034         * @param event
035         */
036        void update(String key, LogEvent event);
037
038        /**
039         * Initializes with routing appender
040         *
041         * @param routingAppender
042         */
043        void initialize(RoutingAppender routingAppender);
044
045}