| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.appender;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.logging.log4j.core.Appender;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.Core;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Filter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Layout;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.DefaultConfiguration;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.Property;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.ValidPort;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.filter.ThresholdFilter;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.layout.HtmlLayout;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.net.SmtpManager;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.net.ssl.SslConfiguration;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import java.io.Serializable;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span>/**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Send an e-mail when a specific logging event occurs, typically on errors or<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * fatal errors.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * The number of logging events delivered in this e-mail depend on the value of<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <b>BufferSize</b> option. The <code>SmtpAppender</code> keeps only the last<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <code>BufferSize</code> logging events in its cyclic buffer. This keeps<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * memory requirements at a reasonable level while still delivering useful<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * application context.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * By default, an email message will formatted as HTML. This can be modified by<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * setting a layout for the appender.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * By default, an email message will be sent when an ERROR or higher severity<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * message is appended. This can be modified by setting a filter for the<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * appender.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>@Plugin(name = "SMTP", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>public final class SmtpAppender extends AbstractAppender {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final int DEFAULT_BUFFER_SIZE = 512;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /** The SMTP Manager */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private final SmtpManager manager;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private SmtpAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout,<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final SmtpManager manager, final boolean ignoreExceptions, final Property[] properties) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> super(name, filter, layout, ignoreExceptions, properties);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this.manager = manager;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @since 2.13.2<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public static class Builder extends AbstractAppender.Builder<Builder><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> implements org.apache.logging.log4j.core.util.Builder<SmtpAppender> {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> @PluginBuilderAttribute<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private String to;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> @PluginBuilderAttribute<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private String cc;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> @PluginBuilderAttribute<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private String bcc;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> @PluginBuilderAttribute<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private String from;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> @PluginBuilderAttribute<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private String replyTo;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @PluginBuilderAttribute<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> private String subject;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> @PluginBuilderAttribute<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> private String smtpProtocol = "smtp";<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @PluginBuilderAttribute<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> private String smtpHost;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> @PluginBuilderAttribute<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> @ValidPort<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> private int smtpPort;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> @PluginBuilderAttribute<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> private String smtpUsername;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @PluginBuilderAttribute(sensitive = true)<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> private String smtpPassword;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> @PluginBuilderAttribute<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> private boolean smtpDebug;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> @PluginBuilderAttribute<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> private int bufferSize = DEFAULT_BUFFER_SIZE;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> @PluginElement("SSL")<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> private SslConfiguration sslConfiguration;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Comma-separated list of recipient email addresses.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public Builder setTo(final String to) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> this.to = to;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return this;<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Comma-separated list of CC email addresses.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public Builder setCc(final String cc) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> this.cc = cc;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return this;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Comma-separated list of BCC email addresses.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public Builder setBcc(final String bcc) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> this.bcc = bcc;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return this;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> /**<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * Email address of the sender.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> public Builder setFrom(final String from) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> this.from = from;<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return this;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Comma-separated list of Reply-To email addresses.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public Builder setReplyTo(final String replyTo) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> this.replyTo = replyTo;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return this;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> /**<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * Subject template for the email messages.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @see org.apache.logging.log4j.core.layout.PatternLayout<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> public Builder setSubject(final String subject) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> this.subject = subject;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return this;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Transport protocol to use for SMTP such as "smtp" or "smtps". Defaults to "smtp".<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> */<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public Builder setSmtpProtocol(final String smtpProtocol) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> this.smtpProtocol = smtpProtocol;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return this;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Host name of SMTP server to send messages through.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public Builder setSmtpHost(final String smtpHost) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> this.smtpHost = smtpHost;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> return this;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Port number of SMTP server to send messages through.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> */<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public Builder setSmtpPort(final int smtpPort) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> this.smtpPort = smtpPort;<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return this;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> /**<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * Username to authenticate with SMTP server.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> public Builder setSmtpUsername(final String smtpUsername) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> this.smtpUsername = smtpUsername;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return this;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * Password to authenticate with SMTP server.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> */<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> public Builder setSmtpPassword(final String smtpPassword) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> this.smtpPassword = smtpPassword;<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return this;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> /**<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * Enables or disables mail session debugging on STDOUT. Disabled by default.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> public Builder setSmtpDebug(final boolean smtpDebug) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> this.smtpDebug = smtpDebug;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return this;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> /**<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * Number of log events to buffer before sending an email. Defaults to {@value #DEFAULT_BUFFER_SIZE}.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> */<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> public Builder setBufferSize(final int bufferSize) {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> this.bufferSize = bufferSize;<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return this;<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Specifies an SSL configuration for smtps connections.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> */<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> public Builder setSslConfiguration(final SslConfiguration sslConfiguration) {<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> this.sslConfiguration = sslConfiguration;<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return this;<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Specifies the layout used for the email message body. By default, this uses the<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * {@linkplain HtmlLayout#createDefaultLayout() default HTML layout}.<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> */<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> @Override<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> public Builder setLayout(final Layout<? extends Serializable> layout) {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> return super.setLayout(layout);<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> /**<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * Specifies the filter used for this appender. By default, uses a {@link ThresholdFilter} with a level of<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * ERROR.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> */<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> @Override<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public Builder setFilter(final Filter filter) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> return super.setFilter(filter);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> @Override<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> public SmtpAppender build() {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> if (getLayout() == null) {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> setLayout(HtmlLayout.createDefaultLayout());<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> if (getFilter() == null) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> setFilter(ThresholdFilter.createFilter(null, null, null));<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> final SmtpManager smtpManager = SmtpManager.getSmtpManager(getConfiguration(), to, cc, bcc, from, replyTo,<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> subject, smtpProtocol, smtpHost, smtpPort, smtpUsername, smtpPassword, smtpDebug,<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> getFilter().toString(), bufferSize, sslConfiguration);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> return new SmtpAppender(getName(), getFilter(), getLayout(), smtpManager, isIgnoreExceptions(), getPropertyArray());<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @since 2.13.2<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> */<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> @PluginBuilderFactory<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> public static Builder newBuilder() {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> return new Builder();<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> /**<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * Create a SmtpAppender.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * @deprecated Use {@link #newBuilder()} to create and configure a {@link Builder} instance.<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * @see Builder<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> */<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> public static SmtpAppender createAppender(<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> @PluginConfiguration final Configuration config,<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> @PluginAttribute("name") @Required final String name,<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> @PluginAttribute("to") final String to,<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> @PluginAttribute("cc") final String cc,<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> @PluginAttribute("bcc") final String bcc,<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> @PluginAttribute("from") final String from,<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> @PluginAttribute("replyTo") final String replyTo,<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> @PluginAttribute("subject") final String subject,<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> @PluginAttribute("smtpProtocol") final String smtpProtocol,<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> @PluginAttribute("smtpHost") final String smtpHost,<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> @PluginAttribute(value = "smtpPort", defaultString = "0") @ValidPort final String smtpPortStr,<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> @PluginAttribute("smtpUsername") final String smtpUsername,<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> @PluginAttribute(value = "smtpPassword", sensitive = true) final String smtpPassword,<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> @PluginAttribute("smtpDebug") final String smtpDebug,<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> @PluginAttribute("bufferSize") final String bufferSizeStr,<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> @PluginElement("Layout") Layout<? extends Serializable> layout,<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> @PluginElement("Filter") Filter filter,<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> @PluginAttribute("ignoreExceptions") final String ignore) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> if (name == null) {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> LOGGER.error("No name provided for SmtpAppender");<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> return null;<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> final int smtpPort = AbstractAppender.parseInt(smtpPortStr, 0);<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> final boolean isSmtpDebug = Boolean.parseBoolean(smtpDebug);<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> final int bufferSize = bufferSizeStr == null ? DEFAULT_BUFFER_SIZE : Integer.parseInt(bufferSizeStr);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> if (layout == null) {<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> layout = HtmlLayout.createDefaultLayout();<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> if (filter == null) {<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> filter = ThresholdFilter.createFilter(null, null, null);<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> final Configuration configuration = config != null ? config : new DefaultConfiguration();<a name="line.318"></a> |
| <span class="sourceLineNo">319</span><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> final SmtpManager manager = SmtpManager.getSmtpManager(configuration, to, cc, bcc, from, replyTo, subject, smtpProtocol,<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> smtpHost, smtpPort, smtpUsername, smtpPassword, isSmtpDebug, filter.toString(), bufferSize, null);<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> if (manager == null) {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> return null;<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> }<a name="line.324"></a> |
| <span class="sourceLineNo">325</span><a name="line.325"></a> |
| <span class="sourceLineNo">326</span> return new SmtpAppender(name, filter, layout, manager, ignoreExceptions, null);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> /**<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * Capture all events in CyclicBuffer.<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * @param event The Log event.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * @return true if the event should be filtered.<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> */<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> @Override<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> public boolean isFiltered(final LogEvent event) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> final boolean filtered = super.isFiltered(event);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> if (filtered) {<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> manager.add(event);<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> return filtered;<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> }<a name="line.341"></a> |
| <span class="sourceLineNo">342</span><a name="line.342"></a> |
| <span class="sourceLineNo">343</span> /**<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * Perform SmtpAppender specific appending actions, mainly adding the event<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * to a cyclic buffer and checking if the event triggers an e-mail to be<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * sent.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @param event The Log event.<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> */<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> @Override<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> public void append(final LogEvent event) {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> manager.sendEvents(getLayout(), event);<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span>}<a name="line.353"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
