[jira] Closed: (FTPSERVER-181) The UserManager#authenticate() method lacks of documentation

["Niklas Gustavsson (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/FTPSERVER-181?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Niklas Gustavsson closed FTPSERVER-181.
---------------------------------------

    Resolution: Fixed
      Assignee: Niklas Gustavsson

Patch applied

 svn -m "Improved UserManager JavaDoc. Patch by Andrea Francia (FTPSERVER-181)" commit
Sending        core/src/test/java/org/apache/ftpserver/usermanager/UserManagerTestTemplate.java
Sending        ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
Sending        pom.xml
Transmitting file data ...
Committed revision 702282.


> The UserManager#authenticate() method lacks of documentation
> ------------------------------------------------------------
>
>                 Key: FTPSERVER-181
>                 URL: https://issues.apache.org/jira/browse/FTPSERVER-181
>             Project: FtpServer
>          Issue Type: Bug
>          Components: Ftplets
>    Affects Versions: 1.0-M3
>            Reporter: Andrea Francia
>            Assignee: Niklas Gustavsson
>             Fix For: 1.0-M4
>
>
> The UserManager interface documentation should be a form of contract between the implementor and the user of the interface.
> After reading the documentation the implementor still has these question:
>  - when I should throw a AuthenticationFailedException?
>  - when I should return a null as a result?
>  - if the object receive two subsequent calls withe the same arguments the objects returned should be the same (same reference), only equals, or they can be different?

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.