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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
EmailListenerQueue() |
Modifier and Type | Method and Description |
---|---|
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.
|
addElement, dispatchQueueElements, doStartService, doStopService, flushQueue, getElement, getInitialCapacity, getQueuedEventCount, getQueueHead, getQueueSize, getThreadCount, getTransactionManager, getTransactionsEnabled, handleDispatchError, listQueuedElements, setInitialCapacity, setThreadCount, setTransactionManager, setTransactionsEnabled
addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
protected EventQueueElement createElement()
EventQueue
createElement
in class EventQueue
public void sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipient
- The recipient that should receive the messagepSubject
- Subject line of the email messagepBody
- The message contentEmailException
- if there is any problem while sending mailpublic void sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipient
- The recipient that should receive the messagepSubject
- Subject line of the email messagepBody
- The message contentpExtraHeader
- An extra headers that should be used
in the email (e.g. "X-URL: http://foo.bar.com/"
)EmailException
- if there is any problem while sending mailpublic void sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipients
- The list of recipients that should receive emailpSubject
- Subject line of the email messagepBody
- The message contentEmailException
- if there is any problem while sending mailpublic void sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipient
- The recipient that should receive the messagepSubject
- Subject line of the email messagepBody
- The message contentpExtraHeaders
- The list of extra headers that should be used
in the email (e.g. "X-URL: http://foo.bar.com/"
)EmailException
- if there is any problem while sending mailpublic void sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipients
- The list of recipients that should receive emailpSubject
- Subject line of the email messagepBody
- The message contentpExtraHeader
- An extra headers that should be used
in the email (e.g. "X-URL: http://foo.bar.com/"
)EmailException
- if there is any problem while sending mailpublic void sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) throws EmailException
sendEmailMessage
in interface EmailSender
pFrom
- Whom the mail is coming frompRecipients
- The list of recipients that should receive emailpSubject
- Subject line of the email messagepBody
- The message contentpExtraHeaders
- The list of extra headers that should be used
in the email (e.g. "X-URL: http://foo.bar.com/"
)EmailException
- if there is any problem while sending mailpublic 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
sendEmailMessage
in interface atg.service.email.TrackableEmailSender
pFrom
- Whom the mail is coming frompRecipient
- The recipient that should receive the messagepSubject
- Subject line of the email messagepBody
- The message contentpExtraHeaders
- 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.EmailException
- if there is any problem while sending mailpublic 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
sendEmailMessage
in interface atg.service.email.TrackableEmailSender
pFrom
- Whom the mail is coming frompRecipients
- The list of recipients that should receive emailpSubject
- Subject line of the email messagepBody
- The message contentpExtraHeaders
- 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.EmailException
- if there is any problem while sending mailpublic void addEmailListener(EmailListener pListener)
public void removeEmailListener(EmailListener pListener)
public int getEmailListenerCount()
public EmailListener[] getEmailListeners()
public void sendEmailEvent(EmailEvent arg0) throws EmailException
EmailListener
sendEmailEvent
in interface EmailListener
EmailException
protected void dispatchElement(EventQueueElement pElem)
EventQueue
dispatchElement
in class EventQueue