Commits

Sebastian Sdorra committed f059342

javadoc for Tokens class

Comments (0)

Files changed (1)

scm-core/src/main/java/sonia/scm/security/Tokens.java

 
 import org.apache.shiro.authc.AuthenticationToken;
 import org.apache.shiro.authc.UsernamePasswordToken;
+import org.apache.shiro.subject.Subject;
 
 //~--- JDK imports ------------------------------------------------------------
 
 import javax.servlet.http.HttpServletRequest;
 
 /**
+ * Create tokens for security reasons.
  *
  * @author Sebastian Sdorra
  * @since 1.21
 {
 
   /**
-   * Method description
+   * Build an {@link AuthenticationToken} for use with
+   * {@link Subject#login(org.apache.shiro.authc.AuthenticationToken)}.
    *
    *
-   * @param request
-   * @param username
-   * @param password
+   * @param request servlet request
+   * @param username username of the user to authenticate
+   * @param password password of the user to authenticate
    *
    * @return
    */