org.apache.logging.log4j.core.appender.routing.PurgePolicy Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache license, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the license for the specific language governing permissions and
 * limitations under the license.
 */
package org.apache.logging.log4j.core.appender.routing;

import org.apache.logging.log4j.core.LogEvent;

/**
 * Policy for purging routed appenders
 */
public interface PurgePolicy {

	/**
	 * Activates purging appenders. Note that {@link PurgePolicy} implementations are responsible for invoking
	 * this method themselves.
	 */
	void purge();

	/**
	 * @param key routed appender key
	 * @param event
	 */
	void update(String key, LogEvent event);

	/**
	 * Initializes with routing appender
	 *
	 * @param routingAppender
	 */
	void initialize(RoutingAppender routingAppender);

}