com.pingidentity.sdk.account

Interface AccountUnlockablePasswordCredential

public interface AccountUnlockablePasswordCredential

Implemented by a PasswordCredentialValidator to support unlocking a user account that has been locked using the 'Trouble Logging In?' option.

Since:

8.4

See Also:

PasswordCredentialValidator

Method Summary

Modifier and Type	Method and Description
boolean	isAccountLocked(String username) Checks whether the user account is temporarily locked due to too many failure attempts.
boolean	isAccountUnlockable() Indicate whether an account can be unlocked.
boolean	unlockAccount(String username) Unlock the account for the given user.

Method Detail

unlockAccount

boolean unlockAccount(String username)

Unlock the account for the given user.

Parameters:

username - of the user account to be unlocked

Returns:

TRUE if the account unlock was successful

isAccountLocked

boolean isAccountLocked(String username)

Checks whether the user account is temporarily locked due to too many failure attempts.

Parameters:

username - of the user account

Returns:

TRUE if the account is locked

isAccountUnlockable

boolean isAccountUnlockable()

Indicate whether an account can be unlocked.

In some cases implementing this interface is not sufficient for enabling account unlock through a PasswordCredentialValidator, it could also depend on factors such as associated LDAP data store.

If this method returns false, it's recommended to log a warning indicating the reason to help the administrator resolve the issue.

Returns:

TRUE is an account is unlockable