org.apache.ftpserver.ftplet
Interface UserManager


public interface UserManager

User manager interface.


Method Summary
 User authenticate(Authentication authentication)
          Authenticate user
 void delete(java.lang.String login)
          Delete the user from the system.
 boolean doesExist(java.lang.String login)
          User existance check.
 java.lang.String getAdminName()
          Get admin user name
 java.lang.String[] getAllUserNames()
          Get all user names in the system.
 User getUserByName(java.lang.String login)
          Get user by name.
 boolean isAdmin(java.lang.String login)
           
 void save(User user)
          Save user.
 

Method Detail

getUserByName

User getUserByName(java.lang.String login)
                   throws FtpException
Get user by name.

Throws:
FtpException

getAllUserNames

java.lang.String[] getAllUserNames()
                                   throws FtpException
Get all user names in the system.

Throws:
FtpException

delete

void delete(java.lang.String login)
            throws FtpException
Delete the user from the system.

Throws:
java.lang.UnsupportedOperationException - if UserManager in read-only mode
FtpException

save

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

Throws:
java.lang.UnsupportedOperationException - if UserManager in read-only mode
FtpException

doesExist

boolean doesExist(java.lang.String login)
                  throws FtpException
User existance check.

Throws:
FtpException

authenticate

User authenticate(Authentication authentication)
                  throws AuthenticationFailedException
Authenticate user

Throws:
AuthenticationFailedException

getAdminName

java.lang.String getAdminName()
                              throws FtpException
Get admin user name

Throws:
FtpException

isAdmin

boolean isAdmin(java.lang.String login)
                throws FtpException
Returns:
true if user with this login is administrator
Throws:
FtpException


Copyright © 2003-2008 The Apache Software Foundation. All Rights Reserved.