|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LockOutProvider
A LockOutProvider handles storage of information about disabled accounts, and requests for whether an account is currently disabled. If set read-only, only requests for disabled status are expected to work.
Method Summary | |
---|---|
LockOutFlag |
getDisabledStatus(String username)
Returns a LockOutFlag for a given username, which contains information about the time period that the specified account is going to be disabled or null if user can log in just fine. |
boolean |
isDelayedStartSupported()
Returns true if the LockOutProvider allows for a delayed start to the lockout. |
boolean |
isReadOnly()
Returns true if this LockOutProvider is read-only. |
boolean |
isTimeoutSupported()
Returns true if the LockOutProvider allows for a timeout after which the lock out will expire. |
void |
setDisabledStatus(LockOutFlag flag)
Sets the locked out (disabled) status of an account according to a LockOutFlag. |
boolean |
shouldNotBeCached()
Returns true if the lock out flags should not be cached, meaning every status lookup will go straight to the source. |
void |
unsetDisabledStatus(String username)
Unsets the locked out (disabled) status of an account, thereby enabling it/cancelling the disable. |
Method Detail |
---|
LockOutFlag getDisabledStatus(String username)
username
- Username of account to request status of.
void setDisabledStatus(LockOutFlag flag)
flag
- A LockOutFlag instance to describe the disabled status of a user.void unsetDisabledStatus(String username)
username
- User to enable.boolean isReadOnly()
boolean isDelayedStartSupported()
boolean isTimeoutSupported()
boolean shouldNotBeCached()
|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |