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 */ 017 018package org.apache.logging.log4j.core.config; 019 020import org.apache.logging.log4j.Level; 021import org.apache.logging.log4j.Marker; 022import org.apache.logging.log4j.core.LogEvent; 023import org.apache.logging.log4j.message.Message; 024import org.apache.logging.log4j.util.Supplier; 025 026/** 027 * Interface for objects that know how to ensure delivery of log events to the appropriate appenders, even during and 028 * after the configuration has been modified while the system is actively used. 029 */ 030public interface ReliabilityStrategy { 031 032 /** 033 * Logs an event. 034 * 035 * @param loggerName The name of the Logger. 036 * @param fqcn The fully qualified class name of the caller. 037 * @param marker A Marker or null if none is present. 038 * @param level The event Level. 039 * @param data The Message. 040 * @param t A Throwable or null. 041 */ 042 void log(Supplier<LoggerConfig> reconfigured, String loggerName, String fqcn, Marker marker, 043 Level level, Message data, Throwable t); 044 045 /** 046 * Logs an event. 047 * 048 * @param event The log event. 049 */ 050 void log(Supplier<LoggerConfig> reconfigured, LogEvent event); 051 052 /** 053 * For internal use by the ReliabilityStrategy; returns the LoggerConfig to use. 054 * @param next 055 * @return 056 */ 057 LoggerConfig getActiveLoggerConfig(Supplier<LoggerConfig> next); 058 059 /** 060 * Called after a log event was logged. 061 */ 062 void afterLogEvent(); 063 064 /** 065 * Called before all appenders are stopped. 066 */ 067 void beforeStopAppenders(); 068 069 /** 070 * Called before the configuration is stopped. 071 * 072 * @param configuration 073 */ 074 void beforeStopConfiguration(Configuration configuration); 075 076}