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