|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.projects.store.email.GenericEmailSenderFormHandler
public class GenericEmailSenderFormHandler
Generic form handler for email sending.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string. |
static java.lang.String |
MSG_ACTION_SUCCESS
|
Fields inherited from class atg.droplet.GenericFormHandler |
---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS |
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 | |
---|---|
GenericEmailSenderFormHandler()
|
Method Summary | |
---|---|
protected java.util.Map |
collectParams()
Collect parameters for e-mail templates |
java.lang.String |
getActionResult()
|
StoreEmailTools |
getEmailTools()
|
java.lang.String |
getErrorURL()
|
java.lang.String |
getMessage()
Gets the value of the Message: field. |
java.lang.String |
getMessageParamName()
Gets the name of the parameter used for the Message: field. |
atg.userprofiling.Profile |
getProfile()
Gets the user profile associated with the email. |
atg.userprofiling.ProfileTools |
getProfileTools()
|
java.lang.String |
getRecipientEmail()
Gets the value of the RecipientEmail: field. |
java.lang.String |
getRecipientEmailParamName()
Gets the name of the Email value used for the To: field. |
java.lang.String |
getRecipientName()
Gets the value of the RecipientName: field. |
java.lang.String |
getRecipientNameParamName()
Gets the name of the Name value used for the To: field. |
java.util.ResourceBundle |
getResourceBundle(atg.servlet.DynamoHttpServletRequest pRequest)
|
java.lang.String |
getResourceBundleName()
|
java.lang.String |
getSenderEmail()
Gets the value of the SenderEmail: field. |
java.lang.String |
getSenderEmailParamName()
Gets the name of the Email value used for the From: field. |
java.lang.String |
getSenderName()
Gets the value of the SenderName: field. |
java.lang.String |
getSenderNameParamName()
Gets the name of the Name value used for the From: field. |
java.lang.String |
getSiteId()
Gets the value of the SiteId: field. |
java.lang.String |
getSiteIdParamName()
Gets the name of the parameter used for the SiteId: field. |
java.lang.String |
getSubject()
|
java.lang.String |
getSubjectParamName()
|
java.lang.String |
getSuccessURL()
|
java.lang.String |
getTemplateUrl()
Gets the URL for the email template used to send the email. |
java.lang.String |
getTemplateUrlName()
|
boolean |
handleSend(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Handles the form submit and sends the email. |
void |
processException(java.lang.Throwable pException,
java.lang.String pMsgId,
atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Add a user error message to the form exceptions. |
void |
setActionResult(java.lang.String pActionResult)
|
void |
setEmailTools(StoreEmailTools pEmailTools)
|
void |
setErrorURL(java.lang.String pErrorURL)
Sets the URL of the error page. |
void |
setMessage(java.lang.String pMessage)
Sets the value of the Message: field. |
void |
setMessageParamName(java.lang.String pMessageParamName)
Sets the name of the parameter used for the Message: field. |
void |
setProfile(atg.userprofiling.Profile pProfile)
Sets The user profile associated with the email. |
void |
setRecipientEmail(java.lang.String pRecipientEmail)
Sets the value of the RecipientEmail: field. |
void |
setRecipientEmailParamName(java.lang.String pRecipientEmailParamName)
Sets the name of the Email value used for the To: field. |
void |
setRecipientName(java.lang.String pRecipientName)
Sets the value of the RecipientName: field. |
void |
setRecipientNameParamName(java.lang.String pRecipientNameParamName)
Sets the name of the Name value used for the To: field. |
void |
setResourceBundleName(java.lang.String pResourceBundleName)
|
void |
setSenderEmail(java.lang.String pSenderEmail)
Sets the value of the SenderEmail: field. |
void |
setSenderEmailParamName(java.lang.String pSenderEmailParamName)
Sets the name of the Email value used for the From: field. |
void |
setSenderName(java.lang.String pSenderName)
Sets the value of the SenderName: field. |
void |
setSenderNameParamName(java.lang.String pSenderNameParamName)
Sets the name of the Name value used for the From: field. |
void |
setSiteId(java.lang.String pSiteId)
Sets the value of the SiteId: field. |
void |
setSiteIdParamName(java.lang.String pSiteIdParamName)
Sets the name of the parameter used for the SiteId: field. |
void |
setSubject(java.lang.String pSubject)
|
void |
setSubjectParamName(java.lang.String pSubjectParamName)
|
void |
setSuccessURL(java.lang.String pSuccessURL)
Sets the URL of the success page. |
void |
setTemplateUrl(java.lang.String pTemplateUrl)
Sets the URL for the email template used to send the email. |
void |
setTemplateUrlName(java.lang.String pTemplateUrlName)
|
Methods inherited from class atg.droplet.GenericFormHandler |
---|
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet, beforeGet |
Methods inherited from class atg.nucleus.GenericService |
---|
addLogListener, createAdminServlet, doStartService, doStopService, 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 |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String MSG_ACTION_SUCCESS
Constructor Detail |
---|
public GenericEmailSenderFormHandler()
Method Detail |
---|
public java.lang.String getSubject()
public void setSubject(java.lang.String pSubject)
Subject
- the String to setpublic java.lang.String getSuccessURL()
public void setSuccessURL(java.lang.String pSuccessURL)
pSuccessURL
- -
the URL of the success pagepublic java.lang.String getErrorURL()
public void setErrorURL(java.lang.String pErrorURL)
pErrorURL
- -
the URL of the error pagepublic java.lang.String getRecipientName()
public void setRecipientName(java.lang.String pRecipientName)
pRecipientName
- -
the value of the RecipientName: field.public java.lang.String getRecipientEmail()
public void setRecipientEmail(java.lang.String pRecipientEmail)
pRecipientEmail
- -
the value of the RecipientEmail: field.public java.lang.String getSenderName()
public void setSenderName(java.lang.String pSenderName)
pSenderName
- -
the value of the SenderName: field.public java.lang.String getSenderEmail()
public void setSenderEmail(java.lang.String pSenderEmail)
pSenderEmail
- -
the value of the SenderEmail: field.public java.lang.String getSiteId()
public void setSiteId(java.lang.String pSiteId)
pSiteId
- -
the value of the SiteId: field.public java.lang.String getMessage()
public void setMessage(java.lang.String pMessage)
pMessage
- -
the value of the Message: field.public void setTemplateUrl(java.lang.String pTemplateUrl)
pTemplateUrl
- -
the URLpublic java.lang.String getTemplateUrl()
public java.lang.String getTemplateUrlName()
public void setTemplateUrlName(java.lang.String pTemplateUrlName)
mTemplateUrlName
- the String to setpublic java.lang.String getRecipientNameParamName()
public void setRecipientNameParamName(java.lang.String pRecipientNameParamName)
pRecipientNameParamName
- -
the name of the Name value used for the To: field.public java.lang.String getRecipientEmailParamName()
public void setRecipientEmailParamName(java.lang.String pRecipientEmailParamName)
pRecipientEmailParamName
- -
the name of the Email value used for the To: field.public java.lang.String getSenderNameParamName()
public void setSenderNameParamName(java.lang.String pSenderNameParamName)
pSenderNameParamName
- -
the name of the Name value used for the From: field.public java.lang.String getSenderEmailParamName()
public void setSenderEmailParamName(java.lang.String pSenderEmailParamName)
pSenderEmailParamName
- -
the name of the Email value used for the From: field.public java.lang.String getMessageParamName()
public void setMessageParamName(java.lang.String pMessageParamName)
pMessageParamName
- -
the name of the parameter used for the Comment: field.public java.lang.String getSiteIdParamName()
public void setSiteIdParamName(java.lang.String pSiteIdParamName)
pSiteIdParamName
- -
the name of the parameter used for the Comment: field.public atg.userprofiling.ProfileTools getProfileTools()
public StoreEmailTools getEmailTools()
public void setEmailTools(StoreEmailTools pEmailTools)
EmailTools
- the StoreEmailTools to setpublic void setProfile(atg.userprofiling.Profile pProfile)
pProfile
- -
the user profile of the logged in user.public atg.userprofiling.Profile getProfile()
public java.lang.String getResourceBundleName()
public void setResourceBundleName(java.lang.String pResourceBundleName)
pResourceBundleName
- -
the location of the resource bundle.public java.util.ResourceBundle getResourceBundle(atg.servlet.DynamoHttpServletRequest pRequest)
public java.lang.String getSubjectParamName()
public void setSubjectParamName(java.lang.String pSubjectParamName)
SubjectParamName
- the String to setpublic java.lang.String getActionResult()
public void setActionResult(java.lang.String pActionResult)
ActionResult
- the String to setpublic boolean handleSend(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws java.lang.Exception
pRequest
- -
http requestpResponse
- -
http response
java.lang.Exception
- if error occursprotected java.util.Map collectParams()
public void processException(java.lang.Throwable pException, java.lang.String pMsgId, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pException
- - exception to processpMsgId
- - message idpRequest
- - http requestpResponse
- - http response
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |