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