jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/UnixLoginModule.java
changeset 30044 bab15bbe2ca3
parent 25859 3317bb8137f4
child 34894 3248b89d1921
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/UnixLoginModule.java	Tue Apr 28 11:10:45 2015 -0700
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/UnixLoginModule.java	Wed Apr 29 17:29:14 2015 +0400
@@ -36,11 +36,11 @@
 import com.sun.security.auth.UnixNumericGroupPrincipal;
 
 /**
- * <p> This <code>LoginModule</code> imports a user's Unix
- * <code>Principal</code> information (<code>UnixPrincipal</code>,
- * <code>UnixNumericUserPrincipal</code>,
- * and <code>UnixNumericGroupPrincipal</code>)
- * and associates them with the current <code>Subject</code>.
+ * This {@code LoginModule} imports a user's Unix
+ * {@code Principal} information ({@code UnixPrincipal},
+ * {@code UnixNumericUserPrincipal},
+ * and {@code UnixNumericGroupPrincipal})
+ * and associates them with the current {@code Subject}.
  *
  * <p> This LoginModule recognizes the debug option.
  * If set to true in the login Configuration,
@@ -74,21 +74,19 @@
                 new LinkedList<>();
 
     /**
-     * Initialize this <code>LoginModule</code>.
+     * Initialize this {@code LoginModule}.
      *
-     * <p>
-     *
-     * @param subject the <code>Subject</code> to be authenticated. <p>
+     * @param subject the {@code Subject} to be authenticated.
      *
-     * @param callbackHandler a <code>CallbackHandler</code> for communicating
+     * @param callbackHandler a {@code CallbackHandler} for communicating
      *                  with the end user (prompting for usernames and
-     *                  passwords, for example). <p>
+     *                  passwords, for example).
      *
-     * @param sharedState shared <code>LoginModule</code> state. <p>
+     * @param sharedState shared {@code LoginModule} state.
      *
      * @param options options specified in the login
-     *                  <code>Configuration</code> for this particular
-     *                  <code>LoginModule</code>.
+     *                  {@code Configuration} for this particular
+     *                  {@code LoginModule}.
      */
     public void initialize(Subject subject, CallbackHandler callbackHandler,
                            Map<String,?> sharedState,
@@ -107,15 +105,13 @@
      * Authenticate the user (first phase).
      *
      * <p> The implementation of this method attempts to retrieve the user's
-     * Unix <code>Subject</code> information by making a native Unix
+     * Unix {@code Subject} information by making a native Unix
      * system call.
      *
-     * <p>
-     *
      * @exception FailedLoginException if attempts to retrieve the underlying
      *          system information fail.
      *
-     * @return true in all cases (this <code>LoginModule</code>
+     * @return true in all cases (this {@code LoginModule}
      *          should not be ignored).
      */
     public boolean login() throws LoginException {
@@ -169,13 +165,11 @@
      * <p> If this LoginModule's own authentication attempt
      * succeeded (the importing of the Unix authentication information
      * succeeded), then this method associates the Unix Principals
-     * with the <code>Subject</code> currently tied to the
-     * <code>LoginModule</code>.  If this LoginModule's
+     * with the {@code Subject} currently tied to the
+     * {@code LoginModule}.  If this LoginModule's
      * authentication attempted failed, then this method removes
      * any state that was originally saved.
      *
-     * <p>
-     *
      * @exception LoginException if the commit fails
      *
      * @return true if this LoginModule's own login and commit attempts
@@ -228,10 +222,8 @@
      * did not succeed).
      *
      * <p> This method cleans up any state that was originally saved
-     * as part of the authentication attempt from the <code>login</code>
-     * and <code>commit</code> methods.
-     *
-     * <p>
+     * as part of the authentication attempt from the {@code login}
+     * and {@code commit} methods.
      *
      * @exception LoginException if the abort fails
      *
@@ -267,13 +259,11 @@
      * Logout the user
      *
      * <p> This method removes the Principals associated
-     * with the <code>Subject</code>.
-     *
-     * <p>
+     * with the {@code Subject}.
      *
      * @exception LoginException if the logout fails
      *
-     * @return true in all cases (this <code>LoginModule</code>
+     * @return true in all cases (this {@code LoginModule}
      *          should not be ignored).
      */
     public boolean logout() throws LoginException {