org.vfsutils.ftpserver.usermanager

Class VfsUserManager

java.lang.Object

org.vfsutils.ftpserver.usermanager.UserProps

org.vfsutils.ftpserver.usermanager.VfsUserManager

All Implemented Interfaces:

org.apache.ftpserver.ftplet.UserManager

public class VfsUserManager
extends UserProps
implements org.apache.ftpserver.ftplet.UserManager

Apache VFS implementation of the UserManager. There is no information available about a user before authentication. The provider of the underlying file system and the type (normal, virtual or layered) can be configured as well as the path to the home directory of the user. For the authentication a domain can be specified in the configuration since the VFS framework allows it, but the information is not provided by the FTP interface.

Author:

kleij - at - users.sourceforge.net

Field Summary

Fields

Modifier and Type	Field and Description
protected UserProps	admin
protected String	adminName
protected String	anonymousName
protected String	anonymousPwd
protected VfsAuthenticator	authenticator
protected String	vfsHomePath

Fields inherited from class org.vfsutils.ftpserver.usermanager.UserProps

downloadRate, maxIdleTime, maxLogin, maxLoginPerIp, uploadRate, writePermission

Constructor Summary

Constructors

Constructor and Description
VfsUserManager()

Method Summary

Modifier and Type	Method and Description
org.apache.ftpserver.ftplet.User	authenticate(org.apache.ftpserver.ftplet.Authentication authentication)
void	delete(String login)
boolean	doesExist(String login) There is no way of knowing if a user exists until authentication is done.
UserProps	getAdmin()
String	getAdminName()
String[]	getAllUserNames()
String	getAnonymousName()
String	getAnonymousPwd()
VfsAuthenticator	getAuthenticator()
org.apache.ftpserver.ftplet.User	getUserByName(String login)
String	getVfsHomePath() The home path is the path to the home directory of the user.
boolean	isAdmin(String login)
void	save(org.apache.ftpserver.ftplet.User user)
void	setAdmin(UserProps admin)
void	setAdminName(String adminName)
void	setAnonymousName(String anonymousName)
void	setAnonymousPwd(String anonymousPwd)
void	setAuthenticator(VfsAuthenticator authenticator)
void	setVfsHomePath(String vfsHomePath) Sets the home path of the user.

Methods inherited from class org.vfsutils.ftpserver.usermanager.UserProps

getDownloadRate, getMaxIdleTime, getMaxLogin, getMaxLoginPerIp, getUploadRate, isWritePermission, setDownloadRate, setMaxIdleTime, setMaxLogin, setMaxLoginPerIp, setUploadRate, setWritePermission

Methods inherited from class java.lang.Object

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

Field Detail

vfsHomePath

protected String vfsHomePath

authenticator

protected VfsAuthenticator authenticator

adminName

protected String adminName

anonymousName

protected String anonymousName

anonymousPwd

protected String anonymousPwd

admin

protected UserProps admin

Constructor Detail

VfsUserManager

public VfsUserManager()

Method Detail

getVfsHomePath

public String getVfsHomePath()

The home path is the path to the home directory of the user. It can be relative to the root or absolute. Note that path can contain the ${user} variable which will be resolved dynamically. The home path defaults to ${user}.

Returns:

The home path

setVfsHomePath

public void setVfsHomePath(String vfsHomePath)

Sets the home path of the user. It can be relative to the root or absolute and can contain the ${user} variable.

Parameters:

vfsHomePath -

getAuthenticator

public VfsAuthenticator getAuthenticator()

setAuthenticator

public void setAuthenticator(VfsAuthenticator authenticator)

getAdminName

public String getAdminName()

Specified by:

getAdminName in interface org.apache.ftpserver.ftplet.UserManager

setAdminName

public void setAdminName(String adminName)

getAnonymousName

public String getAnonymousName()

setAnonymousName

public void setAnonymousName(String anonymousName)

getAnonymousPwd

public String getAnonymousPwd()

setAnonymousPwd

public void setAnonymousPwd(String anonymousPwd)

getAdmin

public UserProps getAdmin()

setAdmin

public void setAdmin(UserProps admin)

authenticate

public org.apache.ftpserver.ftplet.User authenticate(org.apache.ftpserver.ftplet.Authentication authentication)
                                              throws org.apache.ftpserver.ftplet.AuthenticationFailedException

Specified by:

authenticate in interface org.apache.ftpserver.ftplet.UserManager

Throws:

org.apache.ftpserver.ftplet.AuthenticationFailedException

delete

public void delete(String login)
            throws org.apache.ftpserver.ftplet.FtpException

Specified by:

delete in interface org.apache.ftpserver.ftplet.UserManager

Throws:

org.apache.ftpserver.ftplet.FtpException

doesExist

public boolean doesExist(String login)

There is no way of knowing if a user exists until authentication is done. Therefore this method will always return true.

Specified by:

doesExist in interface org.apache.ftpserver.ftplet.UserManager

getAllUserNames

public String[] getAllUserNames()
                         throws org.apache.ftpserver.ftplet.FtpException

Specified by:

getAllUserNames in interface org.apache.ftpserver.ftplet.UserManager

Throws:

org.apache.ftpserver.ftplet.FtpException

getUserByName

public org.apache.ftpserver.ftplet.User getUserByName(String login)

Specified by:

getUserByName in interface org.apache.ftpserver.ftplet.UserManager

isAdmin

public boolean isAdmin(String login)

Specified by:

isAdmin in interface org.apache.ftpserver.ftplet.UserManager

save

public void save(org.apache.ftpserver.ftplet.User user)
          throws org.apache.ftpserver.ftplet.FtpException

Specified by:

save in interface org.apache.ftpserver.ftplet.UserManager

Throws:

org.apache.ftpserver.ftplet.FtpException