This is my proposal for UserManager javadocs.
Note: I've changed the name of some method parameter from "login" to
"username".
AFAIK login is the act of logging in a computer and the supplied
informations are *login name* and password.
I will pleased to be added to the contributor list, I've modified the
pom.xml according my expectations.
I also modified a minor things in the UserManagerTestTemplate (changed a
access modifier from public to private).
Feel free to use the patch with the terms of the Apache License Version
2.0 .
--
Andrea Francia
http://andreafrancia.blogspot.com/2008/07/colinux-linux-dentro-windows.html
Index:
core/src/test/java/org/apache/ftpserver/usermanager/UserManagerTestTemplate.java
===================================================================
---
core/src/test/java/org/apache/ftpserver/usermanager/UserManagerTestTemplate.java
(revision 701896)
+++
core/src/test/java/org/apache/ftpserver/usermanager/UserManagerTestTemplate.java
(working copy)
@@ -47,6 +47,7 @@
*
* @see junit.framework.TestCase#setUp()
*/
+ @Override
protected void setUp() throws Exception {
userManager = createUserManager();
}
@@ -86,7 +87,7 @@
.authenticate(new UsernamePasswordAuthentication("user3",
null)));
}
- public static class FooAuthentication implements Authentication {
+ private static class FooAuthentication implements Authentication {
}
public void testAuthenticateNullUser() throws Exception {
Index: ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
===================================================================
--- ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
(revision 701896)
+++ ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
(working copy)
@@ -29,48 +29,69 @@
/**
* Get user by name.
+ *
+ * @param username the name to search for.
+ * @throws FtpException when the UserManager can't fulfill the request.
+ * @return the user with the specified name, or null if a such user does
+ * not exist.
*/
- User getUserByName(String login) throws FtpException;
+ User getUserByName(String username) throws FtpException;
/**
* Get all user names in the system.
+ *
+ * @throws FtpException when the UserManager can't fulfill the request.
+ * @return an array of username strings, note that the result should never
+ * be null, if there is no users the result is an empty array.
*/
String[] getAllUserNames() throws FtpException;
/**
* Delete the user from the system.
*
+ * @throws FtpException when the UserManager can't fulfill the request.
* @throws UnsupportedOperationException
* if UserManager in read-only mode
*/
- void delete(String login) throws FtpException;
+ void delete(String username) throws FtpException;
/**
* Save user. If a new user, create it else update the existing user.
- *
+ *
+ * @param user the Uset to save
+ * @throws FtpException when the UserManager can't fulfill the request.
* @throws UnsupportedOperationException
* if UserManager in read-only mode
*/
void save(User user) throws FtpException;
/**
- * User existance check.
+ * Check if the user exists.
+ * @param username the name of the user to check.
+ * @return true if the user exist, false otherwise.
*/
- boolean doesExist(String login) throws FtpException;
+ boolean doesExist(String username) throws FtpException;
/**
* Authenticate user
+ * @throws FtpException when the UserManager can't fulfill the request.
+ * @param authentication
+ * @return the autheticated account.
*/
User authenticate(Authentication authentication)
throws AuthenticationFailedException;
/**
* Get admin user name
+ * @return the admin user name
+ * @throws FtpException when the UserManager can't fulfill the request.
*/
String getAdminName() throws FtpException;
/**
+ * Check if the user is admin.
* @return true if user with this login is administrator
+ * @throws FtpException when the UserManager can't fulfill the request.
*/
- boolean isAdmin(String login) throws FtpException;
+ boolean isAdmin(String username) throws FtpException;
}
Index: pom.xml
===================================================================
--- pom.xml (revision 701896)
+++ pom.xml (working copy)
@@ -120,6 +120,10 @@
<contributor>
<name>Nick Vincent</name>
</contributor>
+ <contributor>
+ <name>Andrea Francia</name>
+ <url>http://andreafrancia.blogspot.com</url>
+ </contributor>
</contributors>
<scm>
