Package com.atlassian.confluence.user.actions

Class ForgotUserPasswordAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.ForgotUserPasswordAction

All Implemented Interfaces:

WebInterface, CaptchaAware, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class ForgotUserPasswordAction
extends ConfluenceActionSupport
implements CaptchaAware

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
ForgotUserPasswordAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	execute()
String	format(String format, Object... args)
CaptchaManager	getCaptchaManager()
String	getChangePasswordLink()
String	getChangePasswordRequestLink()
ConfluenceUser	getUser()
String	getUsernameOrEmail()
boolean	isMailServerConfigured()
boolean	isPermitted()
boolean	mustValidateCaptcha()
void	setActionRateLimiterForgetuserpassword(ActionRateLimiter actionRateLimiterForgetuserpassword)	Setting ActionRateLimiter
void	setCaptchaManager(CaptchaManager captchaManager)
void	setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
void	setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)
void	setUsernameOrEmail(String usernameOrEmail)
void	setUserVerificationTokenManager(UserVerificationTokenManager userVerificationTokenManager)
void	validate()

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, useSkipAccessCheck, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

Constructor Detail

ForgotUserPasswordAction

public ForgotUserPasswordAction()

Method Detail

doDefault

public String doDefault()

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork2.Validateable

Overrides:

validate in class com.opensymphony.xwork2.ActionSupport

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

getChangePasswordLink

public String getChangePasswordLink()

getChangePasswordRequestLink

public String getChangePasswordRequestLink()

getUser

public ConfluenceUser getUser()

format

public String format(String format,
                     Object... args)

isMailServerConfigured

public boolean isMailServerConfigured()

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

getUsernameOrEmail

public String getUsernameOrEmail()

setUsernameOrEmail

public void setUsernameOrEmail(String usernameOrEmail)

setMailServerManager

public void setMailServerManager(com.atlassian.mail.server.MailServerManager mailServerManager)

setUserVerificationTokenManager

public void setUserVerificationTokenManager(UserVerificationTokenManager userVerificationTokenManager)

setEventPublisher

public void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

getCaptchaManager

public CaptchaManager getCaptchaManager()

setCaptchaManager

public void setCaptchaManager(CaptchaManager captchaManager)

mustValidateCaptcha

public boolean mustValidateCaptcha()

Specified by:

mustValidateCaptcha in interface CaptchaAware

Returns:

a boolean value indicating if the Captcha response must always be validated on each action form post. e.g. There is no counter for number of tries, and no requirement for captcha spam prevention to be explicitly enabled.

setActionRateLimiterForgetuserpassword

public void setActionRateLimiterForgetuserpassword(ActionRateLimiter actionRateLimiterForgetuserpassword)

Setting ActionRateLimiter

Parameters:

actionRateLimiterForgetuserpassword -

Since:

8.7