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
23 import org.apache.logging.log4j.core.Filter;
24 import org.apache.logging.log4j.core.Layout;
25 import org.apache.logging.log4j.core.LogEvent;
26 import org.apache.logging.log4j.core.config.Configuration;
27 import org.apache.logging.log4j.core.config.plugins.Plugin;
28 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
29 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
30 import org.apache.logging.log4j.core.config.plugins.PluginElement;
31 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
32 import org.apache.logging.log4j.core.layout.PatternLayout;
33 import org.apache.logging.log4j.core.net.Advertiser;
34 import org.apache.logging.log4j.core.util.Booleans;
35 import org.apache.logging.log4j.core.util.Integers;
36
37
38
39
40 @Plugin(name = "RandomAccessFile", category = "Core", elementType = "appender", printObject = true)
41 public final class RandomAccessFileAppender extends AbstractOutputStreamAppender<RandomAccessFileManager> {
42
43 private static final long serialVersionUID = 1L;
44
45 private final String fileName;
46 private Object advertisement;
47 private final Advertiser advertiser;
48
49 private RandomAccessFileAppender(final String name, final Layout<? extends Serializable> layout,
50 final Filter filter, final RandomAccessFileManager manager, final String filename,
51 final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser) {
52
53 super(name, layout, filter, ignoreExceptions, immediateFlush, manager);
54 if (advertiser != null) {
55 final Map<String, String> configuration = new HashMap<>(
56 layout.getContentFormat());
57 configuration.putAll(manager.getContentFormat());
58 configuration.put("contentType", layout.getContentType());
59 configuration.put("name", name);
60 advertisement = advertiser.advertise(configuration);
61 }
62 this.fileName = filename;
63 this.advertiser = advertiser;
64 }
65
66 @Override
67 public void stop() {
68 super.stop();
69 if (advertiser != null) {
70 advertiser.unadvertise(advertisement);
71 }
72 }
73
74
75
76
77
78
79 @Override
80 public void append(final LogEvent event) {
81
82
83
84
85
86
87
88 getManager().setEndOfBatch(event.isEndOfBatch());
89 super.append(event);
90 }
91
92
93
94
95
96
97 public String getFileName() {
98 return this.fileName;
99 }
100
101
102
103
104
105 public int getBufferSize() {
106 return getManager().getBufferSize();
107 }
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133 @PluginFactory
134 public static RandomAccessFileAppender createAppender(
135 @PluginAttribute("fileName") final String fileName,
136 @PluginAttribute("append") final String append,
137 @PluginAttribute("name") final String name,
138 @PluginAttribute("immediateFlush") final String immediateFlush,
139 @PluginAttribute("bufferSize") final String bufferSizeStr,
140 @PluginAttribute("ignoreExceptions") final String ignore,
141 @PluginElement("Layout") Layout<? extends Serializable> layout,
142 @PluginElement("Filter") final Filter filter,
143 @PluginAttribute("advertise") final String advertise,
144 @PluginAttribute("advertiseURI") final String advertiseURI,
145 @PluginConfiguration final Configuration config) {
146
147 final boolean isAppend = Booleans.parseBoolean(append, true);
148 final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
149 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
150 final boolean isAdvertise = Boolean.parseBoolean(advertise);
151 final int bufferSize = Integers.parseInt(bufferSizeStr, RandomAccessFileManager.DEFAULT_BUFFER_SIZE);
152
153 if (name == null) {
154 LOGGER.error("No name provided for FileAppender");
155 return null;
156 }
157
158 if (fileName == null) {
159 LOGGER.error("No filename provided for FileAppender with name "
160 + name);
161 return null;
162 }
163 if (layout == null) {
164 layout = PatternLayout.createDefaultLayout();
165 }
166 final RandomAccessFileManager manager = RandomAccessFileManager.getFileManager(
167 fileName, isAppend, isFlush, bufferSize, advertiseURI, layout
168 );
169 if (manager == null) {
170 return null;
171 }
172
173 return new RandomAccessFileAppender(
174 name, layout, filter, manager, fileName, ignoreExceptions, isFlush,
175 isAdvertise ? config.getAdvertiser() : null
176 );
177 }
178 }