Class PasswordChange

java.lang.Object
africa.absa.inception.security.PasswordChange
All Implemented Interfaces:
Serializable

public class PasswordChange extends Object implements Serializable
The PasswordChange class holds the information for a password change.
Author:
Marcus Portmann
See Also:
  • Constructor Details

    • PasswordChange

      public PasswordChange()
      Constructs a new PasswordChange.
    • PasswordChange

      public PasswordChange(String newPassword, String password)
      Constructs a new PasswordChange for a USER password change.
      Parameters:
      newPassword - the new password
      password - the password for the user that is used to authorise the operation when performing a user password change
    • PasswordChange

      public PasswordChange(String newPassword, Boolean expirePassword, Boolean lockUser, Boolean resetPasswordHistory)
      Constructs a new PasswordChange for an ADMINISTRATIVE password change.
      Parameters:
      newPassword - the new password
      expirePassword - expire the user's password when performing the administrative password change
      lockUser - lock the user when performing the administrative password change
      resetPasswordHistory - reset the user's password history when performing the administrative password change
  • Method Details

    • getExpirePassword

      public Boolean getExpirePassword()
      Returns whether the user's password should be expired when performing an administrative password change.
      Returns:
      true if the user's password should be expired when performing an administrative password changeor false otherwise
    • getLockUser

      public Boolean getLockUser()
      Returns whether the user should be locked when performing an administrative password change.
      Returns:
      true if the user should be locked when performing an administrative password change or false otherwise
    • getNewPassword

      public String getNewPassword()
      Returns the new password.
      Returns:
      the new password
    • getPassword

      public String getPassword()
      Returns the password for the user that is used to authorise the operation when performing a user password change.
      Returns:
      the password for the user that is used to authorise the operation when performing a user password change
    • getReason

      public PasswordChangeReason getReason()
      Returns the reason for changing the password.
      Returns:
      the reason for changing the password
    • getResetPasswordHistory

      public Boolean getResetPasswordHistory()
      Returns whether the user's password history should be reset when performing an administrative password change.
      Returns:
      true if the user's password history should be reset when performing an administrative password changeor false otherwise
    • getSecurityCode

      public String getSecurityCode()
      Returns the security code when performing a forgotten password change.
      Returns:
      the security code when performing a forgotten password change
    • setExpirePassword

      public void setExpirePassword(Boolean expirePassword)
      Set whether the user's password should be expired when performing an administrative password change.
      Parameters:
      expirePassword - expire the user's password when performing an administrative password change
    • setLockUser

      public void setLockUser(Boolean lockUser)
      Set whether the user should be locked when performing an administrative password change.
      Parameters:
      lockUser - lock the user when performing an administrative password change
    • setNewPassword

      public void setNewPassword(String newPassword)
      Set the new password when performing a user password change.
      Parameters:
      newPassword - the new password when performing a new password change
    • setPassword

      public void setPassword(String password)
      Set the password for the user that is used to authorise the operation when performing a user password change.
      Parameters:
      password - the password for the user that is used to authorise the operation when performing a user password change
    • setReason

      public void setReason(PasswordChangeReason reason)
      Set the reason for changing the password.
      Parameters:
      reason - the reason for changing the password
    • setResetPasswordHistory

      public void setResetPasswordHistory(Boolean resetPasswordHistory)
      Set whether the user's password history should be reset when performing an administrative password change.
      Parameters:
      resetPasswordHistory - reset the user's password history when performing an administrative password change
    • setSecurityCode

      public void setSecurityCode(String securityCode)
      Set the security code when performing a forgotten password change.
      Parameters:
      securityCode - the security code when performing a forgotten password change