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

["David Latorre (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FTPSERVER-181?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12633239#action_12633239 ] 

David Latorre commented on FTPSERVER-181:
-----------------------------------------

You can check the current implementations of UserManager to solve these questions so  I don't know if this should be "major priority". Anyway, If you provided better documentation Im sure   Niklas will be glad to add it.

My understanding is that you're only trying to point a deficiency in the documentation and not that you don't know the answers to those questions yourself. Otherwise, feel free to ask - the mailing list is too quiet anyway.





> 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-M4
>            Reporter: Andrea Francia
>
> 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.