org.apache.log.output.net
Class SMTPOutputLogTarget

java.lang.Object
  org.apache.log.output.AbstractTarget
      org.apache.log.output.AbstractOutputTarget
          org.apache.log.output.net.SMTPOutputLogTarget

All Implemented Interfaces:

Closeable, ErrorAware, LogTarget

public class SMTPOutputLogTarget

extends AbstractOutputTarget

Logkit output target that logs data via SMTP.

Since:

1.1.0

Version:

CVS $Id: SMTPOutputLogTarget.java,v 1.10 2004/03/28 05:05:43 niclas Exp $

Author:

Avalon Development Team, Marcus Crafter

Field Summary

private java.lang.StringBuffer	m_buffer
private javax.mail.Address	m_fromAddress
private int	m_maxMsgSize
private javax.mail.Message	m_message
private int	m_msgSize
private javax.mail.Session	m_session
private java.lang.String	m_subject
private javax.mail.Address[]	m_toAddresses

Fields inherited from class org.apache.log.output.AbstractOutputTarget

Fields inherited from class org.apache.log.output.AbstractTarget

Constructor Summary

SMTPOutputLogTarget(javax.mail.Session session, javax.mail.Address[] toAddresses, javax.mail.Address fromAddress, java.lang.String subject, int maxMsgSize, Formatter formatter)
SMTPOutputLogTarget constructor.

Method Summary

void	close() Closes this log target.
private void	send() Helper method to send the currently buffered message, if existing.
void	setDebug(boolean flag) Method to enable/disable debugging on the mail session.
protected void	write(java.lang.String data) Method to write data to the log target.

Methods inherited from class org.apache.log.output.AbstractOutputTarget

doProcessEvent, getFormatter, open

Methods inherited from class org.apache.log.output.AbstractTarget

getErrorHandler, isOpen, processEvent, setErrorHandler

Methods inherited from class java.lang.Object

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

Field Detail

m_session

private final javax.mail.Session m_session

m_message

private javax.mail.Message m_message

m_toAddresses

private final javax.mail.Address[] m_toAddresses

m_fromAddress

private final javax.mail.Address m_fromAddress

m_subject

private final java.lang.String m_subject

m_msgSize

private int m_msgSize

m_maxMsgSize

private final int m_maxMsgSize

m_buffer

private java.lang.StringBuffer m_buffer

Constructor Detail

SMTPOutputLogTarget

public SMTPOutputLogTarget(javax.mail.Session session,
                           javax.mail.Address[] toAddresses,
                           javax.mail.Address fromAddress,
                           java.lang.String subject,
                           int maxMsgSize,
                           Formatter formatter)

SMTPOutputLogTarget constructor. It creates a logkit output target capable of logging to SMTP (ie. email, email gateway) targets.

Parameters:

session - mail session to be used

toAddresses - addresses logs should be sent to

fromAddress - address logs say they come from

subject - subject line logs should use

maxMsgSize - maximum size of any log mail, in units of log events

formatter - log formatter to use

Method Detail

write

protected void write(java.lang.String data)

Method to write data to the log target. Logging data is stored in an internal buffer until the size limit is reached. When this happens the data is sent to the SMTP target, and the buffer is reset for subsequent events.

Overrides:

write in class AbstractOutputTarget

Parameters:

data - logging data to be written to target

close

public void close()

Closes this log target. Sends currently buffered message, if existing.

Specified by:

close in interface Closeable

Overrides:

close in class AbstractOutputTarget

setDebug

public void setDebug(boolean flag)

Method to enable/disable debugging on the mail session.

Parameters:

flag - true to enable debugging, false to disable it

send

private void send()

Helper method to send the currently buffered message, if existing.