Package org.apache.logging.log4j.core.net

Class SmtpManager

java.lang.Object

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

org.apache.logging.log4j.core.net.SmtpManager

All Implemented Interfaces:

java.lang.AutoCloseable

public class SmtpManager
extends AbstractManager

Manager for sending SMTP events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SmtpManager.FactoryData	Factory data.
private static class	SmtpManager.SMTPManagerFactory	Factory to create the SMTP Manager.

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractManager

AbstractManager.AbstractFactoryData

Field Summary

Fields

Modifier and Type	Field	Description
private CyclicBuffer<LogEvent>	buffer
private SmtpManager.FactoryData	data
private static SmtpManager.SMTPManagerFactory	FACTORY
private javax.mail.internet.MimeMessage	message
private javax.mail.Session	session

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

count, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SmtpManager(java.lang.String name, javax.mail.Session session, javax.mail.internet.MimeMessage message, SmtpManager.FactoryData data)

Method Summary

Modifier and Type	Method	Description
void	add(LogEvent event)
private void	connect(LogEvent appendEvent)
(package private) static java.lang.String	createManagerName(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String from, java.lang.String replyTo, java.lang.String subject, java.lang.String protocol, java.lang.String host, int port, java.lang.String username, boolean isDebug, java.lang.String filterName)	Creates a unique-per-configuration name for an smtp manager using the specified the parameters. Using such a name allows us to maintain singletons per unique configurations.
private static javax.mail.internet.MimeMessage	createMimeMessage(SmtpManager.FactoryData data, javax.mail.Session session, LogEvent appendEvent)
protected void	encodeContent(byte[] bytes, java.lang.String encoding, java.io.ByteArrayOutputStream out)
protected byte[]	encodeContentToBytes(byte[] rawBytes, java.lang.String encoding)
protected byte[]	formatContentToBytes(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout)
protected java.lang.String	getEncoding(byte[] rawBytes, java.lang.String contentType)
protected javax.mail.internet.InternetHeaders	getHeaders(java.lang.String contentType, java.lang.String encoding)
protected javax.mail.internet.MimeMultipart	getMimeMultipart(byte[] encodedBytes, javax.mail.internet.InternetHeaders headers)
static SmtpManager	getSmtpManager(Configuration config, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String from, java.lang.String replyTo, java.lang.String subject, java.lang.String protocol, java.lang.String host, int port, java.lang.String username, java.lang.String password, boolean isDebug, java.lang.String filterName, int numElements, SslConfiguration sslConfiguration)
(package private) LogEvent[]	removeAllBufferedEvents()
void	sendEvents(Layout<?> layout, LogEvent appendEvent)	Send the contents of the cyclic buffer as an e-mail message.
protected void	sendMultipartMessage(javax.mail.internet.MimeMessage msg, javax.mail.internet.MimeMultipart mp)	Deprecated. Please use the sendMultipartMessage(MimeMessage, MimeMultipart, String) method instead.
protected void	sendMultipartMessage(javax.mail.internet.MimeMessage msg, javax.mail.internet.MimeMultipart mp, java.lang.String subject)
protected void	writeBuffer(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, java.io.OutputStream out)
private void	writeContent(LogEvent[] priorEvents, LogEvent appendEvent, Layout<?> layout, java.io.ByteArrayOutputStream out)
protected void	writeFooter(Layout<?> layout, java.io.OutputStream out)
protected void	writeHeader(Layout<?> layout, java.io.OutputStream out)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

private static final SmtpManager.SMTPManagerFactory FACTORY

session

private final javax.mail.Session session

buffer

private final CyclicBuffer<LogEvent> buffer

message

private volatile javax.mail.internet.MimeMessage message

data

private final SmtpManager.FactoryData data

Constructor Detail

SmtpManager

protected SmtpManager(java.lang.String name,
                      javax.mail.Session session,
                      javax.mail.internet.MimeMessage message,
                      SmtpManager.FactoryData data)

Method Detail

createMimeMessage

private static javax.mail.internet.MimeMessage createMimeMessage(SmtpManager.FactoryData data,
                                                                 javax.mail.Session session,
                                                                 LogEvent appendEvent)
                                                          throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

add

public void add(LogEvent event)

getSmtpManager

public static SmtpManager getSmtpManager(Configuration config,
                                         java.lang.String to,
                                         java.lang.String cc,
                                         java.lang.String bcc,
                                         java.lang.String from,
                                         java.lang.String replyTo,
                                         java.lang.String subject,
                                         java.lang.String protocol,
                                         java.lang.String host,
                                         int port,
                                         java.lang.String username,
                                         java.lang.String password,
                                         boolean isDebug,
                                         java.lang.String filterName,
                                         int numElements,
                                         SslConfiguration sslConfiguration)

createManagerName

static java.lang.String createManagerName(java.lang.String to,
                                          java.lang.String cc,
                                          java.lang.String bcc,
                                          java.lang.String from,
                                          java.lang.String replyTo,
                                          java.lang.String subject,
                                          java.lang.String protocol,
                                          java.lang.String host,
                                          int port,
                                          java.lang.String username,
                                          boolean isDebug,
                                          java.lang.String filterName)

Creates a unique-per-configuration name for an smtp manager using the specified the parameters.
Using such a name allows us to maintain singletons per unique configurations.

Returns:

smtp manager name

sendEvents

public void sendEvents(Layout<?> layout,
                       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.

removeAllBufferedEvents

LogEvent[] removeAllBufferedEvents()

formatContentToBytes

protected byte[] formatContentToBytes(LogEvent[] priorEvents,
                                      LogEvent appendEvent,
                                      Layout<?> layout)
                               throws java.io.IOException

Throws:

java.io.IOException

writeContent

private void writeContent(LogEvent[] priorEvents,
                          LogEvent appendEvent,
                          Layout<?> layout,
                          java.io.ByteArrayOutputStream out)
                   throws java.io.IOException

Throws:

java.io.IOException

writeHeader

protected void writeHeader(Layout<?> layout,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

writeBuffer

protected void writeBuffer(LogEvent[] priorEvents,
                           LogEvent appendEvent,
                           Layout<?> layout,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

writeFooter

protected void writeFooter(Layout<?> layout,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

getEncoding

protected java.lang.String getEncoding(byte[] rawBytes,
                                       java.lang.String contentType)

encodeContentToBytes

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

Throws:

javax.mail.MessagingException

java.io.IOException

encodeContent

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

Throws:

javax.mail.MessagingException

java.io.IOException

getHeaders

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

getMimeMultipart

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

Throws:

javax.mail.MessagingException

sendMultipartMessage

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

Deprecated.

Please use the sendMultipartMessage(MimeMessage, MimeMultipart, String) method instead.

Throws:

javax.mail.MessagingException

sendMultipartMessage

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

Throws:

javax.mail.MessagingException

connect

private void connect(LogEvent appendEvent)