Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class ResetPassword

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.JiveActionSupport
          extended by com.jivesoftware.forum.action.ForumActionSupport
              extended by com.jivesoftware.forum.action.ResetPassword
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class ResetPassword
extends ForumActionSupport
implements com.opensymphony.xwork.Validateable

This class is an Action which encapsulates all the logic needed for the reset password functionality.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED
 
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport
pageUser, request, response
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
ResetPassword()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          This method is used in conjunction with the emailResetPasswordInstructions method to reset a user's password.
 java.lang.String getConfirmNewPassword()
          Returns the confirm new password as entered by the page user.
 java.lang.String getNewPassword()
          Returns the new password as entered by the page user.
 java.lang.String getToken()
          Returns the token as entered by the page user.
 long getUserid()
          returns the userid as entered by the page user.
 void setConfirmNewPassword(java.lang.String confirmNewPassword)
          Sets the new password confirmation.
 void setNewPassword(java.lang.String newPassword)
          Sets the new password.
 void setToken(java.lang.String token)
          Sets the token.
 void setUserid(long userid)
          Sets the userid.
 void validate()
          WW validation method.
 
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser
 
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResetPassword

public ResetPassword()
Method Detail

getToken

public java.lang.String getToken()
Returns the token as entered by the page user.


setToken

public void setToken(java.lang.String token)
Sets the token.


getUserid

public long getUserid()
returns the userid as entered by the page user.


setUserid

public void setUserid(long userid)
Sets the userid.


getNewPassword

public java.lang.String getNewPassword()
Returns the new password as entered by the page user.


setNewPassword

public void setNewPassword(java.lang.String newPassword)
Sets the new password.


getConfirmNewPassword

public java.lang.String getConfirmNewPassword()
Returns the confirm new password as entered by the page user.


setConfirmNewPassword

public void setConfirmNewPassword(java.lang.String confirmNewPassword)
Sets the new password confirmation.


validate

public void validate()
WW validation method. This method validates the userid and token have been given and that the new password and it's confirmation have been given, are long enough, and are equal.

Errors are stored in the ww errors map with the following keys:

Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
This method is used in conjunction with the emailResetPasswordInstructions method to reset a user's password. The system generated token will be provided in the instructional email. Possible reasons for failure:

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.