SK.gnome.dwarf.mail.smtp.proc.agent
Class Debug

java.lang.Object
  SK.gnome.dwarf.GenericService
      SK.gnome.dwarf.GenericServer
          SK.gnome.dwarf.thread.ThreadServer
              SK.gnome.dwarf.mail.smtp.proc.MailAgent
                  SK.gnome.dwarf.mail.smtp.proc.agent.Debug

All Implemented Interfaces:

Postprocessing, Preprocessing, SK.gnome.dwarf.Reportable, java.lang.Runnable, SK.gnome.dwarf.Server, SK.gnome.dwarf.Service

public class Debug

extends MailAgent

implements Preprocessing, Postprocessing

Provides a debugging mail agent.

It implements both preprocessing and postprocessing mail agent with no real action. If exception is set to true, the processing methods just throw a MailException each time they are invoked.

Field Summary

protected boolean

exception

Fields inherited from class SK.gnome.dwarf.mail.smtp.proc.MailAgent

context, required

Fields inherited from class SK.gnome.dwarf.thread.ThreadServer

daemon, thread

Fields inherited from class SK.gnome.dwarf.GenericService

initParameters, parent

Fields inherited from interface SK.gnome.dwarf.Service

INITIALIZED, LOG_DEBUG, LOG_ERROR, LOG_FATAL, LOG_INFO, LOG_TRACE, LOG_WARN, LOG_XFER, SHUTDOWN, STARTED, STOPPED

Constructor Summary

Debug(java.lang.String name)

Method Summary

protected void	postprocess(MailAgentMessage message, java.util.Collection recipients) Processes the message.
protected void	preprocess(MailAgentMessage message, java.util.Collection recipients) Processes the message.
void	setException(boolean enable)

Methods inherited from class SK.gnome.dwarf.mail.smtp.proc.MailAgent

destroy, filter, init, init, isRequired, setRequired, storeMessage

Methods inherited from class SK.gnome.dwarf.thread.ThreadServer

enableThread, finish, loop, run, setDaemon, shutdown, start, stop

Methods inherited from class SK.gnome.dwarf.GenericServer

addService, addService, getAuthenticator, getLogger, getParameters, getService, getServices, getServices, removeService, report

Methods inherited from class SK.gnome.dwarf.GenericService

getAuthFacility, getFullName, getInitParameter, getInitParameterNames, getLogFacility, getName, getPrincipal, getShutdownTimeout, getState, log, log, login, logout, setAuthFacility, setInitParameters, setLogFacility, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface SK.gnome.dwarf.Service

getFullName, getName, getState, log, log, login, logout

Field Detail

exception

protected boolean exception

Constructor Detail

Debug

public Debug(java.lang.String name)

Method Detail

setException

public void setException(boolean enable)

preprocess

protected void preprocess(MailAgentMessage message,
                          java.util.Collection recipients)
                   throws java.io.IOException,
                          MailException

Description copied from class: MailAgent

Processes the message.

This method is called on the agent only once for each message, just after it has arrived to the mail queue. In order to let this happen, the agent must implement the Preprocessing interface.

The recipients argument is a collection of Recipient objects representing the message recipients, as returned after processing by the mail filter chain. This collection is always non-empty.

Overrides:

preprocess in class MailAgent

Parameters:

message - the queued message

recipients - collection of recipients

Throws:

MailException - if an error occured

java.io.IOException - if an I/O error occured

postprocess

protected void postprocess(MailAgentMessage message,
                           java.util.Collection recipients)
                    throws java.io.IOException,
                           MailException

Description copied from class: MailAgent

Processes the message.

This method is called on the agent several times for each message, as it is successively delivered to the particular recipients. In order to let this happen, the agent must implement the Postprocessing interface.

The recipients argument is a collection of Recipient objects representing the message recipients, as returned after processing by the mail filter chain. This collection is always non-empty, and contains only those recipients, for which the actual delivery process succeded (or failed).

Overrides:

postprocess in class MailAgent

Parameters:

message - the queued message

recipients - collection of recipients

Throws:

MailException - if an error occured

java.io.IOException - if an I/O error occured