|
Openfire 3.7.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.lockout.LockOutFlag
public class LockOutFlag
A LockOutFlag represents the current disabled status set on a particular user account. It can have a start and end time (a period of time in which the disabled status is active).
Constructor Summary | |
---|---|
LockOutFlag()
Constructor added for Externalizable. |
|
LockOutFlag(String username,
Date startTime,
Date endTime)
Creates a representation of a lock out flag, including which user it is attached to and an optional start and end time. |
Method Summary | |
---|---|
int |
getCachedSize()
Returns the approximate size of the Object in bytes. |
Date |
getEndTime()
Retrieves the date/time at which the account this flag references will stop having a disabled status. |
Date |
getStartTime()
Retrieves the date/time at which the account this flag references will begin having a disabled status. |
String |
getUsername()
Retrieves the username that this lock out flag is attached to. |
void |
readExternal(ObjectInput in)
|
void |
setEndTime(Date endTime)
Sets the end time for when the account will be reenabled, or null if manual reenable required. |
void |
setStartTime(Date startTime)
Sets the start time for when the account will be disabled, or null if immediate. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LockOutFlag()
public LockOutFlag(String username, Date startTime, Date endTime)
username
- User the flag is attached to.startTime
- Optional start time for the disabled status to start.endTime
- Optional end time for the disabled status to end.Method Detail |
---|
public String getUsername()
public Date getStartTime()
public void setStartTime(Date startTime)
startTime
- Date when the disabled status will start, or null for immediately.public Date getEndTime()
public void setEndTime(Date endTime)
endTime
- Date when the disabled status will end, or null for forever.public int getCachedSize()
Cacheable
getCachedSize
in interface Cacheable
public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
Openfire 3.7.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |