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 package org.apache.logging.log4j.core.appender; 018 019 import org.apache.logging.log4j.core.Filter; 020 import org.apache.logging.log4j.core.Layout; 021 import org.apache.logging.log4j.core.LogEvent; 022 import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy; 023 import org.apache.logging.log4j.core.appender.rolling.RollingFileManager; 024 import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy; 025 import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy; 026 import org.apache.logging.log4j.core.config.Configuration; 027 import org.apache.logging.log4j.core.config.plugins.Plugin; 028 import org.apache.logging.log4j.core.config.plugins.PluginAttr; 029 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration; 030 import org.apache.logging.log4j.core.config.plugins.PluginElement; 031 import org.apache.logging.log4j.core.config.plugins.PluginFactory; 032 import org.apache.logging.log4j.core.layout.PatternLayout; 033 034 /** 035 * An appender that writes to files andd can roll over at intervals. 036 */ 037 @Plugin(name = "RollingFile", type = "Core", elementType = "appender", printObject = true) 038 public final class RollingFileAppender extends AbstractOutputStreamAppender { 039 040 private final String fileName; 041 private final String filePattern; 042 private final TriggeringPolicy policy; 043 private final RolloverStrategy strategy; 044 045 private RollingFileAppender(String name, Layout layout, TriggeringPolicy policy, RolloverStrategy strategy, 046 Filter filter, RollingFileManager manager, String fileName, String filePattern, 047 boolean handleException, boolean immediateFlush) { 048 super(name, layout, filter, handleException, immediateFlush, manager); 049 this.fileName = fileName; 050 this.filePattern = filePattern; 051 this.policy = policy; 052 this.strategy = strategy; 053 policy.initialize(manager); 054 } 055 056 /** 057 * Write the log entry rolling over the file when required. 058 059 * @param event The LogEvent. 060 */ 061 @Override 062 public void append(LogEvent event) { 063 ((RollingFileManager) getManager()).checkRollover(event, policy, strategy); 064 super.append(event); 065 } 066 067 /** 068 * Returns the File name for the Appender. 069 * @return The file name. 070 */ 071 public String getFileName() { 072 return fileName; 073 } 074 075 /** 076 * Returns the file pattern used when rolling over. 077 * @return The file pattern. 078 */ 079 public String getFilePattern() { 080 return filePattern; 081 } 082 083 /** 084 * Create a RollingFileAppender. 085 * @param fileName The name of the file that is actively written to. (required). 086 * @param filePattern The pattern of the file name to use on rollover. (required). 087 * @param append If true, events are appended to the file. If false, the file 088 * is overwritten when opened. Defaults to "true" 089 * @param name The name of the Appender (required). 090 * @param bufferedIO When true, I/O will be buffered. Defaults to "true". 091 * @param immediateFlush When true, events are immediately flushed. Defaults to "true". 092 * @param policy The triggering policy. (required). 093 * @param strategy The rollover strategy. Defaults to DefaultRolloverStrategy. 094 * @param layout The layout to use (defaults to the default PatternLayout). 095 * @param filter The Filter or null. 096 * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise. 097 * The default is "true". 098 * @param config The Configuration. 099 * @return A RollingFileAppender. 100 */ 101 @PluginFactory 102 public static RollingFileAppender createAppender(@PluginAttr("fileName") String fileName, 103 @PluginAttr("filePattern") String filePattern, 104 @PluginAttr("append") String append, 105 @PluginAttr("name") String name, 106 @PluginAttr("bufferedIO") String bufferedIO, 107 @PluginAttr("immediateFlush") String immediateFlush, 108 @PluginElement("policy") TriggeringPolicy policy, 109 @PluginElement("strategy") RolloverStrategy strategy, 110 @PluginElement("layout") Layout layout, 111 @PluginElement("filter") Filter filter, 112 @PluginAttr("suppressExceptions") String suppress, 113 @PluginConfiguration Configuration config) { 114 115 boolean isAppend = append == null ? true : Boolean.valueOf(append); 116 boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress); 117 boolean isBuffered = bufferedIO == null ? true : Boolean.valueOf(bufferedIO); 118 boolean isFlush = immediateFlush == null ? true : Boolean.valueOf(immediateFlush); 119 120 if (name == null) { 121 LOGGER.error("No name provided for FileAppender"); 122 return null; 123 } 124 125 if (fileName == null) { 126 LOGGER.error("No filename was provided for FileAppender with name " + name); 127 return null; 128 } 129 130 if (filePattern == null) { 131 LOGGER.error("No filename pattern provided for FileAppender with name " + name); 132 return null; 133 } 134 135 if (policy == null) { 136 LOGGER.error("A TriggeringPolicy must be provided"); 137 return null; 138 } 139 140 if (strategy == null) { 141 strategy = DefaultRolloverStrategy.createStrategy(null, null, config); 142 } 143 144 RollingFileManager manager = RollingFileManager.getFileManager(fileName, filePattern, isAppend, isBuffered); 145 if (manager == null) { 146 return null; 147 } 148 149 if (layout == null) { 150 layout = PatternLayout.createLayout(null, null, null, null); 151 } 152 153 return new RollingFileAppender(name, layout, policy, strategy, filter, manager, fileName, filePattern, 154 handleExceptions, isFlush); 155 } 156 }