[findbugs] Clarify class used for resource loading

James Moger

2014-04-17 1d78b8b372f15d89f10fd32cb0227a6a7966de3c

 src/main/java/com/gitblit/manager/IAuthenticationManager.java

@@ -20,6 +20,7 @@

import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
import com.gitblit.transport.ssh.SshKey;

public interface IAuthenticationManager extends IManager {

@@ -30,8 +31,19 @@
    *
    * @param httpRequest
    * @return a user object or null
    * @since 1.4.0
    */
   UserModel authenticate(HttpServletRequest httpRequest);

   /**
    * Authenticate a user based on a ssh public key.
    *
    * @param username
    * @param key
    * @return a user object or null
*     * @since 1.5.0
    */
   UserModel authenticate(String username, SshKey key);

   /**
    * Authenticate a user based on HTTP request parameters.
@@ -42,6 +54,7 @@
    * @param httpRequest
    * @param requiresCertificate
    * @return a user object or null
    * @since 1.4.0
    */
   UserModel authenticate(HttpServletRequest httpRequest, boolean requiresCertificate);

@@ -52,14 +65,25 @@
    * @param username
    * @param password
    * @return a user object or null
    * @since 1.4.0
    */
   UserModel authenticate(String username, char[] password);

   /**
    * Returns the Gitlbit cookie in the request.
    *
    * @param request
    * @return the Gitblit cookie for the request or null if not found
    * @since 1.4.0
    */
   String getCookie(HttpServletRequest request);

   /**
    * Sets a cookie for the specified user.
    *
    * @param response
    * @param user
    * @since 1.4.0
    */
   void setCookie(HttpServletResponse response, UserModel user);

@@ -67,6 +91,7 @@
    * Logout a user.
    *
    * @param user
    * @since 1.4.0
    */
   void logout(HttpServletResponse response, UserModel user);

@@ -74,7 +99,7 @@
    * Does the user service support changes to credentials?
    *
    * @return true or false
    * @since 1.0.0
    * @since 1.4.0
    */
   boolean supportsCredentialChanges(UserModel user);

@@ -83,6 +108,7 @@
    *
    * @param user
    * @return true if the user service supports display name changes
    * @since 1.4.0
    */
   boolean supportsDisplayNameChanges(UserModel user);

@@ -91,6 +117,7 @@
    *
    * @param user
    * @return true if the user service supports email address changes
    * @since 1.4.0
    */
   boolean supportsEmailAddressChanges(UserModel user);

@@ -99,6 +126,7 @@
    *
    * @param user
    * @return true if the user service supports team membership changes
    * @since 1.4.0
    */
   boolean supportsTeamMembershipChanges(UserModel user);

@@ -107,6 +135,7 @@
    *
    * @param user
    * @return true if the team memberships can be changed
    * @since 1.4.0
    */
   boolean supportsTeamMembershipChanges(TeamModel team);