org.apache.ftpserver.usermanager
Interface UserManagerInterface

All Known Implementing Classes:
AbstractUserManager, DbUserManager, LdapUserManager, PropertiesUserManager

public interface UserManagerInterface

This is user manager interface. All the user manager classes implement this interface. If we want to add a new user manager, we have to implement this class.

Author:
Rana Bhattacharyya

Field Summary
static String ROLE
           
 
Method Summary
 boolean authenticate(String login, String password)
          Authenticate user
 void delete(String userName)
          Delete the user from the system.
 boolean doesExist(String name)
          User existance check.
 String getAdminName()
          Get admin user name
 List getAllUserNames()
          Get all user names in the system.
 User getUserByName(String name)
          Get user by name.
 void reload()
          Load the user data again
 void save(User user)
          Save the user.
 

Field Detail

ROLE

static final String ROLE
Method Detail

save

void save(User user)
          throws Exception
Save the user. If a new user, create it else update the existing user.

Throws:
Exception

delete

void delete(String userName)
            throws Exception
Delete the user from the system.

Parameters:
name - name of the user to be deleted.
Throws:
Exception

getUserByName

User getUserByName(String name)
Get user by name.


getAllUserNames

List getAllUserNames()
Get all user names in the system.


doesExist

boolean doesExist(String name)
User existance check.

Parameters:
name - user name

authenticate

boolean authenticate(String login,
                     String password)
Authenticate user


reload

void reload()
            throws Exception
Load the user data again

Throws:
Exception

getAdminName

String getAdminName()
Get admin user name



Copyright © 2001-2012 Codehaus. All Rights Reserved.