/**
* Logback: the reliable, generic, fast and flexible logging framework.
*
* Copyright (C) 1999-2006, QOS.ch
*
* This library is free software, you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation.
*/
package ch.qos.logback.access.net;
import ch.qos.logback.access.PatternLayout;
import ch.qos.logback.access.spi.AccessEvent;
import ch.qos.logback.core.Layout;
import ch.qos.logback.core.boolex.EventEvaluator;
import ch.qos.logback.core.helpers.CyclicBuffer;
import ch.qos.logback.core.net.SMTPAppenderBase;
/**
* 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
* <p>
* @author Ceki Gülcü
* @author Sébastien Pennec
*
*/
public class SMTPAppender extends SMTPAppenderBase<AccessEvent> {
static final String DEFAULT_SUBJECT_PATTERN = "%m";
private int bufferSize = 512;
protected CyclicBuffer<AccessEvent> cb = new CyclicBuffer<AccessEvent>(bufferSize);
/**
* The default constructor will instantiate the appender with a
* {@link EventEvaluator} that will trigger on events with level
* ERROR or higher.
*/
public SMTPAppender() {
}
/**
* Use <code>evaluator</code> passed as parameter as the {@link
* EventEvaluator} for this SMTPAppender.
*/
public SMTPAppender(EventEvaluator evaluator) {
this.eventEvaluator = evaluator;
}
/**
* Perform SMTPAppender specific appending actions, mainly adding the event to
* a cyclic buffer.
*/
protected void subAppend(AccessEvent event) {
cb.add(event);
// addInfo("Added event to the cyclic buffer: " + event.getMessage());
}
@Override
protected void fillBuffer(StringBuffer sbuf) {
int len = cb.length();
for (int i = 0; i < len; i++) {
// sbuf.append(MimeUtility.encodeText(layout.format(cb.get())));
AccessEvent event = (AccessEvent) cb.get();
sbuf.append(layout.doLayout(event));
}
}
/**
* The <b>BufferSize</b> option takes a positive integer representing the
* maximum number of logging events to collect in a cyclic buffer. When the
* <code>BufferSize</code> 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 void setBufferSize(int bufferSize) {
this.bufferSize = bufferSize;
cb.resize(bufferSize);
}
/**
* Returns value of the <b>BufferSize</b> option.
*/
public int getBufferSize() {
return bufferSize;
}
@Override
protected Layout<AccessEvent> makeSubjectLayout(String subjectStr) {
if(subjectStr == null) {
subjectStr = DEFAULT_SUBJECT_PATTERN;
}
PatternLayout pl = new PatternLayout();
pl.setPattern(subjectStr);
pl.start();
return pl;
}
}