Package org.ldaptive.auth.ext

Class PasswordPolicyAccountState

java.lang.Object

org.ldaptive.auth.AccountState

org.ldaptive.auth.ext.PasswordPolicyAccountState

public class PasswordPolicyAccountState
extends AccountState

Represents the state of an account as described by a password policy control. The PasswordPolicyControl supports a single warning and/or a single error.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.auth.AccountState

AccountState.DefaultWarning, AccountState.Error, AccountState.Warning

Field Summary

Fields

Modifier and Type	Field	Description
private PasswordPolicyControl.Error	ppError	password policy specific enum.

Constructor Summary

Constructors

Constructor	Description
PasswordPolicyAccountState(int remaining)	Creates a new password policy account state with a graceAuthNsRemaining warning.
PasswordPolicyAccountState(int remaining, PasswordPolicyControl.Error error)	Creates a new password policy account state with both a graceAuthNsRemaining warning and an error.
PasswordPolicyAccountState(ZonedDateTime exp)	Creates a new password policy account state.
PasswordPolicyAccountState(ZonedDateTime exp, int remaining)	Creates a new password policy account state with a timeBeforeExpiration warning.
PasswordPolicyAccountState(ZonedDateTime exp, PasswordPolicyControl.Error error)	Creates a new password policy account state with both a timeBeforeExpiration warning and an error.
PasswordPolicyAccountState(PasswordPolicyControl.Error error)	Creates a new password policy account state with an error.

Method Summary

Modifier and Type	Method	Description
PasswordPolicyControl.Error	getPasswordPolicyError()	Returns the password policy error for this account state.

Methods inherited from class org.ldaptive.auth.AccountState

getError, getErrors, getWarning, getWarnings, toString

Methods inherited from class java.lang.Object

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

Field Detail

ppError

private final PasswordPolicyControl.Error ppError

password policy specific enum.

Constructor Detail

PasswordPolicyAccountState

public PasswordPolicyAccountState(ZonedDateTime exp,
                                  int remaining)

Creates a new password policy account state with a timeBeforeExpiration warning.

Parameters:

exp - account expiration

remaining - number of logins available

PasswordPolicyAccountState

public PasswordPolicyAccountState(ZonedDateTime exp)

Creates a new password policy account state.

Parameters:

exp - account expiration

PasswordPolicyAccountState

public PasswordPolicyAccountState(int remaining)

Creates a new password policy account state with a graceAuthNsRemaining warning.

Parameters:

remaining - number of logins available

PasswordPolicyAccountState

public PasswordPolicyAccountState(PasswordPolicyControl.Error error)

Creates a new password policy account state with an error.

Parameters:

error - containing password policy error details

PasswordPolicyAccountState

public PasswordPolicyAccountState(ZonedDateTime exp,
                                  PasswordPolicyControl.Error error)

Creates a new password policy account state with both a timeBeforeExpiration warning and an error.

Parameters:

exp - account expiration

error - containing password policy error details

PasswordPolicyAccountState

public PasswordPolicyAccountState(int remaining,
                                  PasswordPolicyControl.Error error)

Creates a new password policy account state with both a graceAuthNsRemaining warning and an error.

Parameters:

remaining - number of logins available

error - containing password policy error details

Method Detail

getPasswordPolicyError

public PasswordPolicyControl.Error getPasswordPolicyError()

Returns the password policy error for this account state.

Returns:

password policy error