org.apache.ftpserver.usermanager.impl

Class DbUserManager

java.lang.Object

org.apache.ftpserver.usermanager.impl.AbstractUserManager

org.apache.ftpserver.usermanager.impl.DbUserManager

All Implemented Interfaces:

UserManager

public class DbUserManager
extends AbstractUserManager

Internal class, do not use directly. This is another database based user manager class. It has been tested in MySQL and Oracle 8i database. The schema file is res/ftp-db.sql All the user attributes are replaced during run-time. So we can use your database schema. Then you need to modify the SQLs in the configuration file.

Author:

Apache MINA Project

Field Summary

Fields inherited from class org.apache.ftpserver.usermanager.impl.AbstractUserManager

ATTR_ENABLE, ATTR_HOME, ATTR_LOGIN, ATTR_MAX_DOWNLOAD_RATE, ATTR_MAX_IDLE_TIME, ATTR_MAX_LOGIN_NUMBER, ATTR_MAX_LOGIN_PER_IP, ATTR_MAX_UPLOAD_RATE, ATTR_PASSWORD, ATTR_WRITE_PERM

Constructor Summary

Constructors

Constructor and Description
DbUserManager(DataSource dataSource, String selectAllStmt, String selectUserStmt, String insertUserStmt, String updateUserStmt, String deleteUserStmt, String authenticateStmt, String isAdminStmt, PasswordEncryptor passwordEncryptor, String adminName) Internal constructor, do not use directly.

Method Summary

Modifier and Type	Method and Description
User	authenticate(Authentication authentication) User authentication.
protected void	closeQuitely(Connection con)
protected Connection	createConnection() Open connection to database.
void	delete(String name) Delete user.
boolean	doesExist(String name) User existance check.
String[]	getAllUserNames() Get all user names from the database.
DataSource	getDataSource() Retrive the data source used by the user manager
String	getSqlUserAdmin() Get the SQL SELECT statement used to find whether an user is admin or not.
String	getSqlUserAuthenticate() Get the SQL SELECT statement used to authenticate user.
String	getSqlUserDelete() Get the SQL DELETE statement used to delete an existing user.
String	getSqlUserInsert() Get the SQL INSERT statement used to add a new user.
String	getSqlUserSelect() Get the SQL SELECT statement used to select an existing user.
String	getSqlUserSelectAll() Get the SQL SELECT statement used to select all user ids.
String	getSqlUserUpdate() Get the SQL UPDATE statement used to update an existing user.
User	getUserByName(String name) Get the user object.
boolean	isAdmin(String login) Check if the user is admin.
void	save(User user) Save user.
void	setDataSource(DataSource dataSource) Set the data source to be used by the user manager
void	setSqlUserAdmin(String sql) Set the SQL SELECT statement used to find whether an user is admin or not.
void	setSqlUserAuthenticate(String sql) Set the SQL SELECT statement used to authenticate user.
void	setSqlUserDelete(String sql) Set the SQL DELETE statement used to delete an existing user.
void	setSqlUserInsert(String sql) Set the SQL INSERT statement used to add a new user.
void	setSqlUserSelect(String sql) Set the SQL SELECT statement used to select an existing user.
void	setSqlUserSelectAll(String sql) Set the SQL SELECT statement used to select all user ids.
void	setSqlUserUpdate(String sql) Set the SQL UPDATE statement used to update an existing user.

Methods inherited from class org.apache.ftpserver.usermanager.impl.AbstractUserManager

getAdminName, getPasswordEncryptor

Methods inherited from class java.lang.Object

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

Constructor Detail

DbUserManager

public DbUserManager(DataSource dataSource,
                     String selectAllStmt,
                     String selectUserStmt,
                     String insertUserStmt,
                     String updateUserStmt,
                     String deleteUserStmt,
                     String authenticateStmt,
                     String isAdminStmt,
                     PasswordEncryptor passwordEncryptor,
                     String adminName)

Internal constructor, do not use directly. Use DbUserManagerFactory instead.

Method Detail

getDataSource

public DataSource getDataSource()

