1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.appender;
18
19 import java.io.Serializable;
20 import java.util.HashMap;
21 import java.util.Map;
22 import java.util.zip.Deflater;
23
24 import org.apache.logging.log4j.core.Filter;
25 import org.apache.logging.log4j.core.Layout;
26 import org.apache.logging.log4j.core.LogEvent;
27 import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;
28 import org.apache.logging.log4j.core.appender.rolling.RollingFileManager;
29 import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy;
30 import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy;
31 import org.apache.logging.log4j.core.config.Configuration;
32 import org.apache.logging.log4j.core.config.plugins.Plugin;
33 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
34 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
35 import org.apache.logging.log4j.core.config.plugins.PluginElement;
36 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
37 import org.apache.logging.log4j.core.layout.PatternLayout;
38 import org.apache.logging.log4j.core.net.Advertiser;
39 import org.apache.logging.log4j.core.util.Booleans;
40 import org.apache.logging.log4j.core.util.Integers;
41
42
43
44
45 @Plugin(name = "RollingFile", category = "Core", elementType = "appender", printObject = true)
46 public final class RollingFileAppender extends AbstractOutputStreamAppender<RollingFileManager> {
47
48 private static final int DEFAULT_BUFFER_SIZE = 8192;
49
50 private final String fileName;
51 private final String filePattern;
52 private Object advertisement;
53 private final Advertiser advertiser;
54
55 private RollingFileAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
56 final RollingFileManager manager, final String fileName, final String filePattern,
57 final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser) {
58 super(name, layout, filter, ignoreExceptions, immediateFlush, manager);
59 if (advertiser != null) {
60 final Map<String, String> configuration = new HashMap<>(layout.getContentFormat());
61 configuration.put("contentType", layout.getContentType());
62 configuration.put("name", name);
63 advertisement = advertiser.advertise(configuration);
64 }
65 this.fileName = fileName;
66 this.filePattern = filePattern;
67 this.advertiser = advertiser;
68 }
69
70 @Override
71 public void stop() {
72 super.stop();
73 if (advertiser != null) {
74 advertiser.unadvertise(advertisement);
75 }
76 }
77
78
79
80
81
82
83 @Override
84 public void append(final LogEvent event) {
85 getManager().checkRollover(event);
86 super.append(event);
87 }
88
89
90
91
92
93 public String getFileName() {
94 return fileName;
95 }
96
97
98
99
100
101 public String getFilePattern() {
102 return filePattern;
103 }
104
105
106
107
108
109
110 public <T extends TriggeringPolicy> T getTriggeringPolicy() {
111 return getManager().getTriggeringPolicy();
112 }
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135 @PluginFactory
136 public static RollingFileAppender createAppender(
137 @PluginAttribute("fileName") final String fileName,
138 @PluginAttribute("filePattern") final String filePattern,
139 @PluginAttribute("append") final String append,
140 @PluginAttribute("name") final String name,
141 @PluginAttribute("bufferedIO") final String bufferedIO,
142 @PluginAttribute("bufferSize") final String bufferSizeStr,
143 @PluginAttribute("immediateFlush") final String immediateFlush,
144 @PluginElement("Policy") final TriggeringPolicy policy,
145 @PluginElement("Strategy") RolloverStrategy strategy,
146 @PluginElement("Layout") Layout<? extends Serializable> layout,
147 @PluginElement("Filter") final Filter filter,
148 @PluginAttribute("ignoreExceptions") final String ignore,
149 @PluginAttribute("advertise") final String advertise,
150 @PluginAttribute("advertiseURI") final String advertiseURI,
151 @PluginConfiguration final Configuration config) {
152
153 final boolean isAppend = Booleans.parseBoolean(append, true);
154 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
155 final boolean isBuffered = Booleans.parseBoolean(bufferedIO, true);
156 final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
157 final boolean isAdvertise = Boolean.parseBoolean(advertise);
158 final int bufferSize = Integers.parseInt(bufferSizeStr, DEFAULT_BUFFER_SIZE);
159 if (!isBuffered && bufferSize > 0) {
160 LOGGER.warn("The bufferSize is set to {} but bufferedIO is not true: {}", bufferSize, bufferedIO);
161 }
162 if (name == null) {
163 LOGGER.error("No name provided for FileAppender");
164 return null;
165 }
166
167 if (fileName == null) {
168 LOGGER.error("No filename was provided for FileAppender with name " + name);
169 return null;
170 }
171
172 if (filePattern == null) {
173 LOGGER.error("No filename pattern provided for FileAppender with name " + name);
174 return null;
175 }
176
177 if (policy == null) {
178 LOGGER.error("A TriggeringPolicy must be provided");
179 return null;
180 }
181
182 if (strategy == null) {
183 strategy = DefaultRolloverStrategy.createStrategy(null, null, null,
184 String.valueOf(Deflater.DEFAULT_COMPRESSION), null, true, config);
185 }
186
187 if (layout == null) {
188 layout = PatternLayout.createDefaultLayout();
189 }
190
191 final RollingFileManager manager = RollingFileManager.getFileManager(fileName, filePattern, isAppend,
192 isBuffered, policy, strategy, advertiseURI, layout, bufferSize, isFlush);
193 if (manager == null) {
194 return null;
195 }
196
197 return new RollingFileAppender(name, layout, filter, manager, fileName, filePattern,
198 ignoreExceptions, isFlush, isAdvertise ? config.getAdvertiser() : null);
199 }
200 }