|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ftpserver.usermanager.User
Generic user class. All the application specific user classes will be derived from this.
Field Summary | |
static java.lang.String |
ATTR_ENABLE
enableflag |
static java.lang.String |
ATTR_HOME
homedirectory |
static java.lang.String |
ATTR_LOGIN
uid |
static java.lang.String |
ATTR_MAX_DOWNLOAD_RATE
downloadrate |
static java.lang.String |
ATTR_MAX_IDLE_TIME
idletime |
static java.lang.String |
ATTR_MAX_UPLOAD_RATE
uploadrate |
static java.lang.String |
ATTR_PASSWORD
userpassword |
static java.lang.String |
ATTR_WRITE_PERM
writepermission |
Constructor Summary | |
User()
Constructor, set session id and default virtual directory object. |
Method Summary | |
boolean |
equals(java.lang.Object obj)
Equality check. |
java.net.InetAddress |
getClientAddress()
Get client address |
boolean |
getEnabled()
Get the user enable status. |
long |
getLastAccessTime()
Get last access time |
long |
getLoginTime()
Get user loglin time. |
int |
getMaxDownloadRate()
Get maximum user download rate in bytes/sec |
int |
getMaxIdleTime()
Get the maximum idle time in second. |
int |
getMaxUploadRate()
Get maximum user upload rate in bytes/sec. |
java.lang.String |
getName()
Get the user name. |
java.lang.String |
getPassword()
Get the user password. |
java.lang.String |
getSessionId()
Get session id. |
VirtualDirectory |
getVirtualDirectory()
get user filesystem view |
boolean |
hasLoggedIn()
Check the user login status. |
void |
hitUser()
Hit user - update last access time |
boolean |
isActive()
Is still active. |
boolean |
isActive(long currTime)
Is an active user (is removable)? Compares the last access time with the specified time. |
void |
login()
User login. |
void |
logout()
User logout |
void |
setClientAddress(java.net.InetAddress clientAddress)
Set client address |
void |
setEnabled(boolean enb)
Set the user enable status |
void |
setMaxDownloadRate(int rate)
Set user maximum download rate limit. |
void |
setMaxIdleTime(int idleSec)
Set the maximum idle time in second. |
void |
setMaxUploadRate(int rate)
Set user maximum upload rate limit. |
void |
setName(java.lang.String name)
Set user name. |
void |
setPassword(java.lang.String pass)
Set user password |
java.lang.String |
toString()
String representation |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String ATTR_LOGIN
public static final java.lang.String ATTR_PASSWORD
public static final java.lang.String ATTR_HOME
public static final java.lang.String ATTR_WRITE_PERM
public static final java.lang.String ATTR_ENABLE
public static final java.lang.String ATTR_MAX_IDLE_TIME
public static final java.lang.String ATTR_MAX_UPLOAD_RATE
public static final java.lang.String ATTR_MAX_DOWNLOAD_RATE
Constructor Detail |
public User()
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getPassword()
public void setPassword(java.lang.String pass)
public int getMaxIdleTime()
public void setMaxIdleTime(int idleSec)
public boolean getEnabled()
public void setEnabled(boolean enb)
public int getMaxUploadRate()
public void setMaxUploadRate(int rate)
public int getMaxDownloadRate()
public void setMaxDownloadRate(int rate)
public java.net.InetAddress getClientAddress()
public void setClientAddress(java.net.InetAddress clientAddress)
public VirtualDirectory getVirtualDirectory()
public java.lang.String getSessionId()
public long getLoginTime()
public long getLastAccessTime()
public boolean hasLoggedIn()
public void login()
public void logout()
public boolean isActive(long currTime)
public boolean isActive()
public void hitUser()
public boolean equals(java.lang.Object obj)
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |