|
|||||||||
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.userprofiling.ProfileForm atg.userprofiling.ForgotPasswordHandler
public class ForgotPasswordHandler
This class provides a form handler for handling requests related to forgot password functionality. The form has an emptySite and siteId Property. When emptySite is true, a null siteId is passed to the email and any siteId specified in form is ignored. When emptySite is set to false or not provided, the siteId that is passed through the form is used in the email. If no siteId is provided, the form defaults to the current site context.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class atg.userprofiling.ProfileForm |
---|
ProfileForm.ProfileFormHashtableWrapper |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.Boolean |
mEmptySite
If there is no site, set to true. |
protected static java.lang.String |
MSG_ERR_SENDING_EMAIL
|
protected static java.lang.String |
MSG_NO_SUCH_PROFILE
|
protected java.lang.String |
mSiteId
The Site id for the form. |
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 | |
---|---|
ForgotPasswordHandler()
|
Method Summary | |
---|---|
protected java.util.Map |
generateNewPasswordTemplateParams(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
RepositoryItem pProfile,
java.lang.String pNewPassword)
Generates the parameters map that's used to send the new password email. |
java.lang.Boolean |
getEmptySite()
Site id |
java.lang.String |
getForgotPasswordErrorURL()
|
java.lang.String |
getForgotPasswordSuccessURL()
|
java.lang.String |
getNewPasswordParam()
|
java.lang.String |
getSiteId()
Site id |
TemplateEmailInfoImpl |
getTemplateEmailInfo()
|
TemplateEmailSender |
getTemplateEmailSender()
|
boolean |
handleForgotPassword(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Takes a login or email property and, if there were no errors in submitting the form, finds the profile associated, generates a new password, updates the profile, and sends an email to the user. |
boolean |
isPersistEmails()
Returns boolean indicating whether the email is persisted before it is sent. |
boolean |
isSendEmailInSeparateThread()
Returns boolean indicating whether the email is sent in a separate thread. |
MutableRepositoryItem[] |
lookupUsers(java.lang.String login,
java.lang.String email)
Lookup an array of users from the given login or email. |
protected void |
postForgotPassword(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after the forgot password logic is executed |
protected void |
preForgotPassword(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before the forgot password logic is executed |
void |
setEmptySite(java.lang.Boolean pEmptySite)
Set the EmptySite |
void |
setForgotPasswordErrorURL(java.lang.String pForgotPasswordErrorURL)
Sets the property ForgotPasswordErrorURL. |
void |
setForgotPasswordSuccessURL(java.lang.String pForgotPasswordSuccessURL)
Sets the property ForgotPasswordSuccessURL. |
void |
setNewPasswordParam(java.lang.String pNewPasswordParam)
Sets the property NewPasswordParam |
void |
setPersistEmails(boolean pPersistEmails)
Sets boolean indicating whether the email is persisted before it is sent. |
void |
setSendEmailInSeparateThread(boolean pSendEmailInSeparateThread)
Sets boolean indicating whether the email is sent in a separate thread. |
void |
setSiteId(java.lang.String pSiteId)
Set the Site ID |
void |
setTemplateEmailInfo(TemplateEmailInfoImpl pTemplateEmailInfo)
Sets the property TemplateEmailInfo |
void |
setTemplateEmailSender(TemplateEmailSender pTemplateEmailSender)
Sets the property TemplateEmailSender |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet, beforeGet |
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
protected static final java.lang.String MSG_NO_SUCH_PROFILE
protected static final java.lang.String MSG_ERR_SENDING_EMAIL
protected java.lang.String mSiteId
protected java.lang.Boolean mEmptySite
Constructor Detail |
---|
public ForgotPasswordHandler()
Method Detail |
---|
public void setSendEmailInSeparateThread(boolean pSendEmailInSeparateThread)
pUsingPriceLists
- boolean indicating whether the email is sent in a separate thread.public boolean isSendEmailInSeparateThread()
public void setPersistEmails(boolean pPersistEmails)
pUsingPriceLists
- boolean indicating whether the email is persisted before it is sent.public boolean isPersistEmails()
public void setTemplateEmailSender(TemplateEmailSender pTemplateEmailSender)
public TemplateEmailSender getTemplateEmailSender()
public void setSiteId(java.lang.String pSiteId)
public java.lang.String getSiteId()
public void setEmptySite(java.lang.Boolean pEmptySite)
public java.lang.Boolean getEmptySite()
public void setForgotPasswordErrorURL(java.lang.String pForgotPasswordErrorURL)
public java.lang.String getForgotPasswordErrorURL()
public void setForgotPasswordSuccessURL(java.lang.String pForgotPasswordSuccessURL)
public java.lang.String getForgotPasswordSuccessURL()
public void setTemplateEmailInfo(TemplateEmailInfoImpl pTemplateEmailInfo)
public TemplateEmailInfoImpl getTemplateEmailInfo()
public void setNewPasswordParam(java.lang.String pNewPasswordParam)
public java.lang.String getNewPasswordParam()
public boolean handleForgotPassword(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
If any errors occur in the process, form errors will be added. If there were no errors encountered while submitting the form, we optionally redirect to the value of the property forgotPasswordSuccessURL. Otherwise, we optionally redirect to forgotPasswordErrorURL.
pRequest
- the servlet's requestpResponse
- the servlet's response
javax.servlet.ServletException
- if there was an error while executing the code
java.io.IOException
- if there was an error with servlet ioProfileTools.generateNewPasswordForProfile(RepositoryItem)
,
ProfileTools#sendEmailToUser(MutableRepositoryItem, boolean, boolean, TemplateEmailInfo, Map)
,
generateNewPasswordTemplateParams(DynamoHttpServletRequest, DynamoHttpServletResponse, RepositoryItem, String)
protected java.util.Map generateNewPasswordTemplateParams(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, RepositoryItem pProfile, java.lang.String pNewPassword)
By default, this method adds the parameter for the new password using the
name configured in the newPasswordParam
property.
Extend this method to add additional parameters to the email template.
pRequest
- pResponse
- pProfile
- the profile that had the new password generated.pNewPassword
- the new password in clear text
protected void preForgotPassword(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's response
javax.servlet.ServletException
- if there was an error while executing the code
java.io.IOException
- if there was an error with servlet ioprotected void postForgotPassword(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's response
javax.servlet.ServletException
- if there was an error while executing the code
java.io.IOException
- if there was an error with servlet iopublic MutableRepositoryItem[] lookupUsers(java.lang.String login, java.lang.String email)
login
- - login passed from web formemail
- - email address passed from web form
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |