Class MailManager
- java.lang.Object
-
- org.apache.logging.log4j.core.appender.AbstractManager
-
- org.apache.logging.log4j.core.net.MailManager
-
- All Implemented Interfaces:
java.lang.AutoCloseable
- Direct Known Subclasses:
SmtpManager
public abstract class MailManager extends AbstractManager
Parent of all managers that send e-mails.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MailManager.FactoryData
-
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractManager
AbstractManager.AbstractFactoryData
-
-
Field Summary
-
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager
count, LOGGER
-
-
Constructor Summary
Constructors Constructor Description MailManager(LoggerContext loggerContext, java.lang.String name)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
add(LogEvent event)
Adds an event to the cyclic buffer.(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 smtpProtocol, java.lang.String smtpHost, int smtpPort, java.lang.String smtpUsername, boolean smtpDebug, 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.abstract void
sendEvents(Layout<?> layout, LogEvent appendEvent)
Send the contents of the cyclic buffer as an e-mail message.-
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
-
-
-
-
Constructor Detail
-
MailManager
public MailManager(LoggerContext loggerContext, java.lang.String name)
-
-
Method Detail
-
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 smtpProtocol, java.lang.String smtpHost, int smtpPort, java.lang.String smtpUsername, boolean smtpDebug, 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
-
add
public abstract void add(LogEvent event)
Adds an event to the cyclic buffer.- Parameters:
event
- The event to add.
-
-