Package com.sun.identity.common
Class AccountLockoutInfo
- java.lang.Object
-
- com.sun.identity.common.AccountLockoutInfo
-
public class AccountLockoutInfo extends Object
AccountLockoutInfodefines a set of methods that are required by the common account lockout class.
-
-
Constructor Summary
Constructors Constructor Description AccountLockoutInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description longgetActualLockoutDuration()Returns the actual time the user needs be locked out.intgetFailCount()Returns the current failure count stored in this object.longgetLastFailTime()Returns the last fail time stored in this object.longgetLockoutAt()Returns the lockout time stored in this object.StringgetUserToken()Returns the user token.intgetWarningCount()Returns the warning count.booleanisLockout()Returns true if user was locked outvoidsetActualLockoutDuration(long aActualLockoutDuration)Sets the actual Lockout DurationvoidsetFailCount(int count)Sets the lockout failure count.voidsetLastFailTime(long now)Sets the last fail time.voidsetLockout(boolean locked)Sets the lockout status.voidsetLockoutAt(long now)Sets the lockout time.voidsetUserToken(String token)Sets the user token.voidsetWarningCount(int userWarningCount)Sets the warning count, this is the number of allowed failed attempts after which account deactivation warning message will be displayed to the user.
-
-
-
Method Detail
-
getFailCount
public int getFailCount()
Returns the current failure count stored in this object.- Returns:
- the current failure count stored in this object.
-
getLastFailTime
public long getLastFailTime()
Returns the last fail time stored in this object.- Returns:
- the last fail time stored in this object.
-
getLockoutAt
public long getLockoutAt()
Returns the lockout time stored in this object.- Returns:
- the lockout time stored in this object.
-
getActualLockoutDuration
public long getActualLockoutDuration()
Returns the actual time the user needs be locked out.- Returns:
- the actual time the user needs be locked out.
-
isLockout
public boolean isLockout()
Returns true if user was locked out- Returns:
- true if user was locked out
-
setFailCount
public void setFailCount(int count)
Sets the lockout failure count.- Parameters:
count- lockout failure count
-
setLastFailTime
public void setLastFailTime(long now)
Sets the last fail time.- Parameters:
now- time of failure
-
setLockoutAt
public void setLockoutAt(long now)
Sets the lockout time.- Parameters:
now- time that user is lockout
-
setActualLockoutDuration
public void setActualLockoutDuration(long aActualLockoutDuration)
Sets the actual Lockout Duration- Parameters:
aActualLockoutDuration- actul current lockout duration
-
setLockout
public void setLockout(boolean locked)
Sets the lockout status.- Parameters:
locked- lockout flag
-
setWarningCount
public void setWarningCount(int userWarningCount)
Sets the warning count, this is the number of allowed failed attempts after which account deactivation warning message will be displayed to the user.- Parameters:
userWarningCount- is the warning count
-
getWarningCount
public int getWarningCount()
Returns the warning count.- Returns:
- the warning count.
-
setUserToken
public void setUserToken(String token)
Sets the user token.
-
getUserToken
public String getUserToken()
Returns the user token.- Returns:
- the user token.
-
-