public class SMTPAppender
extends org.apache.log4j.AppenderSkeleton
implements org.apache.log4j.xml.UnrecognizedElementHandler
The number of logging events delivered in this e-mail depend on
the value of BufferSize option. The
SMTPAppender
keeps only the last
BufferSize
logging events in its cyclic buffer. This
keeps memory requirements at a reasonable level while still
delivering useful application context.
By default, an email message will be sent when an ERROR or higher
severity message is appended. The triggering criteria can be
modified by setting the evaluatorClass property with the name
of a class implementing TriggeringEventEvaluator, setting the evaluator
property with an instance of TriggeringEventEvaluator or
nesting a triggeringPolicy element where the specified
class implements TriggeringEventEvaluator.
This class has implemented UnrecognizedElementHandler since 1.2.15.
Since 1.2.16, SMTP over SSL is supported by setting SMTPProtocol to "smpts".
Modifier and Type | Field and Description |
---|---|
protected org.apache.log4j.helpers.CyclicBuffer |
cb |
protected org.apache.log4j.spi.TriggeringEventEvaluator |
evaluator |
protected javax.mail.Message |
msg |
Constructor and Description |
---|
SMTPAppender()
The default constructor will instantiate the appender with a
TriggeringEventEvaluator that will trigger on events with
level ERROR or higher. |
SMTPAppender(org.apache.log4j.spi.TriggeringEventEvaluator evaluator)
Use
evaluator passed as parameter as the TriggeringEventEvaluator for this SMTPAppender. |
Modifier and Type | Method and Description |
---|---|
void |
activateOptions()
Activate the specified options, such as the smtp host, the
recipient, from, etc.
|
protected void |
addressMessage(javax.mail.Message msg)
Address message.
|
void |
append(LoggingEvent event)
Perform SMTPAppender specific appending actions, mainly adding
the event to a cyclic buffer and checking if the event triggers
an e-mail to be sent.
|
protected boolean |
checkEntryConditions()
This method determines if there is a sense in attempting to append.
|
void |
close() |
protected javax.mail.Session |
createSession()
Create mail session.
|
protected String |
formatBody()
Layout body of email message.
|
String |
getBcc()
Get the bcc recipient addresses.
|
int |
getBufferSize()
Returns value of the BufferSize option.
|
String |
getCc()
Get the cc recipient addresses.
|
org.apache.log4j.spi.TriggeringEventEvaluator |
getEvaluator()
Get triggering evaluator.
|
String |
getEvaluatorClass()
Returns value of the EvaluatorClass option.
|
String |
getFrom()
Returns value of the From option.
|
boolean |
getLocationInfo()
Returns value of the LocationInfo option.
|
String |
getReplyTo()
Get the reply addresses.
|
boolean |
getSendOnClose()
Get sendOnClose.
|
boolean |
getSMTPDebug()
Get SMTP debug.
|
String |
getSMTPHost()
Returns value of the SMTPHost option.
|
String |
getSMTPPassword()
Get SMTP password.
|
int |
getSMTPPort()
Get port.
|
String |
getSMTPProtocol()
Get transport protocol.
|
String |
getSMTPUsername()
Get SMTP user name.
|
String |
getSubject()
Returns value of the Subject option.
|
String |
getTo()
Returns value of the To option.
|
boolean |
parseUnrecognizedElement(Element element,
Properties props) |
boolean |
requiresLayout()
The
SMTPAppender requires a layout . |
protected void |
sendBuffer()
Send the contents of the cyclic buffer as an e-mail message.
|
void |
setBcc(String addresses)
Set the bcc recipient addresses.
|
void |
setBufferSize(int bufferSize)
The BufferSize option takes a positive integer
representing the maximum number of logging events to collect in a
cyclic buffer.
|
void |
setCc(String addresses)
Set the cc recipient addresses.
|
void |
setEvaluator(org.apache.log4j.spi.TriggeringEventEvaluator trigger)
Sets triggering evaluator.
|
void |
setEvaluatorClass(String value)
The EvaluatorClass option takes a string value
representing the name of the class implementing the
TriggeringEventEvaluator interface. |
void |
setFrom(String from)
The From option takes a string value which should be a
e-mail address of the sender.
|
void |
setLocationInfo(boolean locationInfo)
The LocationInfo option takes a boolean value.
|
void |
setReplyTo(String addresses)
Set the e-mail addresses to which replies should be directed.
|
void |
setSendOnClose(boolean val)
Set sendOnClose.
|
void |
setSMTPDebug(boolean debug)
Setting the SmtpDebug option to true will cause the mail session to log its server interaction to stdout.
|
void |
setSMTPHost(String smtpHost)
The SMTPHost option takes a string value which should be a
the host name of the SMTP server that will send the e-mail message.
|
void |
setSMTPPassword(String password)
The SmtpPassword option takes a string value which should be the password required to authenticate against
the mail server.
|
void |
setSMTPPort(int val)
Set port.
|
void |
setSMTPProtocol(String val)
Set transport protocol.
|
void |
setSMTPUsername(String username)
The SmtpUsername option takes a string value which should be the username required to authenticate against
the mail server.
|
void |
setSubject(String subject)
The Subject option takes a string value which should be a
the subject of the e-mail message.
|
void |
setTo(String to)
The To option takes a string value which should be a
comma separated list of e-mail address of the recipients.
|
protected javax.mail.Message msg
protected org.apache.log4j.spi.TriggeringEventEvaluator evaluator
protected org.apache.log4j.helpers.CyclicBuffer cb
public SMTPAppender()
TriggeringEventEvaluator
that will trigger on events with
level ERROR or higher.public SMTPAppender(org.apache.log4j.spi.TriggeringEventEvaluator evaluator)
evaluator
passed as parameter as the TriggeringEventEvaluator
for this SMTPAppender.public void activateOptions()
activateOptions
in interface org.apache.log4j.spi.OptionHandler
activateOptions
in class org.apache.log4j.AppenderSkeleton
public void append(LoggingEvent event)
append
in class org.apache.log4j.AppenderSkeleton
protected void addressMessage(javax.mail.Message msg) throws javax.mail.MessagingException
msg
- message, may not be null.javax.mail.MessagingException
- thrown if error addressing message.protected javax.mail.Session createSession()
protected boolean checkEntryConditions()
It checks whether there is a set output target and also if
there is a set layout. If these checks fail, then the boolean
value false
is returned.
public void close()
close
in interface org.apache.log4j.Appender
public boolean requiresLayout()
SMTPAppender
requires a layout
.requiresLayout
in interface org.apache.log4j.Appender
public String getTo()
public void setTo(String to)
protected String formatBody()
protected void sendBuffer()
public String getEvaluatorClass()
public void setEvaluatorClass(String value)
TriggeringEventEvaluator
interface. A corresponding object will
be instantiated and assigned as the triggering event evaluator
for the SMTPAppender.public String getFrom()
public void setFrom(String from)
public String getReplyTo()
public void setReplyTo(String addresses)
addresses
- reply addresses as comma separated string, may be null.public String getSubject()
public void setSubject(String subject)
public String getSMTPHost()
public void setSMTPHost(String smtpHost)
public int getBufferSize()
public void setBufferSize(int bufferSize)
BufferSize
is reached,
oldest events are deleted as new events are added to the
buffer. By default the size of the cyclic buffer is 512 events.public boolean getLocationInfo()
public void setLocationInfo(boolean locationInfo)
Location information extraction is comparatively very slow and should be avoided unless performance is not a concern.
public String getCc()
public void setCc(String addresses)
addresses
- recipient addresses as comma separated string, may be null.public String getBcc()
public void setBcc(String addresses)
addresses
- recipient addresses as comma separated string, may be null.public String getSMTPPassword()
public void setSMTPPassword(String password)
password
- password, may be null.public String getSMTPUsername()
public void setSMTPUsername(String username)
username
- user name, may be null.public boolean getSMTPDebug()
public void setSMTPDebug(boolean debug)
debug
- debug flag.public final org.apache.log4j.spi.TriggeringEventEvaluator getEvaluator()
public final void setEvaluator(org.apache.log4j.spi.TriggeringEventEvaluator trigger)
trigger
- triggering event evaluator.public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
parseUnrecognizedElement
in interface org.apache.log4j.xml.UnrecognizedElementHandler
Exception
public final String getSMTPProtocol()
public final void setSMTPProtocol(String val)
val
- transport protocol, may be null.public final int getSMTPPort()
public final void setSMTPPort(int val)
val
- port, negative values indicate use of default ports for protocol.public final boolean getSendOnClose()
public final void setSendOnClose(boolean val)
val
- if true all buffered logging events will be sent when appender is closed.Copyright © 2022 JBoss by Red Hat. All rights reserved.