com.sun.identity.common

Class AccountLockoutInfo

java.lang.Object

com.sun.identity.common.AccountLockoutInfo

public class AccountLockoutInfo
extends Object

AccountLockoutInfo defines a set of methods that are required by the common account lockout class.

Constructor Summary

Constructors

Constructor and Description
AccountLockoutInfo()

Method Summary

Modifier and Type	Method and Description
long	getActualLockoutDuration() Returns the actual time the user needs be locked out.
int	getFailCount() Returns the current failure count stored in this object.
long	getLastFailTime() Returns the last fail time stored in this object.
long	getLockoutAt() Returns the lockout time stored in this object.
String	getUserToken() Returns the user token.
int	getWarningCount() Returns the warning count.
boolean	isLockout() Returns true if user was locked out
void	setActualLockoutDuration(long aActualLockoutDuration) Sets the actual Lockout Duration
void	setFailCount(int count) Sets the lockout failure count.
void	setLastFailTime(long now) Sets the last fail time.
void	setLockout(boolean locked) Sets the lockout status.
void	setLockoutAt(long now) Sets the lockout time.
void	setUserToken(String token) Sets the user token.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountLockoutInfo

public AccountLockoutInfo()

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.