Retrive the data source used by the user manager

Returns:

The current data source

setDataSource

public void setDataSource(DataSource dataSource)

Set the data source to be used by the user manager

Parameters:

dataSource - The data source to use

getSqlUserInsert

public String getSqlUserInsert()

Get the SQL INSERT statement used to add a new user.

Returns:

The SQL statement

setSqlUserInsert

public void setSqlUserInsert(String sql)

Set the SQL INSERT statement used to add a new user. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserDelete

public String getSqlUserDelete()

Get the SQL DELETE statement used to delete an existing user.

Returns:

The SQL statement

setSqlUserDelete

public void setSqlUserDelete(String sql)

Set the SQL DELETE statement used to delete an existing user. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserUpdate

public String getSqlUserUpdate()

Get the SQL UPDATE statement used to update an existing user.

Returns:

The SQL statement

setSqlUserUpdate

public void setSqlUserUpdate(String sql)

Set the SQL UPDATE statement used to update an existing user. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserSelect

public String getSqlUserSelect()

Get the SQL SELECT statement used to select an existing user.

Returns:

The SQL statement

setSqlUserSelect

public void setSqlUserSelect(String sql)

Set the SQL SELECT statement used to select an existing user. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserSelectAll

public String getSqlUserSelectAll()

Get the SQL SELECT statement used to select all user ids.

Returns:

The SQL statement

setSqlUserSelectAll

public void setSqlUserSelectAll(String sql)

Set the SQL SELECT statement used to select all user ids. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserAuthenticate

public String getSqlUserAuthenticate()

Get the SQL SELECT statement used to authenticate user.

Returns:

The SQL statement

setSqlUserAuthenticate

public void setSqlUserAuthenticate(String sql)

Set the SQL SELECT statement used to authenticate user. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

getSqlUserAdmin

public String getSqlUserAdmin()

Get the SQL SELECT statement used to find whether an user is admin or not.

Returns:

The SQL statement

setSqlUserAdmin

public void setSqlUserAdmin(String sql)

Set the SQL SELECT statement used to find whether an user is admin or not. All the dynamic values will be replaced during runtime.

Parameters:

sql - The SQL statement

isAdmin

public boolean isAdmin(String login)
                throws FtpException

Description copied from interface: UserManager

Check if the user is admin.

Specified by:

isAdmin in interface UserManager

Overrides:

isAdmin in class AbstractUserManager

Parameters:

login - The name of the User to check

Returns:

true if user with this login is administrator

Throws:

FtpException - when the UserManager can't fulfill the request.

createConnection

protected Connection createConnection()
                               throws SQLException

Open connection to database.

Throws:

SQLException

delete

public void delete(String name)
            throws FtpException

Delete user. Delete the row from the table.

Parameters:

name - The name of the User to delete

Throws:

FtpException - when the UserManager can't fulfill the request.

save

public void save(User user)
          throws FtpException

Save user. If new insert a new row, else update the existing row.

Parameters:

user - the Uset to save

Throws:

FtpException - when the UserManager can't fulfill the request.

closeQuitely

protected void closeQuitely(Connection con)

getUserByName

public User getUserByName(String name)
                   throws FtpException

Get the user object. Fetch the row from the table.

Parameters:

name - the name to search for.

Returns:

the user with the specified name, or null if a such user does not exist.

Throws:

FtpException - when the UserManager can't fulfill the request.

doesExist

public boolean doesExist(String name)
                  throws FtpException

User existance check.

Parameters:

name - the name of the user to check.

Returns:

true if the user exist, false otherwise.

Throws:

FtpException

getAllUserNames

public String[] getAllUserNames()
                         throws FtpException

Get all user names from the database.

Returns:

an array of username strings, note that the result should never be null, if there is no users the result is an empty array.

Throws:

FtpException - when the UserManager can't fulfill the request.

authenticate

public User authenticate(Authentication authentication)
                  throws AuthenticationFailedException

User authentication.

Parameters:

authentication - The Authentication that proves the users identity

Returns:

the authenticated account.

Throws:

AuthenticationFailedException