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.routing;
18  
19  import org.apache.logging.log4j.core.LogEvent;
20  
21  /**
22   * Policy for purging routed appenders
23   */
24  public interface PurgePolicy {
25  
26  	/**
27  	 * Activates purging appenders. Note that {@link PurgePolicy} implementations are responsible for invoking
28  	 * this method themselves.
29  	 */
30  	void purge();
31  
32  	/**
33  	 * @param key routed appender key
34  	 * @param event
35  	 */
36  	void update(String key, LogEvent event);
37  
38  	/**
39  	 * Initializes with routing appender
40  	 *
41  	 * @param routingAppender
42  	 */
43  	void initialize(RoutingAppender routingAppender);
44  
45  }