- * The java.lang.System property java.security.auth.policy
- * may also be set to a URL pointing to another policy file
+ * The {@code java.lang.System} property java.security.auth.policy
+ * may also be set to a {@code URL} pointing to another policy file
* (which is the case when a user uses the -D switch at runtime).
* If this property is defined, and its use is allowed by the
* security property file (the Security property,
@@ -83,35 +83,35 @@ import javax.security.auth.Subject;
* doesn't matter and some are optional, as noted below).
* Italicized items represent variable values.
*
- * A grant entry must begin with the word grant.
- * The signedBy and codeBase
+ *
A grant entry must begin with the word {@code grant}.
+ * The {@code signedBy} and {@code codeBase}
* name/value pairs are optional.
* If they are not present, then any signer (including unsigned code)
* will match, and any codeBase will match. Note that the
- * principal name/value pair is not optional.
- * This Policy implementation only permits
+ * {@code principal} name/value pair is not optional.
+ * This {@code Policy} implementation only permits
* Principal-based grant entries. Note that the principalClass
* may be set to the wildcard value, *, which allows it to match
- * any Principal class. In addition, the principalName
+ * any {@code Principal} class. In addition, the principalName
* may also be set to the wildcard value, *, allowing it to match
- * any Principal name. When setting the principalName
+ * any {@code Principal} name. When setting the principalName
* to the *, do not surround the * with quotes.
*
- *
A permission entry must begin with the word permission.
- * The word Type in the template above is
- * a specific permission type, such as java.io.FilePermission
- * or java.lang.RuntimePermission.
+ *
A permission entry must begin with the word {@code permission}.
+ * The word {@code Type} in the template above is
+ * a specific permission type, such as {@code java.io.FilePermission}
+ * or {@code java.lang.RuntimePermission}.
*
*
The "action" is required for
- * many permission types, such as java.io.FilePermission
+ * many permission types, such as {@code java.io.FilePermission}
* (where it specifies what type of file access that is permitted).
* It is not required for categories such as
- * java.lang.RuntimePermission
+ * {@code java.lang.RuntimePermission}
* where it is not necessary - you either have the
- * permission specified by the "name"
+ * permission specified by the "{@code name}"
* value following the type name or you don't.
*
- *
The signedBy name/value pair for a permission entry
+ *
The {@code signedBy} name/value pair for a permission entry
* is optional. If present, it indicates a signed permission. That is,
* the permission class itself must be signed by the given alias in
* order for it to be granted. For example,
@@ -124,18 +124,18 @@ import javax.security.auth.Subject;
*
*
*
Then this permission of type Foo is granted if the
- * Foo.class permission has been signed by the
- * "FooSoft" alias, or if Foo.class is a
+ * {@code Foo.class} permission has been signed by the
+ * "FooSoft" alias, or if {@code Foo.class} is a
* system class (i.e., is found on the CLASSPATH).
*
*
Items that appear in an entry must appear in the specified order
- * (permission, Type, "name", and
+ * ({@code permission}, Type, "name", and
* "action"). An entry is terminated with a semicolon.
*
- *
Case is unimportant for the identifiers (permission,
- * signedBy, codeBase, etc.) but is
+ *
Case is unimportant for the identifiers ({@code permission},
+ * {@code signedBy}, {@code codeBase}, etc.) but is
* significant for the Type
- * or for any string that is passed in as a value.
+ * or for any string that is passed in as a value.
*
*
An example of two entries in a policy configuration file is
*
@@ -153,15 +153,15 @@ import javax.security.auth.Subject;
* permission java.util.PropertyPermission "java.vendor";
*
*
- * This Policy implementation supports
+ *
This {@code Policy} implementation supports
* special handling for PrivateCredentialPermissions.
* If a grant entry is configured with a
- * PrivateCredentialPermission,
+ * {@code PrivateCredentialPermission},
* and the "Principal Class/Principal Name" for that
- * PrivateCredentialPermission is "self",
- * then the entry grants the specified Subject permission to
+ * {@code PrivateCredentialPermission} is "self",
+ * then the entry grants the specified {@code Subject} permission to
* access its own private Credential. For example,
- * the following grants the Subject "Duke"
+ * the following grants the {@code Subject} "Duke"
* access to its own a.b.Credential.
*
*
@@ -172,7 +172,7 @@ import javax.security.auth.Subject;
* };
*
*
- * The following grants the Subject "Duke"
+ * The following grants the {@code Subject} "Duke"
* access to all of its own private Credentials:
*
*
@@ -184,7 +184,7 @@ import javax.security.auth.Subject;
*
*
* The following grants all Subjects authenticated as a
- * SolarisPrincipal (regardless of their respective names)
+ * {@code SolarisPrincipal} (regardless of their respective names)
* permission to access their own private Credentials:
*
*
@@ -207,7 +207,7 @@ import javax.security.auth.Subject;
*
* @deprecated As of JDK 1.4, replaced by
- * sun.security.provider.PolicyFile.
+ * {@code sun.security.provider.PolicyFile}.
* This class is entirely deprecated.
*
* @see java.security.CodeSource
@@ -232,10 +232,8 @@ public class PolicyFile extends javax.security.auth.Policy {
/**
* Refreshes the policy object by re-reading all the policy files.
*
- *
- *
* @exception SecurityException if the caller doesn't have permission
- * to refresh the Policy.
+ * to refresh the {@code Policy}.
*/
@Override
public void refresh() {
@@ -243,59 +241,56 @@ public class PolicyFile extends javax.security.auth.Policy {
}
/**
- * Examines this Policy and returns the Permissions granted
- * to the specified Subject and CodeSource.
+ * Examines this {@code Policy} and returns the Permissions granted
+ * to the specified {@code Subject} and {@code CodeSource}.
*
*
Permissions for a particular grant entry are returned
- * if the CodeSource constructed using the codebase and
- * signedby values specified in the entry implies
- * the CodeSource provided to this method, and if the
- * Subject provided to this method contains all of the
+ * if the {@code CodeSource} constructed using the codebase and
+ * signedby values specified in the entry {@code implies}
+ * the {@code CodeSource} provided to this method, and if the
+ * {@code Subject} provided to this method contains all of the
* Principals specified in the entry.
*
- *
The Subject provided to this method contains all
+ *
The {@code Subject} provided to this method contains all
* of the Principals specified in the entry if, for each
- * Principal, "P1", specified in the grant entry
+ * {@code Principal}, "P1", specified in the grant entry
* one of the following two conditions is met:
*
- *
*
- * - the
Subject has a
- * Principal, "P2", where
- * P2.getClass().getName() equals the
+ * - the {@code Subject} has a
+ * {@code Principal}, "P2", where
+ * {@code P2.getClass().getName()} equals the
* P1's class name, and where
- *
P2.getName() equals the P1's name.
+ * {@code P2.getName()} equals the P1's name.
*
* - P1 implements
- *
com.sun.security.auth.PrincipalComparator,
- * and P1.implies the provided Subject.
+ * {@code com.sun.security.auth.PrincipalComparator},
+ * and {@code P1.implies} the provided {@code Subject}.
*
*
- * Note that this Policy implementation has
+ *
Note that this {@code Policy} implementation has
* special handling for PrivateCredentialPermissions.
- * When this method encounters a PrivateCredentialPermission
- * which specifies "self" as the Principal class and name,
- * it does not add that Permission to the returned
- * PermissionCollection. Instead, it builds
- * a new PrivateCredentialPermission
- * for each Principal associated with the provided
- * Subject. Each new PrivateCredentialPermission
+ * When this method encounters a {@code PrivateCredentialPermission}
+ * which specifies "self" as the {@code Principal} class and name,
+ * it does not add that {@code Permission} to the returned
+ * {@code PermissionCollection}. Instead, it builds
+ * a new {@code PrivateCredentialPermission}
+ * for each {@code Principal} associated with the provided
+ * {@code Subject}. Each new {@code PrivateCredentialPermission}
* contains the same Credential class as specified in the
* originally granted permission, as well as the Class and name
- * for the respective Principal.
+ * for the respective {@code Principal}.
*
- *
- *
- * @param subject the Permissions granted to this Subject
- * and the additionally provided CodeSource
- * are returned.
- *
- * @param codesource the Permissions granted to this CodeSource
- * and the additionally provided Subject
+ * @param subject the Permissions granted to this {@code Subject}
+ * and the additionally provided {@code CodeSource}
* are returned.
*
- * @return the Permissions granted to the provided Subject
- * CodeSource.
+ * @param codesource the Permissions granted to this {@code CodeSource}
+ * and the additionally provided {@code Subject}
+ * are returned.
+ *
+ * @return the Permissions granted to the provided {@code Subject}
+ * {@code CodeSource}.
*/
@Override
public PermissionCollection getPermissions(final Subject subject,
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/PrincipalComparator.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/PrincipalComparator.java
index 8d8e12424a5..bb0aab1f2f2 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/PrincipalComparator.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/PrincipalComparator.java
@@ -26,25 +26,25 @@
package com.sun.security.auth;
/**
- * An object that implements the java.security.Principal
+ * An object that implements the {@code java.security.Principal}
* interface typically also implements this interface to provide
- * a means for comparing that object to a specified Subject.
+ * a means for comparing that object to a specified {@code Subject}.
*
- *
The comparison is achieved via the implies method.
- * The implementation of the implies method determines
- * whether this object "implies" the specified Subject.
+ *
The comparison is achieved via the {@code implies} method.
+ * The implementation of the {@code implies} method determines
+ * whether this object "implies" the specified {@code Subject}.
* One example application of this method may be for
- * a "group" object to imply a particular Subject
- * if that Subject belongs to the group.
+ * a "group" object to imply a particular {@code Subject}
+ * if that {@code Subject} belongs to the group.
* Another example application of this method would be for
- * "role" object to imply a particular Subject
- * if that Subject is currently acting in that role.
+ * "role" object to imply a particular {@code Subject}
+ * if that {@code Subject} is currently acting in that role.
*
*
Although classes that implement this interface typically
- * also implement the java.security.Principal interface,
+ * also implement the {@code java.security.Principal} interface,
* it is not required. In other words, classes may implement the
- * java.security.Principal interface by itself,
- * the PrincipalComparator interface by itself,
+ * {@code java.security.Principal} interface by itself,
+ * the {@code PrincipalComparator} interface by itself,
* or both at the same time.
*
* @see java.security.Principal
@@ -53,12 +53,10 @@ package com.sun.security.auth;
@jdk.Exported
public interface PrincipalComparator {
/**
- * Check if the specified Subject is implied by
+ * Check if the specified {@code Subject} is implied by
* this object.
*
- *
- *
- * @return true if the specified Subject is implied by
+ * @return true if the specified {@code Subject} is implied by
* this object, or false otherwise.
*/
boolean implies(javax.security.auth.Subject subject);
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericGroupPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericGroupPrincipal.java
index 27e77307703..377e6165fcd 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericGroupPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericGroupPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a user's Solaris group identification number (GID).
*
- *
Principals such as this SolarisNumericGroupPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code SolarisNumericGroupPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
* @deprecated As of JDK 1.4, replaced by
* {@link UnixNumericGroupPrincipal}.
@@ -73,20 +73,18 @@ public class SolarisNumericGroupPrincipal implements
private boolean primaryGroup;
/**
- * Create a SolarisNumericGroupPrincipal using a
- * String representation of the user's
+ * Create a {@code SolarisNumericGroupPrincipal} using a
+ * {@code String} representation of the user's
* group identification number (GID).
*
- *
- *
* @param name the user's group identification number (GID)
- * for this user.
+ * for this user.
*
* @param primaryGroup true if the specified GID represents the
* primary group to which this user belongs.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public SolarisNumericGroupPrincipal(String name, boolean primaryGroup) {
if (name == null)
@@ -97,13 +95,11 @@ public class SolarisNumericGroupPrincipal implements
}
/**
- * Create a SolarisNumericGroupPrincipal using a
+ * Create a {@code SolarisNumericGroupPrincipal} using a
* long representation of the user's group identification number (GID).
*
- *
- *
* @param name the user's group identification number (GID) for this user
- * represented as a long.
+ * represented as a long.
*
* @param primaryGroup true if the specified GID represents the
* primary group to which this user belongs.
@@ -116,12 +112,10 @@ public class SolarisNumericGroupPrincipal implements
/**
* Return the user's group identification number (GID) for this
- * SolarisNumericGroupPrincipal.
- *
- *
+ * {@code SolarisNumericGroupPrincipal}.
*
* @return the user's group identification number (GID) for this
- * SolarisNumericGroupPrincipal
+ * {@code SolarisNumericGroupPrincipal}
*/
public String getName() {
return name;
@@ -129,12 +123,10 @@ public class SolarisNumericGroupPrincipal implements
/**
* Return the user's group identification number (GID) for this
- * SolarisNumericGroupPrincipal as a long.
- *
- *
+ * {@code SolarisNumericGroupPrincipal} as a long.
*
* @return the user's group identification number (GID) for this
- * SolarisNumericGroupPrincipal as a long.
+ * {@code SolarisNumericGroupPrincipal} as a long.
*/
public long longValue() {
return Long.parseLong(name);
@@ -144,8 +136,6 @@ public class SolarisNumericGroupPrincipal implements
* Return whether this group identification number (GID) represents
* the primary group to which this user belongs.
*
- *
- *
* @return true if this group identification number (GID) represents
* the primary group to which this user belongs,
* or false otherwise.
@@ -156,12 +146,10 @@ public class SolarisNumericGroupPrincipal implements
/**
* Return a string representation of this
- * SolarisNumericGroupPrincipal.
- *
- *
+ * {@code SolarisNumericGroupPrincipal}.
*
* @return a string representation of this
- * SolarisNumericGroupPrincipal.
+ * {@code SolarisNumericGroupPrincipal}.
*/
public String toString() {
return((primaryGroup ?
@@ -173,19 +161,17 @@ public class SolarisNumericGroupPrincipal implements
/**
* Compares the specified Object with this
- * SolarisNumericGroupPrincipal
+ * {@code SolarisNumericGroupPrincipal}
* for equality. Returns true if the given object is also a
- * SolarisNumericGroupPrincipal and the two
+ * {@code SolarisNumericGroupPrincipal} and the two
* SolarisNumericGroupPrincipals
* have the same group identification number (GID).
*
- *
- *
* @param o Object to be compared for equality with this
- * SolarisNumericGroupPrincipal.
+ * {@code SolarisNumericGroupPrincipal}.
*
* @return true if the specified Object is equal to this
- * SolarisNumericGroupPrincipal.
+ * {@code SolarisNumericGroupPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -205,11 +191,9 @@ public class SolarisNumericGroupPrincipal implements
}
/**
- * Return a hash code for this SolarisNumericGroupPrincipal.
+ * Return a hash code for this {@code SolarisNumericGroupPrincipal}.
*
- *
- *
- * @return a hash code for this SolarisNumericGroupPrincipal.
+ * @return a hash code for this {@code SolarisNumericGroupPrincipal}.
*/
public int hashCode() {
return toString().hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericUserPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericUserPrincipal.java
index 0369a7830f6..5497856f28a 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericUserPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisNumericUserPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a user's Solaris identification number (UID).
*
- *
Principals such as this SolarisNumericUserPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code SolarisNumericUserPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
* @deprecated As of JDK 1.4, replaced by
* {@link UnixNumericUserPrincipal}.
* This class is entirely deprecated.
@@ -68,16 +68,14 @@ public class SolarisNumericUserPrincipal implements
private String name;
/**
- * Create a SolarisNumericUserPrincipal using a
- * String representation of the
+ * Create a {@code SolarisNumericUserPrincipal} using a
+ * {@code String} representation of the
* user's identification number (UID).
*
- *
- *
* @param name the user identification number (UID) for this user.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public SolarisNumericUserPrincipal(String name) {
if (name == null)
@@ -87,11 +85,9 @@ public class SolarisNumericUserPrincipal implements
}
/**
- * Create a SolarisNumericUserPrincipal using a
+ * Create a {@code SolarisNumericUserPrincipal} using a
* long representation of the user's identification number (UID).
*
- *
- *
* @param name the user identification number (UID) for this user
* represented as a long.
*/
@@ -101,12 +97,10 @@ public class SolarisNumericUserPrincipal implements
/**
* Return the user identification number (UID) for this
- * SolarisNumericUserPrincipal.
- *
- *
+ * {@code SolarisNumericUserPrincipal}.
*
* @return the user identification number (UID) for this
- * SolarisNumericUserPrincipal
+ * {@code SolarisNumericUserPrincipal}
*/
public String getName() {
return name;
@@ -114,12 +108,10 @@ public class SolarisNumericUserPrincipal implements
/**
* Return the user identification number (UID) for this
- * SolarisNumericUserPrincipal as a long.
- *
- *
+ * {@code SolarisNumericUserPrincipal} as a long.
*
* @return the user identification number (UID) for this
- * SolarisNumericUserPrincipal as a long.
+ * {@code SolarisNumericUserPrincipal} as a long.
*/
public long longValue() {
return Long.parseLong(name);
@@ -127,12 +119,10 @@ public class SolarisNumericUserPrincipal implements
/**
* Return a string representation of this
- * SolarisNumericUserPrincipal.
- *
- *
+ * {@code SolarisNumericUserPrincipal}.
*
* @return a string representation of this
- * SolarisNumericUserPrincipal.
+ * {@code SolarisNumericUserPrincipal}.
*/
public String toString() {
return(rb.getString("SolarisNumericUserPrincipal.") + name);
@@ -140,19 +130,17 @@ public class SolarisNumericUserPrincipal implements
/**
* Compares the specified Object with this
- * SolarisNumericUserPrincipal
+ * {@code SolarisNumericUserPrincipal}
* for equality. Returns true if the given object is also a
- * SolarisNumericUserPrincipal and the two
+ * {@code SolarisNumericUserPrincipal} and the two
* SolarisNumericUserPrincipals
* have the same user identification number (UID).
*
- *
- *
* @param o Object to be compared for equality with this
- * SolarisNumericUserPrincipal.
+ * {@code SolarisNumericUserPrincipal}.
*
* @return true if the specified Object is equal to this
- * SolarisNumericUserPrincipal.
+ * {@code SolarisNumericUserPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -167,15 +155,14 @@ public class SolarisNumericUserPrincipal implements
if (this.getName().equals(that.getName()))
return true;
- return false;
+
+ return false;
}
/**
- * Return a hash code for this SolarisNumericUserPrincipal.
+ * Return a hash code for this {@code SolarisNumericUserPrincipal}.
*
- *
- *
- * @return a hash code for this SolarisNumericUserPrincipal.
+ * @return a hash code for this {@code SolarisNumericUserPrincipal}.
*/
public int hashCode() {
return name.hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisPrincipal.java
index 6fd78fa5cb1..4aef765e813 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/SolarisPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a Solaris user.
*
- *
Principals such as this SolarisPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code SolarisPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
*
* @deprecated As of JDK 1.4, replaced by
* {@link UnixPrincipal}.
@@ -68,12 +68,10 @@ public class SolarisPrincipal implements Principal, java.io.Serializable {
/**
* Create a SolarisPrincipal with a Solaris username.
*
- *
- *
* @param name the Unix username for this user.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public SolarisPrincipal(String name) {
if (name == null)
@@ -83,40 +81,34 @@ public class SolarisPrincipal implements Principal, java.io.Serializable {
}
/**
- * Return the Unix username for this SolarisPrincipal.
+ * Return the Unix username for this {@code SolarisPrincipal}.
*
- *
- *
- * @return the Unix username for this SolarisPrincipal
+ * @return the Unix username for this {@code SolarisPrincipal}
*/
public String getName() {
return name;
}
/**
- * Return a string representation of this SolarisPrincipal.
+ * Return a string representation of this {@code SolarisPrincipal}.
*
- *
- *
- * @return a string representation of this SolarisPrincipal.
+ * @return a string representation of this {@code SolarisPrincipal}.
*/
public String toString() {
return(rb.getString("SolarisPrincipal.") + name);
}
/**
- * Compares the specified Object with this SolarisPrincipal
+ * Compares the specified Object with this {@code SolarisPrincipal}
* for equality. Returns true if the given object is also a
- * SolarisPrincipal and the two SolarisPrincipals
+ * {@code SolarisPrincipal} and the two SolarisPrincipals
* have the same username.
*
- *
- *
* @param o Object to be compared for equality with this
- * SolarisPrincipal.
+ * {@code SolarisPrincipal}.
*
* @return true if the specified Object is equal to this
- * SolarisPrincipal.
+ * {@code SolarisPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -135,11 +127,9 @@ public class SolarisPrincipal implements Principal, java.io.Serializable {
}
/**
- * Return a hash code for this SolarisPrincipal.
+ * Return a hash code for this {@code SolarisPrincipal}.
*
- *
- *
- * @return a hash code for this SolarisPrincipal.
+ * @return a hash code for this {@code SolarisPrincipal}.
*/
public int hashCode() {
return name.hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericGroupPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericGroupPrincipal.java
index 5edb8d2a4ec..4a96480db01 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericGroupPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericGroupPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a user's Unix group identification number (GID).
*
- *
Principals such as this UnixNumericGroupPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code UnixNumericGroupPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
*
* @see java.security.Principal
* @see javax.security.auth.Subject
@@ -59,20 +59,18 @@ public class UnixNumericGroupPrincipal implements
private boolean primaryGroup;
/**
- * Create a UnixNumericGroupPrincipal using a
- * String representation of the user's
+ * Create a {@code UnixNumericGroupPrincipal} using a
+ * {@code String} representation of the user's
* group identification number (GID).
*
- *
- *
* @param name the user's group identification number (GID)
- * for this user.
+ * for this user.
*
* @param primaryGroup true if the specified GID represents the
* primary group to which this user belongs.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public UnixNumericGroupPrincipal(String name, boolean primaryGroup) {
if (name == null) {
@@ -89,13 +87,11 @@ public class UnixNumericGroupPrincipal implements
}
/**
- * Create a UnixNumericGroupPrincipal using a
+ * Create a {@code UnixNumericGroupPrincipal} using a
* long representation of the user's group identification number (GID).
*
- *
- *
* @param name the user's group identification number (GID) for this user
- * represented as a long.
+ * represented as a long.
*
* @param primaryGroup true if the specified GID represents the
* primary group to which this user belongs.
@@ -108,12 +104,10 @@ public class UnixNumericGroupPrincipal implements
/**
* Return the user's group identification number (GID) for this
- * UnixNumericGroupPrincipal.
- *
- *
+ * {@code UnixNumericGroupPrincipal}.
*
* @return the user's group identification number (GID) for this
- * UnixNumericGroupPrincipal
+ * {@code UnixNumericGroupPrincipal}
*/
public String getName() {
return name;
@@ -121,12 +115,10 @@ public class UnixNumericGroupPrincipal implements
/**
* Return the user's group identification number (GID) for this
- * UnixNumericGroupPrincipal as a long.
- *
- *
+ * {@code UnixNumericGroupPrincipal} as a long.
*
* @return the user's group identification number (GID) for this
- * UnixNumericGroupPrincipal as a long.
+ * {@code UnixNumericGroupPrincipal} as a long.
*/
public long longValue() {
return Long.parseLong(name);
@@ -136,8 +128,6 @@ public class UnixNumericGroupPrincipal implements
* Return whether this group identification number (GID) represents
* the primary group to which this user belongs.
*
- *
- *
* @return true if this group identification number (GID) represents
* the primary group to which this user belongs,
* or false otherwise.
@@ -148,12 +138,10 @@ public class UnixNumericGroupPrincipal implements
/**
* Return a string representation of this
- * UnixNumericGroupPrincipal.
- *
- *
+ * {@code UnixNumericGroupPrincipal}.
*
* @return a string representation of this
- * UnixNumericGroupPrincipal.
+ * {@code UnixNumericGroupPrincipal}.
*/
public String toString() {
@@ -176,19 +164,17 @@ public class UnixNumericGroupPrincipal implements
/**
* Compares the specified Object with this
- * UnixNumericGroupPrincipal
+ * {@code UnixNumericGroupPrincipal}
* for equality. Returns true if the given object is also a
- * UnixNumericGroupPrincipal and the two
+ * {@code UnixNumericGroupPrincipal} and the two
* UnixNumericGroupPrincipals
* have the same group identification number (GID).
*
- *
- *
* @param o Object to be compared for equality with this
- * UnixNumericGroupPrincipal.
+ * {@code UnixNumericGroupPrincipal}.
*
* @return true if the specified Object is equal to this
- * UnixNumericGroupPrincipal.
+ * {@code UnixNumericGroupPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -208,11 +194,9 @@ public class UnixNumericGroupPrincipal implements
}
/**
- * Return a hash code for this UnixNumericGroupPrincipal.
+ * Return a hash code for this {@code UnixNumericGroupPrincipal}.
*
- *
- *
- * @return a hash code for this UnixNumericGroupPrincipal.
+ * @return a hash code for this {@code UnixNumericGroupPrincipal}.
*/
public int hashCode() {
return toString().hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericUserPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericUserPrincipal.java
index bb45c642459..cb252a8966e 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericUserPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixNumericUserPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a user's Unix identification number (UID).
*
- *
Principals such as this UnixNumericUserPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code UnixNumericUserPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
*
* @see java.security.Principal
* @see javax.security.auth.Subject
@@ -53,16 +53,14 @@ public class UnixNumericUserPrincipal implements
private String name;
/**
- * Create a UnixNumericUserPrincipal using a
- * String representation of the
+ * Create a {@code UnixNumericUserPrincipal} using a
+ * {@code String} representation of the
* user's identification number (UID).
*
- *
- *
* @param name the user identification number (UID) for this user.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public UnixNumericUserPrincipal(String name) {
if (name == null) {
@@ -78,11 +76,9 @@ public class UnixNumericUserPrincipal implements
}
/**
- * Create a UnixNumericUserPrincipal using a
+ * Create a {@code UnixNumericUserPrincipal} using a
* long representation of the user's identification number (UID).
*
- *
- *
* @param name the user identification number (UID) for this user
* represented as a long.
*/
@@ -92,12 +88,10 @@ public class UnixNumericUserPrincipal implements
/**
* Return the user identification number (UID) for this
- * UnixNumericUserPrincipal.
- *
- *
+ * {@code UnixNumericUserPrincipal}.
*
* @return the user identification number (UID) for this
- * UnixNumericUserPrincipal
+ * {@code UnixNumericUserPrincipal}
*/
public String getName() {
return name;
@@ -105,12 +99,10 @@ public class UnixNumericUserPrincipal implements
/**
* Return the user identification number (UID) for this
- * UnixNumericUserPrincipal as a long.
- *
- *
+ * {@code UnixNumericUserPrincipal} as a long.
*
* @return the user identification number (UID) for this
- * UnixNumericUserPrincipal as a long.
+ * {@code UnixNumericUserPrincipal} as a long.
*/
public long longValue() {
return Long.parseLong(name);
@@ -118,12 +110,10 @@ public class UnixNumericUserPrincipal implements
/**
* Return a string representation of this
- * UnixNumericUserPrincipal.
- *
- *
+ * {@code UnixNumericUserPrincipal}.
*
* @return a string representation of this
- * UnixNumericUserPrincipal.
+ * {@code UnixNumericUserPrincipal}.
*/
public String toString() {
java.text.MessageFormat form = new java.text.MessageFormat
@@ -136,19 +126,17 @@ public class UnixNumericUserPrincipal implements
/**
* Compares the specified Object with this
- * UnixNumericUserPrincipal
+ * {@code UnixNumericUserPrincipal}
* for equality. Returns true if the given object is also a
- * UnixNumericUserPrincipal and the two
+ * {@code UnixNumericUserPrincipal} and the two
* UnixNumericUserPrincipals
* have the same user identification number (UID).
*
- *
- *
* @param o Object to be compared for equality with this
- * UnixNumericUserPrincipal.
+ * {@code UnixNumericUserPrincipal}.
*
* @return true if the specified Object is equal to this
- * UnixNumericUserPrincipal.
+ * {@code UnixNumericUserPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -167,11 +155,9 @@ public class UnixNumericUserPrincipal implements
}
/**
- * Return a hash code for this UnixNumericUserPrincipal.
+ * Return a hash code for this {@code UnixNumericUserPrincipal}.
*
- *
- *
- * @return a hash code for this UnixNumericUserPrincipal.
+ * @return a hash code for this {@code UnixNumericUserPrincipal}.
*/
public int hashCode() {
return name.hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixPrincipal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixPrincipal.java
index 140bd8ffcd8..9694bc7a443 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixPrincipal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/UnixPrincipal.java
@@ -28,15 +28,15 @@ package com.sun.security.auth;
import java.security.Principal;
/**
- *
This class implements the Principal interface
+ * This class implements the {@code Principal} interface
* and represents a Unix user.
*
- *
Principals such as this UnixPrincipal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code UnixPrincipal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
*
* @see java.security.Principal
* @see javax.security.auth.Subject
@@ -54,12 +54,10 @@ public class UnixPrincipal implements Principal, java.io.Serializable {
/**
* Create a UnixPrincipal with a Unix username.
*
- *
- *
* @param name the Unix username for this user.
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*/
public UnixPrincipal(String name) {
if (name == null) {
@@ -75,22 +73,18 @@ public class UnixPrincipal implements Principal, java.io.Serializable {
}
/**
- * Return the Unix username for this UnixPrincipal.
+ * Return the Unix username for this {@code UnixPrincipal}.
*
- *
- *
- * @return the Unix username for this UnixPrincipal
+ * @return the Unix username for this {@code UnixPrincipal}
*/
public String getName() {
return name;
}
/**
- * Return a string representation of this UnixPrincipal.
+ * Return a string representation of this {@code UnixPrincipal}.
*
- *
- *
- * @return a string representation of this UnixPrincipal.
+ * @return a string representation of this {@code UnixPrincipal}.
*/
public String toString() {
java.text.MessageFormat form = new java.text.MessageFormat
@@ -102,18 +96,16 @@ public class UnixPrincipal implements Principal, java.io.Serializable {
}
/**
- * Compares the specified Object with this UnixPrincipal
+ * Compares the specified Object with this {@code UnixPrincipal}
* for equality. Returns true if the given object is also a
- * UnixPrincipal and the two UnixPrincipals
+ * {@code UnixPrincipal} and the two UnixPrincipals
* have the same username.
*
- *
- *
* @param o Object to be compared for equality with this
- * UnixPrincipal.
+ * {@code UnixPrincipal}.
*
* @return true if the specified Object is equal to this
- * UnixPrincipal.
+ * {@code UnixPrincipal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -132,11 +124,9 @@ public class UnixPrincipal implements Principal, java.io.Serializable {
}
/**
- * Return a hash code for this UnixPrincipal.
+ * Return a hash code for this {@code UnixPrincipal}.
*
- *
- *
- * @return a hash code for this UnixPrincipal.
+ * @return a hash code for this {@code UnixPrincipal}.
*/
public int hashCode() {
return name.hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/X500Principal.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/X500Principal.java
index c4b12bdb28b..52fdcf868c9 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/X500Principal.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/X500Principal.java
@@ -29,17 +29,17 @@ import java.security.Principal;
import sun.security.x509.X500Name;
/**
- *
This class represents an X.500 Principal.
+ * This class represents an X.500 {@code Principal}.
* X500Principals have names such as,
* "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"
* (RFC 1779 style).
*
- *
Principals such as this X500Principal
- * may be associated with a particular Subject
- * to augment that Subject with an additional
- * identity. Refer to the Subject class for more information
+ *
Principals such as this {@code X500Principal}
+ * may be associated with a particular {@code Subject}
+ * to augment that {@code Subject} with an additional
+ * identity. Refer to the {@code Subject} class for more information
* on how to achieve this. Authorization decisions can then be based upon
- * the Principals associated with a Subject.
+ * the Principals associated with a {@code Subject}.
*
* @see java.security.Principal
* @see javax.security.auth.Subject
@@ -76,14 +76,12 @@ public class X500Principal implements Principal, java.io.Serializable {
* such as "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"
* (RFC 1779 style).
*
- *
- *
* @param name the X.500 name
*
- * @exception NullPointerException if the name
- * is null.
+ * @exception NullPointerException if the {@code name}
+ * is {@code null}.
*
- * @exception IllegalArgumentException if the name
+ * @exception IllegalArgumentException if the {@code name}
* is improperly specified.
*/
public X500Principal(String name) {
@@ -100,38 +98,32 @@ public class X500Principal implements Principal, java.io.Serializable {
}
/**
- * Return the Unix username for this X500Principal.
+ * Return the Unix username for this {@code X500Principal}.
*
- *
- *
- * @return the Unix username for this X500Principal
+ * @return the Unix username for this {@code X500Principal}
*/
public String getName() {
return thisX500Name.getName();
}
/**
- * Return a string representation of this X500Principal.
+ * Return a string representation of this {@code X500Principal}.
*
- *
- *
- * @return a string representation of this X500Principal.
+ * @return a string representation of this {@code X500Principal}.
*/
public String toString() {
return thisX500Name.toString();
}
/**
- * Compares the specified Object with this X500Principal
+ * Compares the specified Object with this {@code X500Principal}
* for equality.
*
- *
- *
* @param o Object to be compared for equality with this
- * X500Principal.
+ * {@code X500Principal}.
*
* @return true if the specified Object is equal to this
- * X500Principal.
+ * {@code X500Principal}.
*/
public boolean equals(Object o) {
if (o == null)
@@ -159,11 +151,9 @@ public class X500Principal implements Principal, java.io.Serializable {
}
/**
- * Return a hash code for this X500Principal.
+ * Return a hash code for this {@code X500Principal}.
*
- *
- *
- * @return a hash code for this X500Principal.
+ * @return a hash code for this {@code X500Principal}.
*/
public int hashCode() {
return thisX500Name.hashCode();
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/JndiLoginModule.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/JndiLoginModule.java
index e287f858804..08e359b9b8e 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/JndiLoginModule.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/JndiLoginModule.java
@@ -44,28 +44,28 @@ import com.sun.security.auth.UnixNumericGroupPrincipal;
/**
- *
The module prompts for a username and password
+ * The module prompts for a username and password
* and then verifies the password against the password stored in
* a directory service configured under JNDI.
*
- *
This LoginModule interoperates with
+ *
This {@code LoginModule} interoperates with
* any conformant JNDI service provider. To direct this
- * LoginModule to use a specific JNDI service provider,
- * two options must be specified in the login Configuration
- * for this LoginModule.
+ * {@code LoginModule} to use a specific JNDI service provider,
+ * two options must be specified in the login {@code Configuration}
+ * for this {@code LoginModule}.
*
* user.provider.url=name_service_url
* group.provider.url=name_service_url
*
*
* name_service_url specifies
- * the directory service and path where this LoginModule
+ * the directory service and path where this {@code LoginModule}
* can access the relevant user and group information. Because this
- * LoginModule only performs one-level searches to
- * find the relevant user information, the URL
+ * {@code LoginModule} only performs one-level searches to
+ * find the relevant user information, the {@code URL}
* must point to a directory one level above where the user and group
* information is stored in the directory service.
- * For example, to instruct this LoginModule
+ * For example, to instruct this {@code LoginModule}
* to contact a NIS server, the following URLs must be specified:
*
* user.provider.url="nis://NISServerHostName/NISDomain/user"
@@ -90,14 +90,14 @@ import com.sun.security.auth.UnixNumericGroupPrincipal;
*
* The format in which the user's information must be stored in
* the directory service is specified in RFC 2307. Specifically,
- * this LoginModule will search for the user's entry in the
+ * this {@code LoginModule} will search for the user's entry in the
* directory service using the user's uid attribute,
* where uid=username. If the search succeeds,
- * this LoginModule will then
+ * this {@code LoginModule} will then
* obtain the user's encrypted password from the retrieved entry
* using the userPassword attribute.
- * This LoginModule assumes that the password is stored
- * as a byte array, which when converted to a String,
+ * This {@code LoginModule} assumes that the password is stored
+ * as a byte array, which when converted to a {@code String},
* has the following format:
*
* "{crypt}encrypted_password"
@@ -106,12 +106,12 @@ import com.sun.security.auth.UnixNumericGroupPrincipal;
* The LDAP directory server must be configured
* to permit read access to the userPassword attribute.
* If the user entered a valid username and password,
- * this LoginModule associates a
- * UnixPrincipal, UnixNumericUserPrincipal,
+ * this {@code LoginModule} associates a
+ * {@code UnixPrincipal}, {@code UnixNumericUserPrincipal},
* and the relevant UnixNumericGroupPrincipals with the
- * Subject.
+ * {@code Subject}.
*
- * This LoginModule also recognizes the following Configuration
+ *
This LoginModule also recognizes the following {@code Configuration}
* options:
*
* debug if, true, debug messages are output to System.out.
@@ -144,7 +144,7 @@ import com.sun.security.auth.UnixNumericGroupPrincipal;
* exist for the username and password in the shared state,
* or if authentication fails.
*
- * clearPass if, true, this LoginModule clears the
+ * clearPass if, true, this {@code LoginModule} clears the
* username and password stored in the module's shared state
* after both phases of authentication (login and commit)
* have completed.
@@ -208,21 +208,19 @@ public class JndiLoginModule implements LoginModule {
private static final String PWD = "javax.security.auth.login.password";
/**
- * Initialize this LoginModule.
+ * Initialize this {@code LoginModule}.
*
- *
+ * @param subject the {@code Subject} to be authenticated.
*
- * @param subject the Subject to be authenticated.
- *
- * @param callbackHandler a CallbackHandler for communicating
+ * @param callbackHandler a {@code CallbackHandler} for communicating
* with the end user (prompting for usernames and
- * passwords, for example).
+ * passwords, for example).
*
- * @param sharedState shared LoginModule state.
+ * @param sharedState shared {@code LoginModule} state.
*
* @param options options specified in the login
- * Configuration for this particular
- * LoginModule.
+ * {@code Configuration} for this particular
+ * {@code LoginModule}.
*/
// Unchecked warning from (Map)sharedState is safe
// since javax.security.auth.login.LoginContext passes a raw HashMap.
@@ -255,17 +253,15 @@ public class JndiLoginModule implements LoginModule {
}
/**
- * Prompt for username and password.
+ * Prompt for username and password.
* Verify the password against the relevant name service.
*
- *
- *
- * @return true always, since this LoginModule
+ * @return true always, since this {@code LoginModule}
* should not be ignored.
*
- * @exception FailedLoginException if the authentication fails.
+ * @exception FailedLoginException if the authentication fails.
*
- * @exception LoginException if this LoginModule
+ * @exception LoginException if this {@code LoginModule}
* is unable to perform the authentication.
*/
public boolean login() throws LoginException {
@@ -367,15 +363,13 @@ public class JndiLoginModule implements LoginModule {
*
*
If this LoginModule's own authentication attempt
* succeeded (checked by retrieving the private state saved by the
- * login method), then this method associates a
- * UnixPrincipal
- * with the Subject located in the
- * LoginModule. If this LoginModule's own
+ * {@code login} method), then this method associates a
+ * {@code UnixPrincipal}
+ * with the {@code Subject} located in the
+ * {@code LoginModule}. If this LoginModule's own
* authentication attempted failed, then this method removes
* any state that was originally saved.
*
- *
- *
* @exception LoginException if the commit fails
*
* @return true if this LoginModule's own login and commit
@@ -418,18 +412,16 @@ public class JndiLoginModule implements LoginModule {
}
/**
- *
This method is called if the LoginContext's
+ * This method is called if the LoginContext's
* overall authentication failed.
* (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules
* did not succeed).
*
*
If this LoginModule's own authentication attempt
* succeeded (checked by retrieving the private state saved by the
- * login and commit methods),
+ * {@code login} and {@code commit} methods),
* then this method cleans up any state that was originally saved.
*
- *
- *
* @exception LoginException if the abort fails.
*
* @return false if this LoginModule's own login and/or commit attempts
@@ -464,13 +456,11 @@ public class JndiLoginModule implements LoginModule {
* Logout a user.
*
*
This method removes the Principals
- * that were added by the commit method.
- *
- *
+ * that were added by the {@code commit} method.
*
* @exception LoginException if the logout fails.
*
- * @return true in all cases since this LoginModule
+ * @return true in all cases since this {@code LoginModule}
* should not be ignored.
*/
public boolean logout() throws LoginException {
@@ -506,8 +496,6 @@ public class JndiLoginModule implements LoginModule {
/**
* Attempt authentication
*
- *
- *
* @param getPasswdFromSharedState boolean that tells this method whether
* to retrieve the password from the sharedState.
*/
@@ -674,8 +662,6 @@ public class JndiLoginModule implements LoginModule {
* values in the shared state in case subsequent LoginModules
* want to use them via use/tryFirstPass.
*
- *
- *
* @param getPasswdFromSharedState boolean that tells this method whether
* to retrieve the password from the sharedState.
*/
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/KeyStoreLoginModule.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/KeyStoreLoginModule.java
index 248afb53a9b..ece0d3f8afb 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/KeyStoreLoginModule.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/KeyStoreLoginModule.java
@@ -55,53 +55,53 @@ import sun.security.util.Password;
/**
* Provides a JAAS login module that prompts for a key store alias and
* populates the subject with the alias's principal and credentials. Stores
- * an X500Principal for the subject distinguished name of the
+ * an {@code X500Principal} for the subject distinguished name of the
* first certificate in the alias's credentials in the subject's principals,
* the alias's certificate path in the subject's public credentials, and a
- * X500PrivateCredential whose certificate is the first
+ * {@code X500PrivateCredential} whose certificate is the first
* certificate in the alias's certificate path and whose private key is the
* alias's private key in the subject's private credentials.
*
* Recognizes the following options in the configuration file:
*
*
- * -
keyStoreURL
+ * - {@code keyStoreURL}
* - A URL that specifies the location of the key store. Defaults to
* a URL pointing to the .keystore file in the directory specified by the
- *
user.home system property. The input stream from this
- * URL is passed to the KeyStore.load method.
- * "NONE" may be specified if a null stream must be
- * passed to the KeyStore.load method.
+ * {@code user.home} system property. The input stream from this
+ * URL is passed to the {@code KeyStore.load} method.
+ * "NONE" may be specified if a {@code null} stream must be
+ * passed to the {@code KeyStore.load} method.
* "NONE" should be specified if the KeyStore resides
* on a hardware token device, for example.
*
- * -
keyStoreType
+ * - {@code keyStoreType}
* - The key store type. If not specified, defaults to the result of
- * calling
KeyStore.getDefaultType().
+ * calling {@code KeyStore.getDefaultType()}.
* If the type is "PKCS11", then keyStoreURL must be "NONE"
* and privateKeyPasswordURL must not be specified.
*
- * -
keyStoreProvider
+ * - {@code keyStoreProvider}
* - The key store provider. If not specified, uses the standard search
* order to find the provider.
*
- * -
keyStoreAlias
+ * - {@code keyStoreAlias}
* - The alias in the key store to login as. Required when no callback
* handler is provided. No default value.
*
- * -
keyStorePasswordURL
+ * - {@code keyStorePasswordURL}
* - A URL that specifies the location of the key store password. Required
* when no callback handler is provided and
- *
protected is false.
+ * {@code protected} is false.
* No default value.
*
- * -
privateKeyPasswordURL
+ * - {@code privateKeyPasswordURL}
* - A URL that specifies the location of the specific private key password
* needed to access the private key for this alias.
* The keystore password
* is used if this value is needed and not specified.
*
- * -
protected
+ * - {@code protected}
* - This value should be set to "true" if the KeyStore
* has a separate, protected authentication path
* (for example, a dedicated PIN-pad attached to a smart card).
@@ -174,22 +174,20 @@ public class KeyStoreLoginModule implements LoginModule {
/* -- Methods -- */
/**
- * Initialize this
LoginModule.
+ * Initialize this {@code LoginModule}.
*
- *
+ * @param subject the {@code Subject} to be authenticated.
*
- * @param subject the Subject to be authenticated.
- *
- * @param callbackHandler a CallbackHandler for communicating
+ * @param callbackHandler a {@code CallbackHandler} for communicating
* with the end user (prompting for usernames and
* passwords, for example),
- * which may be null.
+ * which may be {@code null}.
*
- * @param sharedState shared LoginModule state.
+ * @param sharedState shared {@code LoginModule} state.
*
* @param options options specified in the login
- * Configuration for this particular
- * LoginModule.
+ * {@code Configuration} for this particular
+ * {@code LoginModule}.
*/
// Unchecked warning from (Map)sharedState is safe
// since javax.security.auth.login.LoginContext passes a raw HashMap.
@@ -258,11 +256,9 @@ public class KeyStoreLoginModule implements LoginModule {
* Get the Keystore alias and relevant passwords.
* Retrieve the alias's principal and credentials from the Keystore.
*
- *
+ * @exception FailedLoginException if the authentication fails.
*
- * @exception FailedLoginException if the authentication fails.
- *
- * @return true in all cases (this LoginModule
+ * @return true in all cases (this {@code LoginModule}
* should not be ignored).
*/
@@ -719,19 +715,17 @@ public class KeyStoreLoginModule implements LoginModule {
*
*
If this LoginModule's own authentication attempt
* succeeded (checked by retrieving the private state saved by the
- * login method), then this method associates a
- * X500Principal for the subject distinguished name of the
+ * {@code login} method), then this method associates a
+ * {@code X500Principal} for the subject distinguished name of the
* first certificate in the alias's credentials in the subject's
* principals,the alias's certificate path in the subject's public
- * credentials, and aX500PrivateCredential whose certificate
+ * credentials, and a {@code X500PrivateCredential} whose certificate
* is the first certificate in the alias's certificate path and whose
* private key is the alias's private key in the subject's private
* credentials. If this LoginModule's own
* authentication attempted failed, then this method removes
* any state that was originally saved.
*
- *
- *
* @exception LoginException if the commit fails
*
* @return true if this LoginModule's own login and commit
@@ -774,21 +768,19 @@ public class KeyStoreLoginModule implements LoginModule {
}
/**
- *
This method is called if the LoginContext's
+ * This method is called if the LoginContext's
* overall authentication failed.
* (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules
* did not succeed).
*
*
If this LoginModule's own authentication attempt
* succeeded (checked by retrieving the private state saved by the
- * login and commit methods),
+ * {@code login} and {@code commit} methods),
* then this method cleans up any state that was originally saved.
*
*
If the loaded KeyStore's provider extends
- * java.security.AuthProvider,
- * then the provider's logout method is invoked.
- *
- *
+ * {@code java.security.AuthProvider},
+ * then the provider's {@code logout} method is invoked.
*
* @exception LoginException if the abort fails.
*
@@ -815,17 +807,15 @@ public class KeyStoreLoginModule implements LoginModule {
* Logout a user.
*
*
This method removes the Principals, public credentials and the
- * private credentials that were added by the commit method.
+ * private credentials that were added by the {@code commit} method.
*
*
If the loaded KeyStore's provider extends
- * java.security.AuthProvider,
- * then the provider's logout method is invoked.
- *
- *
+ * {@code java.security.AuthProvider},
+ * then the provider's {@code logout} method is invoked.
*
* @exception LoginException if the logout fails.
*
- * @return true in all cases since this LoginModule
+ * @return true in all cases since this {@code LoginModule}
* should not be ignored.
*/
diff --git a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java
index 12ee20b126b..5bd179db91a 100644
--- a/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java
+++ b/jdk/src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java
@@ -47,147 +47,142 @@ import sun.security.krb5.Credentials;
import sun.misc.HexDumpEncoder;
/**
- *
This LoginModule authenticates users using
+ * This {@code LoginModule} authenticates users using
* Kerberos protocols.
*
- *
The configuration entry for Krb5LoginModule has
+ *
The configuration entry for {@code Krb5LoginModule} has
* several options that control the authentication process and
- * additions to the Subject's private credential
- * set. Irrespective of these options, the Subject's
+ * additions to the {@code Subject}'s private credential
+ * set. Irrespective of these options, the {@code Subject}'s
* principal set and private credentials set are updated only when
- * commit is called.
- * When commit is called, the KerberosPrincipal
- * is added to the Subject's principal set (unless the
- * principal is specified as "*"). If isInitiator
- * is true, the KerberosTicket is
- * added to the Subject's private credentials.
+ * {@code commit} is called.
+ * When {@code commit} is called, the {@code KerberosPrincipal}
+ * is added to the {@code Subject}'s principal set (unless the
+ * {@code principal} is specified as "*"). If {@code isInitiator}
+ * is true, the {@code KerberosTicket} is
+ * added to the {@code Subject}'s private credentials.
*
- *
If the configuration entry for KerberosLoginModule
- * has the option storeKey set to true, then
- * KerberosKey or KeyTab will also be added to the
- * subject's private credentials. KerberosKey, the principal's
- * key(s) will be derived from user's password, and KeyTab is
- * the keytab used when useKeyTab is set to true. The
- * KeyTab object is restricted to be used by the specified
+ *
If the configuration entry for {@code KerberosLoginModule}
+ * has the option {@code storeKey} set to true, then
+ * {@code KerberosKey} or {@code KeyTab} will also be added to the
+ * subject's private credentials. {@code KerberosKey}, the principal's
+ * key(s) will be derived from user's password, and {@code KeyTab} is
+ * the keytab used when {@code useKeyTab} is set to true. The
+ * {@code KeyTab} object is restricted to be used by the specified
* principal unless the principal value is "*".
*
- *
This LoginModule recognizes the doNotPrompt
+ *
This {@code LoginModule} recognizes the {@code doNotPrompt}
* option. If set to true the user will not be prompted for the password.
*
*
The user can specify the location of the ticket cache by using
- * the option ticketCache in the configuration entry.
+ * the option {@code ticketCache} in the configuration entry.
*
*
The user can specify the keytab location by using
- * the option keyTab
+ * the option {@code keyTab}
* in the configuration entry.
*
*
The principal name can be specified in the configuration entry
- * by using the option principal. The principal name
+ * by using the option {@code principal}. The principal name
* can either be a simple user name, a service name such as
- * host/mission.eng.sun.com, or "*". The principal can also
- * be set using the system property sun.security.krb5.principal.
+ * {@code host/mission.eng.sun.com}, or "*". The principal can also
+ * be set using the system property {@code sun.security.krb5.principal}.
* This property is checked during login. If this property is not set, then
* the principal name from the configuration is used. In the
* case where the principal property is not set and the principal
* entry also does not exist, the user is prompted for the name.
- * When this property of entry is set, and useTicketCache
+ * When this property of entry is set, and {@code useTicketCache}
* is set to true, only TGT belonging to this principal is used.
*
*
The following is a list of configuration options supported
- * for Krb5LoginModule:
+ * for {@code Krb5LoginModule}:
*
- * refreshKrb5Config:- {@code refreshKrb5Config}:
* - Set this to true, if you want the configuration
- * to be refreshed before the
login method is called.
- * useTicketCache:
+ * - {@code useTicketCache}:
* - Set this to true, if you want the
- * TGT to be obtained
- * from the ticket cache. Set this option
+ * TGT to be obtained from the ticket cache. Set this option
* to false if you do not want this module to use the ticket cache.
* (Default is False).
- * This module will
- * search for the ticket
- * cache in the following locations:
- * On Solaris and Linux
- * it will look for the ticket cache in /tmp/krb5cc_
uid
- * where the uid is numeric user
- * identifier. If the ticket cache is
+ * This module will search for the ticket
+ * cache in the following locations: On Solaris and Linux
+ * it will look for the ticket cache in /tmp/krb5cc_{@code uid}
+ * where the uid is numeric user identifier. If the ticket cache is
* not available in the above location, or if we are on a
* Windows platform, it will look for the cache as
* {user.home}{file.separator}krb5cc_{user.name}.
* You can override the ticket cache location by using
- * ticketCache.
+ * {@code ticketCache}.
* For Windows, if a ticket cannot be retrieved from the file ticket cache,
* it will use Local Security Authority (LSA) API to get the TGT.
- * ticketCache:- {@code ticketCache}:
* - Set this to the name of the ticket
* cache that contains user's TGT.
- * If this is set,
useTicketCache
+ * If this is set, {@code useTicketCache}
* must also be set to true; Otherwise a configuration error will
* be returned.
- * renewTGT:- {@code renewTGT}:
* - Set this to true, if you want to renew
- * the TGT. If this is set,
useTicketCache must also be
+ * the TGT. If this is set, {@code useTicketCache} must also be
* set to true; otherwise a configuration error will be returned.
- * doNotPrompt:- {@code doNotPrompt}:
* - Set this to true if you do not want to be
* prompted for the password
* if credentials can not be obtained from the cache, the keytab,
* or through shared state.(Default is false)
* If set to true, credential must be obtained through cache, keytab,
* or shared state. Otherwise, authentication will fail.
- * useKeyTab:- {@code useKeyTab}:
* - Set this to true if you
* want the module to get the principal's key from the
* the keytab.(default value is False)
- * If
keytab
- * is not set then
+ * If {@code keytab} is not set then
* the module will locate the keytab from the
* Kerberos configuration file.
* If it is not specified in the Kerberos configuration file
* then it will look for the file
- * {user.home}{file.separator}krb5.keytab.
- * keyTab:- {@code keyTab}:
* - Set this to the file name of the
* keytab to get principal's secret key.
- * storeKey:- {@code storeKey}:
* - Set this to true to if you want the keytab or the
* principal's key to be stored in the Subject's private credentials.
- * For
isInitiator being false, if principal
+ * For {@code isInitiator} being false, if {@code principal}
* is "*", the {@link KeyTab} stored can be used by anyone, otherwise,
* it's restricted to be used by the specified principal only.
- * principal:- {@code principal}:
* - The name of the principal that should
* be used. The principal can be a simple username such as
- * "
testuser" or a service name such as
- * "host/testhost.eng.sun.com". You can use the
- * principal option to set the principal when there are
+ * "{@code testuser}" or a service name such as
+ * "{@code host/testhost.eng.sun.com}". You can use the
+ * {@code principal} option to set the principal when there are
* credentials for multiple principals in the
- * keyTab or when you want a specific ticket cache only.
+ * {@code keyTab} or when you want a specific ticket cache only.
* The principal can also be set using the system property
- * sun.security.krb5.principal. In addition, if this
+ * {@code sun.security.krb5.principal}. In addition, if this
* system property is defined, then it will be used. If this property
* is not set, then the principal name from the configuration will be
* used.
- * The principal name can be set to "*" when isInitiator is false.
+ * The principal name can be set to "*" when {@code isInitiator} is false.
* In this case, the acceptor is not bound to a single principal. It can
* act as any principal an initiator requests if keys for that principal
- * can be found. When isInitiator is true, the principal name
+ * can be found. When {@code isInitiator} is true, the principal name
* cannot be set to "*".
*
- * isInitiator:- {@code isInitiator}:
* - Set this to true, if initiator. Set this to false, if acceptor only.
* (Default is true).
* Note: Do not set this value to false for initiators.
*
*
- * This LoginModule also recognizes the following additional
- * Configuration
+ *
This {@code LoginModule} also recognizes the following additional
+ * {@code Configuration}
* options that enable you to share username and passwords across different
* authentication modules:
*
*
- * useFirstPass:- {@code useFirstPass}:
* - if, true, this LoginModule retrieves the
* username and password from the module's shared state,
* using "javax.security.auth.login.name" and
@@ -197,7 +192,7 @@ import sun.misc.HexDumpEncoder;
* is made, and the failure is reported back to the
* calling application.
*
- * tryFirstPass:- {@code tryFirstPass}:
* - if, true, this LoginModule retrieves the
* the username and password from the module's shared
* state using "javax.security.auth.login.name" and
@@ -210,7 +205,7 @@ import sun.misc.HexDumpEncoder;
* is made. If the authentication fails,
* the failure is reported back to the calling application
*
- * storePass:- {@code storePass}:
* - if, true, this LoginModule stores the username and
* password obtained from the CallbackHandler in the
* modules shared state, using
@@ -220,7 +215,7 @@ import sun.misc.HexDumpEncoder;
* exist for the username and password in the shared
* state, or if authentication fails.
*
- * clearPass:- {@code clearPass}:
* - if, true, this LoginModule clears the
* username and password stored in the module's shared
* state after both phases of authentication
@@ -236,148 +231,137 @@ import sun.misc.HexDumpEncoder;
*
- shared state
*
- user prompt
*