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  
18  package org.apache.logging.log4j.core.config;
19  
20  import org.apache.logging.log4j.Level;
21  import org.apache.logging.log4j.Marker;
22  import org.apache.logging.log4j.core.LogEvent;
23  import org.apache.logging.log4j.message.Message;
24  import org.apache.logging.log4j.util.Supplier;
25  
26  /**
27   * Interface for objects that know how to ensure delivery of log events to the appropriate appenders, even during and
28   * after the configuration has been modified while the system is actively used.
29   */
30  public interface ReliabilityStrategy {
31  
32      /**
33       * Logs an event.
34       *
35       * @param loggerName The name of the Logger.
36       * @param fqcn The fully qualified class name of the caller.
37       * @param marker A Marker or null if none is present.
38       * @param level The event Level.
39       * @param data The Message.
40       * @param t A Throwable or null.
41       */
42      void log(Supplier<LoggerConfig> reconfigured, String loggerName, String fqcn, Marker marker,
43              Level level, Message data, Throwable t);
44  
45      /**
46       * Logs an event.
47       *
48       * @param event The log event.
49       */
50      void log(Supplier<LoggerConfig> reconfigured, LogEvent event);
51  
52      /**
53       * For internal use by the ReliabilityStrategy; returns the LoggerConfig to use.
54       * @param next
55       * @return
56       */
57      LoggerConfig getActiveLoggerConfig(Supplier<LoggerConfig> next);
58  
59      /**
60       * Called after a log event was logged.
61       */
62      void afterLogEvent();
63      
64      /**
65       * Called before all appenders are stopped.
66       */
67      void beforeStopAppenders();
68  
69      /**
70       * Called before the configuration is stopped.
71       * 
72       * @param configuration
73       */
74      void beforeStopConfiguration(Configuration configuration);
75  
76  }