ch.qos.logback.access.net

Class SMTPAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<E>

ch.qos.logback.core.net.SMTPAppenderBase<IAccessEvent>

ch.qos.logback.access.net.SMTPAppender

All Implemented Interfaces:

Appender<IAccessEvent>, ContextAware, FilterAttachable<IAccessEvent>, LifeCycle

public class SMTPAppender
extends SMTPAppenderBase<IAccessEvent>

Send an e-mail when a specific access event occurs, typically when certain pages are accessed. For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#AccessSMTPAppender

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	DEFAULT_SUBJECT_PATTERN

Fields inherited from class ch.qos.logback.core.net.SMTPAppenderBase

cbTracker, discriminator, eventEvaluator, layout, session, subjectLayout

Fields inherited from class ch.qos.logback.core.AppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
SMTPAppender() The default constructor will instantiate the appender with a EventEvaluator that will trigger on events with level ERROR or higher.
SMTPAppender(EventEvaluator<IAccessEvent> evaluator) Use evaluator passed as parameter as the EventEvaluator for this SMTPAppender.

Method Summary

Modifier and Type	Method and Description
protected boolean	eventMarksEndOfLife(IAccessEvent eventObject)
protected void	fillBuffer(CyclicBuffer<IAccessEvent> cb, java.lang.StringBuffer sbuf)
protected PatternLayout	makeNewToPatternLayout(java.lang.String toPattern)
protected Layout<IAccessEvent>	makeSubjectLayout(java.lang.String subjectStr) return a layout for the subject string as appropriate for the module.
protected void	subAppend(CyclicBuffer<IAccessEvent> cb, IAccessEvent event) Perform SMTPAppender specific appending actions, mainly adding the event to the appropriate cyclic buffer.

Methods inherited from class ch.qos.logback.core.net.SMTPAppenderBase

addTo, append, checkEntryConditions, getCharsetEncoding, getCyclicBufferTracker, getDiscriminator, getFrom, getJndiLocation, getLayout, getLocalhost, getPassword, getSmtpHost, getSMTPHost, getSmtpPort, getSMTPPort, getSubject, getToAsListOfString, getToList, getUsername, isAsynchronousSending, isSessionViaJNDI, isSSL, isSTARTTLS, sendBuffer, setAsynchronousSending, setCharsetEncoding, setCyclicBufferTracker, setDiscriminator, setEvaluator, setFrom, setJndiLocation, setLayout, setLocalhost, setPassword, setSessionViaJNDI, setSmtpHost, setSMTPHost, setSmtpPort, setSMTPPort, setSSL, setSTARTTLS, setSubject, setUsername, start, stop

Methods inherited from class ch.qos.logback.core.AppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

DEFAULT_SUBJECT_PATTERN

static final java.lang.String DEFAULT_SUBJECT_PATTERN

See Also:

Constant Field Values

Constructor Detail

SMTPAppender

public SMTPAppender()

The default constructor will instantiate the appender with a EventEvaluator that will trigger on events with level ERROR or higher.

SMTPAppender

public SMTPAppender(EventEvaluator<IAccessEvent> evaluator)

Use evaluator passed as parameter as the EventEvaluator for this SMTPAppender.

Method Detail

subAppend

protected void subAppend(CyclicBuffer<IAccessEvent> cb,
                         IAccessEvent event)

Perform SMTPAppender specific appending actions, mainly adding the event to the appropriate cyclic buffer.

Specified by:

subAppend in class SMTPAppenderBase<IAccessEvent>

fillBuffer

protected void fillBuffer(CyclicBuffer<IAccessEvent> cb,
                          java.lang.StringBuffer sbuf)

Specified by:

fillBuffer in class SMTPAppenderBase<IAccessEvent>

makeSubjectLayout

protected Layout<IAccessEvent> makeSubjectLayout(java.lang.String subjectStr)

Description copied from class: SMTPAppenderBase

return a layout for the subject string as appropriate for the module. If the subjectStr parameter is null, then a default value for subjectStr should be used.

Specified by:

makeSubjectLayout in class SMTPAppenderBase<IAccessEvent>

Returns:

a layout as appropriate for the module

makeNewToPatternLayout

protected PatternLayout makeNewToPatternLayout(java.lang.String toPattern)

Specified by:

makeNewToPatternLayout in class SMTPAppenderBase<IAccessEvent>

eventMarksEndOfLife

protected boolean eventMarksEndOfLife(IAccessEvent eventObject)

Specified by:

eventMarksEndOfLife in class SMTPAppenderBase<IAccessEvent>