1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.apache.logging.log4j.core.appender;
19
20 import java.io.Serializable;
21
22 import org.apache.logging.log4j.core.Appender;
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.DefaultConfiguration;
28 import org.apache.logging.log4j.core.config.plugins.Plugin;
29 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
30 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
31 import org.apache.logging.log4j.core.config.plugins.PluginElement;
32 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
33 import org.apache.logging.log4j.core.filter.ThresholdFilter;
34 import org.apache.logging.log4j.core.layout.HtmlLayout;
35 import org.apache.logging.log4j.core.net.SmtpManager;
36 import org.apache.logging.log4j.core.util.Booleans;
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56 @Plugin(name = "SMTP", category = "Core", elementType = Appender.ELEMENT_TYPE, printObject = true)
57 public final class SmtpAppender extends AbstractAppender {
58
59 private static final int DEFAULT_BUFFER_SIZE = 512;
60
61
62 private final SmtpManager manager;
63
64 private SmtpAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout, final SmtpManager manager,
65 final boolean ignoreExceptions) {
66 super(name, filter, layout, ignoreExceptions);
67 this.manager = manager;
68 }
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109 @PluginFactory
110 public static SmtpAppender createAppender(
111 @PluginConfiguration final Configuration config,
112 @PluginAttribute("name") final String name,
113 @PluginAttribute("to") final String to,
114 @PluginAttribute("cc") final String cc,
115 @PluginAttribute("bcc") final String bcc,
116 @PluginAttribute("from") final String from,
117 @PluginAttribute("replyTo") final String replyTo,
118 @PluginAttribute("subject") final String subject,
119 @PluginAttribute("smtpProtocol") final String smtpProtocol,
120 @PluginAttribute("smtpHost") final String smtpHost,
121 @PluginAttribute("smtpPort") final String smtpPortStr,
122 @PluginAttribute("smtpUsername") final String smtpUsername,
123 @PluginAttribute("smtpPassword") final String smtpPassword,
124 @PluginAttribute("smtpDebug") final String smtpDebug,
125 @PluginAttribute("bufferSize") final String bufferSizeStr,
126 @PluginElement("Layout") Layout<? extends Serializable> layout,
127 @PluginElement("Filter") Filter filter,
128 @PluginAttribute("ignoreExceptions") final String ignore) {
129 if (name == null) {
130 LOGGER.error("No name provided for SmtpAppender");
131 return null;
132 }
133
134 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
135 final int smtpPort = AbstractAppender.parseInt(smtpPortStr, 0);
136 final boolean isSmtpDebug = Boolean.parseBoolean(smtpDebug);
137 final int bufferSize = bufferSizeStr == null ? DEFAULT_BUFFER_SIZE : Integer.parseInt(bufferSizeStr);
138
139 if (layout == null) {
140 layout = HtmlLayout.createDefaultLayout();
141 }
142 if (filter == null) {
143 filter = ThresholdFilter.createFilter(null, null, null);
144 }
145 final Configuration configuration = config != null ? config : new DefaultConfiguration();
146
147 final SmtpManager manager = SmtpManager.getSmtpManager(configuration, to, cc, bcc, from, replyTo, subject, smtpProtocol,
148 smtpHost, smtpPort, smtpUsername, smtpPassword, isSmtpDebug, filter.toString(), bufferSize);
149 if (manager == null) {
150 return null;
151 }
152
153 return new SmtpAppender(name, filter, layout, manager, ignoreExceptions);
154 }
155
156
157
158
159
160
161 @Override
162 public boolean isFiltered(final LogEvent event) {
163 final boolean filtered = super.isFiltered(event);
164 if (filtered) {
165 manager.add(event);
166 }
167 return filtered;
168 }
169
170
171
172
173
174
175
176 @Override
177 public void append(final LogEvent event) {
178 manager.sendEvents(getLayout(), event);
179 }
180 }