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.RollingRandomAccessFileManager;
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
46 @Plugin(name = "RollingRandomAccessFile", category = "Core", elementType = "appender", printObject = true)
47 public final class RollingRandomAccessFileAppender extends AbstractOutputStreamAppender<RollingRandomAccessFileManager> {
48
49 private final String fileName;
50 private final String filePattern;
51 private final Object advertisement;
52 private final Advertiser advertiser;
53
54 private RollingRandomAccessFileAppender(final String name, final Layout<? extends Serializable> layout,
55 final Filter filter, final RollingRandomAccessFileManager manager, final String fileName,
56 final String filePattern, final boolean ignoreExceptions,
57 final boolean immediateFlush, final int bufferSize, 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 } else {
65 advertisement = null;
66 }
67 this.fileName = fileName;
68 this.filePattern = filePattern;
69 this.advertiser = advertiser;
70 }
71
72 @Override
73 public void stop() {
74 super.stop();
75 if (advertiser != null) {
76 advertiser.unadvertise(advertisement);
77 }
78 }
79
80
81
82
83
84
85 @Override
86 public void append(final LogEvent event) {
87 final RollingRandomAccessFileManager manager = getManager();
88 manager.checkRollover(event);
89
90
91
92
93
94
95
96 manager.setEndOfBatch(event.isEndOfBatch());
97
98
99 super.append(event);
100 }
101
102
103
104
105
106
107 public String getFileName() {
108 return fileName;
109 }
110
111
112
113
114
115
116 public String getFilePattern() {
117 return filePattern;
118 }
119
120
121
122
123
124 public int getBufferSize() {
125 return getManager().getBufferSize();
126 }
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155 @PluginFactory
156 public static RollingRandomAccessFileAppender createAppender(
157 @PluginAttribute("fileName") final String fileName,
158 @PluginAttribute("filePattern") final String filePattern,
159 @PluginAttribute("append") final String append,
160 @PluginAttribute("name") final String name,
161 @PluginAttribute("immediateFlush") final String immediateFlush,
162 @PluginAttribute("bufferSize") final String bufferSizeStr,
163 @PluginElement("Policy") final TriggeringPolicy policy,
164 @PluginElement("Strategy") RolloverStrategy strategy,
165 @PluginElement("Layout") Layout<? extends Serializable> layout,
166 @PluginElement("Filter") final Filter filter,
167 @PluginAttribute("ignoreExceptions") final String ignore,
168 @PluginAttribute("advertise") final String advertise,
169 @PluginAttribute("advertiseURI") final String advertiseURI,
170 @PluginConfiguration final Configuration config) {
171
172 final boolean isAppend = Booleans.parseBoolean(append, true);
173 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
174 final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
175 final boolean isAdvertise = Boolean.parseBoolean(advertise);
176 final int bufferSize = Integers.parseInt(bufferSizeStr, RollingRandomAccessFileManager.DEFAULT_BUFFER_SIZE);
177
178 if (name == null) {
179 LOGGER.error("No name provided for FileAppender");
180 return null;
181 }
182
183 if (fileName == null) {
184 LOGGER.error("No filename was provided for FileAppender with name " + name);
185 return null;
186 }
187
188 if (filePattern == null) {
189 LOGGER.error("No filename pattern provided for FileAppender with name " + name);
190 return null;
191 }
192
193 if (policy == null) {
194 LOGGER.error("A TriggeringPolicy must be provided");
195 return null;
196 }
197
198 if (strategy == null) {
199 strategy = DefaultRolloverStrategy.createStrategy(null, null, null,
200 String.valueOf(Deflater.DEFAULT_COMPRESSION), null, true, config);
201 }
202
203 if (layout == null) {
204 layout = PatternLayout.createDefaultLayout();
205 }
206
207 final RollingRandomAccessFileManager manager = RollingRandomAccessFileManager.getRollingRandomAccessFileManager(
208 fileName, filePattern, isAppend, isFlush, bufferSize, policy, strategy, advertiseURI, layout);
209 if (manager == null) {
210 return null;
211 }
212
213 manager.initialize();
214
215 return new RollingRandomAccessFileAppender(name, layout, filter, manager,
216 fileName, filePattern, ignoreExceptions, isFlush, bufferSize,
217 isAdvertise ? config.getAdvertiser() : null);
218 }
219 }