Package 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:
ErrorAware
,LogTarget
,Closeable
Logkit output target that logs data via SMTP.
- Since:
- 1.1.0
- Version:
- $Id: SMTPOutputLogTarget.java 231246 2005-08-10 09:32:43 -0500 (Wed, 10 Aug 2005) leif $
- Author:
- Avalon Development Team, Marcus Crafter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringBuffer
Buffer containing current mail.private long
The time that the first log entry in the current buffer arrived.private final javax.mail.Address
Address to mail is to be listed as sent from.private long
The maximun delay that a message will be allowed to wait in the queue before being sent.private final int
Maximum size of mail, in units of log events.private javax.mail.Message
Message to be sent.private int
Current size of mail, in units of log events.private Thread
Runner thread which is responsible for sending batched log entries in the background.private final javax.mail.Session
Mail session.private boolean
Flag which will be set in the close method when it is time to shutdown.private final String
Mail subject.private final javax.mail.Address[]
Address to sent mail to. -
Constructor Summary
ConstructorsConstructorDescriptionSMTPOutputLogTarget
(javax.mail.Session session, javax.mail.Address[] toAddresses, javax.mail.Address fromAddress, String subject, int maxMsgSize, int maxDelayTime, Formatter formatter) SMTPOutputLogTarget constructor.SMTPOutputLogTarget
(javax.mail.Session session, javax.mail.Address[] toAddresses, javax.mail.Address fromAddress, String subject, int maxMsgSize, Formatter formatter) SMTPOutputLogTarget constructor. -
Method Summary
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
-
Field Details
-
m_session
private final javax.mail.Session m_sessionMail session. -
m_message
private javax.mail.Message m_messageMessage to be sent. -
m_toAddresses
private final javax.mail.Address[] m_toAddressesAddress to sent mail to. -
m_fromAddress
private final javax.mail.Address m_fromAddressAddress to mail is to be listed as sent from. -
m_subject
Mail subject. -
m_msgSize
private int m_msgSizeCurrent size of mail, in units of log events. -
m_maxMsgSize
private final int m_maxMsgSizeMaximum size of mail, in units of log events. -
m_buffer
Buffer containing current mail. -
m_bufferTime
private long m_bufferTimeThe time that the first log entry in the current buffer arrived. -
m_maxDelayTime
private long m_maxDelayTimeThe maximun delay that a message will be allowed to wait in the queue before being sent. -
m_runner
Runner thread which is responsible for sending batched log entries in the background. -
m_shutdown
private boolean m_shutdownFlag which will be set in the close method when it is time to shutdown.
-
-
Constructor Details
-
SMTPOutputLogTarget
public SMTPOutputLogTarget(javax.mail.Session session, javax.mail.Address[] toAddresses, javax.mail.Address fromAddress, String subject, int maxMsgSize, int maxDelayTime, 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 usedtoAddresses
- addresses logs should be sent tofromAddress
- address logs say they come fromsubject
- subject line logs should usemaxMsgSize
- maximum size of any log mail, in units of log events. If this is greater than one but maxDelayTime is 0 then log events may stay queued for a long period of time if less than the specified number of messages are logged. Any unset messages will be sent when the target is closed.maxDelayTime
- specifies the longest delay in seconds that a log entry will be queued before being sent. Setting this to a value larger than 0 will cause a background thread to be used to queue up and send messages. Ignored if maxMsgSize is 1 or less.formatter
- log formatter to use
-
SMTPOutputLogTarget
public SMTPOutputLogTarget(javax.mail.Session session, javax.mail.Address[] toAddresses, javax.mail.Address fromAddress, 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 usedtoAddresses
- addresses logs should be sent tofromAddress
- address logs say they come fromsubject
- subject line logs should usemaxMsgSize
- maximum size of any log mail, in units of log events. Log events may stay queued for a long period of time if less than the specified number of messages are logged. Any unset messages will be sent when the target is closed.formatter
- log formatter to use
-
-
Method Details
-
write
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 classAbstractOutputTarget
- 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 interfaceCloseable
- Overrides:
close
in classAbstractOutputTarget
-
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.Only called when synchronized.
-