atg.service.email
Class EmailListenerQueue

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.queue.EventQueue
              atg.service.email.EmailListenerQueue

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, EmailListener, EmailSender, atg.service.email.TrackableEmailSender, java.util.EventListener

public class EmailListenerQueue
extends EventQueue
implements EmailListener, EmailSender, atg.service.email.TrackableEmailSender

This is a queueing version of the interface atg.service.email.EmailListener. Calls made to this class are queued, then passed on to the listeners of this interface

This class was ORIGINALLY generated automatically by atg.service.queue.EventQueueGenerator using the command java atg.service.queue.EventQueueGenerator atg.service.email.EmailListener. HOWEVER, this class has been supplemented with the EmailSender interface, which provides an easy mechanism for sending email messages. Any messages genertated via these EmailSender methods are also queued through the sendEmailEvent method.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

EmailListenerQueue()

Method Summary

void	addEmailListener(EmailListener pListener)
protected EventQueueElement	createElement() Constructs a new blank EventQueueElement.
protected void	dispatchElement(EventQueueElement pElem) Dispatches a Queue element to be handled.
int	getEmailListenerCount()
EmailListener[]	getEmailListeners()
void	removeEmailListener(EmailListener pListener)
void	sendEmailEvent(EmailEvent arg0) Takes the given event and sends if off as an email message
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders, java.util.Map pTrackingData) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) Sends a message via SMTP with the given parameters.
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders, java.util.Map pTrackingData) Sends a message via SMTP with the given parameters.

Methods inherited from class atg.service.queue.EventQueue

addElement, dispatchQueueElements, doStartService, doStopService, flushQueue, getElement, getInitialCapacity, getQueuedEventCount, getQueueHead, getQueueSize, getThreadCount, getTransactionManager, getTransactionsEnabled, handleDispatchError, listQueuedElements, setInitialCapacity, setThreadCount, setTransactionManager, setTransactionsEnabled

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

EmailListenerQueue

public EmailListenerQueue()

Method Detail

createElement

protected EventQueueElement createElement()

Description copied from class: EventQueue

Constructs a new blank EventQueueElement. Subclasses must implement this method.

Specified by:

createElement in class EventQueue

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String pRecipient,
                             java.lang.String pSubject,
                             java.lang.String pBody)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String pRecipient,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String pExtraHeader)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

pExtraHeader - An extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String[] pRecipients,
                             java.lang.String pSubject,
                             java.lang.String pBody)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String pRecipient,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String[] pExtraHeaders)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String[] pRecipients,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String pExtraHeader)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

pExtraHeader - An extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String[] pRecipients,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String[] pExtraHeaders)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface EmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String pRecipient,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String[] pExtraHeaders,
                             java.util.Map pTrackingData)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface atg.service.email.TrackableEmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

pTrackingData - NV pair data to associate with the out-bound email.

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

public void sendEmailMessage(java.lang.String pFrom,
                             java.lang.String[] pRecipients,
                             java.lang.String pSubject,
                             java.lang.String pBody,
                             java.lang.String[] pExtraHeaders,
                             java.util.Map pTrackingData)
                      throws EmailException

Sends a message via SMTP with the given parameters. The message content is prepended by any value for the default body property.

Specified by:

sendEmailMessage in interface atg.service.email.TrackableEmailSender

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

pTrackingData - NV pair data to associate with the out-bound email.

Throws:

EmailException - if there is any problem while sending mail

addEmailListener

public void addEmailListener(EmailListener pListener)

removeEmailListener

public void removeEmailListener(EmailListener pListener)

getEmailListenerCount

public int getEmailListenerCount()

getEmailListeners

public EmailListener[] getEmailListeners()

sendEmailEvent

public void sendEmailEvent(EmailEvent arg0)
                    throws EmailException

Description copied from interface: EmailListener

Takes the given event and sends if off as an email message

Specified by:

sendEmailEvent in interface EmailListener

Throws:

EmailException

dispatchElement

protected void dispatchElement(EventQueueElement pElem)

Description copied from class: EventQueue

Dispatches a Queue element to be handled. Subclasses must implement this method.

Specified by:

dispatchElement in class EventQueue