it.openutils.log4j2

Class ExtendedSmtpManager

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

it.openutils.log4j2.ExtendedSmtpManager

All Implemented Interfaces:

AutoCloseable

public class ExtendedSmtpManager
extends org.apache.logging.log4j.core.appender.AbstractManager

see https://issues.apache.org/jira/browse/LOG4J2-1192 Like standard org.apache.logging.log4j.core.appender.SmtpManager but with some additional features (subject with layout, burst summarizing). This class is bases on copy&paste of original code because SmtpManager contains a lot of private stuff which needs slight changes.

Author:

Thies Wellpott

See Also:

ExtendedSmtpAppender

Field Summary

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager

count, LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExtendedSmtpManager(String name, javax.mail.Session session, javax.mail.internet.MimeMessage message, it.openutils.log4j2.ExtendedSmtpManager.FactoryData data) Create instance.

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.logging.log4j.core.LogEvent event) Add event to internal buffer.
protected void	addMimeMultipart(javax.mail.internet.MimeMultipart mp, byte[] rawBytes, String contentType)
protected void	encodeContent(byte[] bytes, String encoding, ByteArrayOutputStream out)
protected byte[]	encodeContentToBytes(byte[] rawBytes, String encoding)
protected byte[]	formatContentToBytes(org.apache.logging.log4j.core.LogEvent[] priorEvents, org.apache.logging.log4j.core.LogEvent appendEvent, org.apache.logging.log4j.core.Layout<?> layout)
protected String	getEncoding(byte[] rawBytes, String contentType)
protected javax.mail.internet.InternetHeaders	getHeaders(String contentType, String encoding)
protected javax.mail.internet.MimeMultipart	getMimeMultipart(byte[] encodedBytes, javax.mail.internet.InternetHeaders headers)
static ExtendedSmtpManager	getSMTPManager(it.openutils.log4j2.ExtendedSmtpManager.FactoryData data, String filterName, String contentType) Factory method: get existing or create a new manager for SMTP messages.
protected boolean	releaseSub(long timeout, TimeUnit timeUnit) "Close" the manager: stop the background thread and wait for its end (typically is very fast).
void	sendEvents(org.apache.logging.log4j.core.Layout<?> layout, org.apache.logging.log4j.core.LogEvent appendEvent) Send the contents of the cyclic buffer as an e-mail message.
protected void	sendMultipartMessage(javax.mail.internet.MimeMessage msg, String subject, javax.mail.internet.MimeMultipart mp) Send the email message.
void	sendSummary(it.openutils.log4j2.ExtendedSmtpManager.SummarizeData sumData) Send summary email.
protected void	writeBuffer(org.apache.logging.log4j.core.LogEvent[] priorEvents, org.apache.logging.log4j.core.LogEvent appendEvent, org.apache.logging.log4j.core.Layout<?> layout, OutputStream out)
protected void	writeFooter(org.apache.logging.log4j.core.Layout<?> layout, OutputStream out)
protected void	writeHeader(org.apache.logging.log4j.core.Layout<?> layout, OutputStream out)

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager

close, getContentFormat, getCount, getLoggerContext, getManager, getName, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendedSmtpManager

protected ExtendedSmtpManager(String name,
                              javax.mail.Session session,
                              javax.mail.internet.MimeMessage message,
                              it.openutils.log4j2.ExtendedSmtpManager.FactoryData data)

Create instance. Internal use, for public creation use getSMTPManager()

Method Detail

getSMTPManager

public static ExtendedSmtpManager getSMTPManager(it.openutils.log4j2.ExtendedSmtpManager.FactoryData data,
                                                 String filterName,
                                                 String contentType)

Factory method: get existing or create a new manager for SMTP messages.

Parameters:

data - parameter data

contentType - MIME content type of the layout, e.g. "text/plain" or "text/html". May be null.

releaseSub

protected boolean releaseSub(long timeout,
                             TimeUnit timeUnit)

"Close" the manager: stop the background thread and wait for its end (typically is very fast).

Overrides:

releaseSub in class org.apache.logging.log4j.core.appender.AbstractManager

add

public void add(org.apache.logging.log4j.core.LogEvent event)

Add event to internal buffer.

sendEvents

public void sendEvents(org.apache.logging.log4j.core.Layout<?> layout,
                       org.apache.logging.log4j.core.LogEvent appendEvent)

Send the contents of the cyclic buffer as an e-mail message.

Parameters:

layout - The layout for formatting the events.

appendEvent - The event that triggered the send.

formatContentToBytes

protected byte[] formatContentToBytes(org.apache.logging.log4j.core.LogEvent[] priorEvents,
                                      org.apache.logging.log4j.core.LogEvent appendEvent,
                                      org.apache.logging.log4j.core.Layout<?> layout)
                               throws IOException

Throws:

IOException

writeHeader

protected void writeHeader(org.apache.logging.log4j.core.Layout<?> layout,
                           OutputStream out)
                    throws IOException

Throws:

IOException

writeBuffer

protected void writeBuffer(org.apache.logging.log4j.core.LogEvent[] priorEvents,
                           org.apache.logging.log4j.core.LogEvent appendEvent,
                           org.apache.logging.log4j.core.Layout<?> layout,
                           OutputStream out)
                    throws IOException

Throws:

IOException

writeFooter

protected void writeFooter(org.apache.logging.log4j.core.Layout<?> layout,
                           OutputStream out)
                    throws IOException

Throws:

IOException

getEncoding

protected String getEncoding(byte[] rawBytes,
                             String contentType)

encodeContentToBytes

protected byte[] encodeContentToBytes(byte[] rawBytes,
                                      String encoding)
                               throws javax.mail.MessagingException,
                                      IOException

Throws:

javax.mail.MessagingException

IOException

encodeContent

protected void encodeContent(byte[] bytes,
                             String encoding,
                             ByteArrayOutputStream out)
                      throws javax.mail.MessagingException,
                             IOException

Throws:

javax.mail.MessagingException

IOException

getHeaders

protected javax.mail.internet.InternetHeaders getHeaders(String contentType,
                                                         String encoding)

getMimeMultipart

protected javax.mail.internet.MimeMultipart getMimeMultipart(byte[] encodedBytes,
                                                             javax.mail.internet.InternetHeaders headers)
                                                      throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

addMimeMultipart

protected void addMimeMultipart(javax.mail.internet.MimeMultipart mp,
                                byte[] rawBytes,
                                String contentType)
                         throws javax.mail.MessagingException,
                                IOException

Throws:

javax.mail.MessagingException

IOException

sendMultipartMessage

protected void sendMultipartMessage(javax.mail.internet.MimeMessage msg,
                                    String subject,
                                    javax.mail.internet.MimeMultipart mp)
                             throws javax.mail.MessagingException

Send the email message. Set subject if not null.

Throws:

javax.mail.MessagingException

sendSummary

public void sendSummary(it.openutils.log4j2.ExtendedSmtpManager.SummarizeData sumData)

Send summary email.