com.microstrategy.ushersdk

Class PasswordManager

java.lang.Object

com.microstrategy.ushersdk.PasswordManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class PasswordManager
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

The PasswordManager class collects all of the APIs related to password management and validation. Password management includes processes such as changing the password, resetting the password, requesting an OTP for password reset, and getting the password policy for the user account. Password validation involves verifying that a password satisfies the requirements set forth by the password policy. All of these methods will be executed on a background thread and return the result on the main thread. To receive the result, you are expected to pass a corresponding SingleCallback or CompleteCallback.

Constructor Summary

Constructors

Constructor and Description
PasswordManager(android.support.v7.app.AppCompatActivity appCompatActivity) Constructor for a PasswordManager object with the lifecycle set.
PasswordManager(android.support.v4.app.Fragment fragment) Constructor for a PasswordManager object with the lifecycle set.
PasswordManager(android.arch.lifecycle.Lifecycle lifecycle) Constructor for a PasswordManager object with the lifecycle set.

Method Summary

Modifier and Type	Method and Description
void	changePassword(ChangePasswordParam changePasswordParam, CompleteCallback callback) Returns a CompleteCallback after changing the password for a user account.
void	forgotPassword(java.lang.String email, RecipientType recipientType, CompleteCallback callback) Returns a CompleteCallback after requesting a one-time password (OTP) to reset a password for a user account.
void	getPasswordPolicy(SingleCallback<PasswordPolicyEntity> callback) Returns a system level PasswordPolicyEntity object, which contains properties related to password requirements.
void	resetPassword(ResetPasswordParam resetPasswordParam, CompleteCallback callback) Returns a CompleteCallback after resetting the password for a user account.
void	validatePassword(java.util.List<java.lang.Character> password, SingleCallback<java.lang.Boolean> callback) Returns a boolean that represents whether or not the user password satisfies the password policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordManager

public PasswordManager(android.arch.lifecycle.Lifecycle lifecycle)

Constructor for a PasswordManager object with the lifecycle set.

Parameters:

lifecycle - See Lifecycle

PasswordManager

public PasswordManager(android.support.v7.app.AppCompatActivity appCompatActivity)

Constructor for a PasswordManager object with the lifecycle set.

Parameters:

appCompatActivity - See AppCompatActivity

PasswordManager

public PasswordManager(android.support.v4.app.Fragment fragment)

Constructor for a PasswordManager object with the lifecycle set.

Parameters:

fragment - See Fragment

Method Detail

changePassword

public void changePassword(ChangePasswordParam changePasswordParam,
                           CompleteCallback callback)

Returns a CompleteCallback after changing the password for a user account.

Parameters:

changePasswordParam - the parameters for changing password. See ChangePasswordParam

callback - the callback to receive the result of changing the password for a user account

forgotPassword

public void forgotPassword(java.lang.String email,
                           RecipientType recipientType,
                           CompleteCallback callback)

Returns a CompleteCallback after requesting a one-time password (OTP) to reset a password for a user account. The OTP can be sent to either the email address or mobile phone number that is associated with the email address provided in the parameter.

To utilize the OTP to reset the password, see resetPassword(ResetPasswordParam, CompleteCallback).

Parameters:

email - the email address for a user account

recipientType - the type of recipient for the OTP. See RecipientType

callback - the callback to receive the result of requesting an OTP to reset a password for a user account

getPasswordPolicy

public void getPasswordPolicy(SingleCallback<PasswordPolicyEntity> callback)

Returns a system level PasswordPolicyEntity object, which contains properties related to password requirements.

Parameters:

callback - the callback to receive the PasswordPolicyEntity object

resetPassword

public void resetPassword(ResetPasswordParam resetPasswordParam,
                          CompleteCallback callback)

Returns a CompleteCallback after resetting the password for a user account.

Parameters:

resetPasswordParam - the parameters for the password reset. See ResetPasswordParam

callback - the callback to receive the result of resetting the password for a user account

validatePassword

public void validatePassword(java.util.List<java.lang.Character> password,
                             SingleCallback<java.lang.Boolean> callback)

Returns a boolean that represents whether or not the user password satisfies the password policy.

Parameters:

password - the user account password to be validated

callback - the callback to receive the result of password validation.
true if the user account password validation was successful; false otherwise