More specifically, it encapsulates a context and
- * has a single method, checkPermission,
- * that is equivalent to the checkPermission method
+ * has a single method, {@code checkPermission},
+ * that is equivalent to the {@code checkPermission} method
* in the AccessController class, with one difference: The AccessControlContext
- * checkPermission method makes access decisions based on the
+ * {@code checkPermission} method makes access decisions based on the
* context it encapsulates,
* rather than that of the current execution thread.
*
@@ -49,8 +49,8 @@ import sun.security.util.SecurityConstants;
* different context (for example, from within a worker thread).
*
*
An AccessControlContext is created by calling the
- * AccessController.getContext method.
- * The getContext method takes a "snapshot"
+ * {@code AccessController.getContext} method.
+ * The {@code getContext} method takes a "snapshot"
* of the current calling context, and places
* it in an AccessControlContext object, which it returns. A sample call is
* the following:
@@ -61,7 +61,7 @@ import sun.security.util.SecurityConstants;
*
*
* Code within a different context can subsequently call the
- * checkPermission method on the
+ * {@code checkPermission} method on the
* previously-saved AccessControlContext object. A sample call is the
* following:
*
@@ -121,7 +121,7 @@ public final class AccessControlContext {
* @param context the ProtectionDomains associated with this context.
* The non-duplicate domains are copied from the array. Subsequent
* changes to the array will not affect this AccessControlContext.
- * @throws NullPointerException if context is null
+ * @throws NullPointerException if {@code context} is {@code null}
*/
public AccessControlContext(ProtectionDomain context[])
{
@@ -147,22 +147,22 @@ public final class AccessControlContext {
}
/**
- * Create a new AccessControlContext with the given
- * AccessControlContext and DomainCombiner.
+ * Create a new {@code AccessControlContext} with the given
+ * {@code AccessControlContext} and {@code DomainCombiner}.
* This constructor associates the provided
- * DomainCombiner with the provided
- * AccessControlContext.
+ * {@code DomainCombiner} with the provided
+ * {@code AccessControlContext}.
*
*
*
- * @param acc the AccessControlContext associated
- * with the provided DomainCombiner.
+ * @param acc the {@code AccessControlContext} associated
+ * with the provided {@code DomainCombiner}.
*
- * @param combiner the DomainCombiner to be associated
- * with the provided AccessControlContext.
+ * @param combiner the {@code DomainCombiner} to be associated
+ * with the provided {@code AccessControlContext}.
*
* @exception NullPointerException if the provided
- * context is null.
+ * {@code context} is {@code null}.
*
* @exception SecurityException if a security manager is installed and the
* caller does not have the "createAccessControlContext"
@@ -320,13 +320,13 @@ public final class AccessControlContext {
}
/**
- * Get the DomainCombiner associated with this
- * AccessControlContext.
+ * Get the {@code DomainCombiner} associated with this
+ * {@code AccessControlContext}.
*
*
*
- * @return the DomainCombiner associated with this
- * AccessControlContext, or null
+ * @return the {@code DomainCombiner} associated with this
+ * {@code AccessControlContext}, or {@code null}
* if there is none.
*
* @exception SecurityException if a security manager is installed and
diff --git a/src/share/classes/java/security/AccessControlException.java b/src/share/classes/java/security/AccessControlException.java
index baab01bc20e91049ba5da0b997a5433f47d0b14f..fbdbb77b999e5481783a8c7135e53c25ea9fdb12 100644
--- a/src/share/classes/java/security/AccessControlException.java
+++ b/src/share/classes/java/security/AccessControlException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -48,7 +48,7 @@ public class AccessControlException extends SecurityException {
private Permission perm;
/**
- * Constructs an AccessControlException with the
+ * Constructs an {@code AccessControlException} with the
* specified, detailed message.
*
* @param s the detail message.
@@ -58,7 +58,7 @@ public class AccessControlException extends SecurityException {
}
/**
- * Constructs an AccessControlException with the
+ * Constructs an {@code AccessControlException} with the
* specified, detailed message, and the requested permission that caused
* the exception.
*
diff --git a/src/share/classes/java/security/AccessController.java b/src/share/classes/java/security/AccessController.java
index a70251664a52f586b480a723f4d09de613929690..ed103a9186db69b6ce5cd589fadfe6913a88e36f 100644
--- a/src/share/classes/java/security/AccessController.java
+++ b/src/share/classes/java/security/AccessController.java
@@ -49,7 +49,7 @@ import sun.reflect.Reflection;
*
The {@link #checkPermission(Permission) checkPermission} method
* determines whether the access request indicated by a specified
* permission should be granted or denied. A sample call appears
- * below. In this example, checkPermission will determine
+ * below. In this example, {@code checkPermission} will determine
* whether or not to grant "read" access to the file named "testFile" in
* the "/temp" directory.
*
@@ -61,7 +61,7 @@ import sun.reflect.Reflection;
*
*
*
If a requested access is allowed,
- * checkPermission returns quietly. If denied, an
+ * {@code checkPermission} returns quietly. If denied, an
* AccessControlException is
* thrown. AccessControlException can also be thrown if the requested
* permission is of an incorrect type or contains an invalid value.
@@ -69,8 +69,8 @@ import sun.reflect.Reflection;
*
* Suppose the current thread traversed m callers, in the order of caller 1
* to caller 2 to caller m. Then caller m invoked the
- * checkPermission method.
- * The checkPermission method determines whether access
+ * {@code checkPermission} method.
+ * The {@code checkPermission} method determines whether access
* is granted or denied based on the following algorithm:
*
*
{@code
@@ -102,20 +102,20 @@ import sun.reflect.Reflection;
*
* A caller can be marked as being "privileged"
* (see {@link #doPrivileged(PrivilegedAction) doPrivileged} and below).
- * When making access control decisions, the checkPermission
+ * When making access control decisions, the {@code checkPermission}
* method stops checking if it reaches a caller that
- * was marked as "privileged" via a doPrivileged
+ * was marked as "privileged" via a {@code doPrivileged}
* call without a context argument (see below for information about a
* context argument). If that caller's domain has the
* specified permission and at least one limiting permission argument (if any)
* implies the requested permission, no further checking is done and
- * checkPermission
+ * {@code checkPermission}
* returns quietly, indicating that the requested access is allowed.
* If that domain does not have the specified permission, an exception
* is thrown, as usual. If the caller's domain had the specified permission
* but it was not implied by any limiting permission arguments given in the call
- * to doPrivileged then the permission checking continues
- * until there are no more callers or another doPrivileged
+ * to {@code doPrivileged} then the permission checking continues
+ * until there are no more callers or another {@code doPrivileged}
* call matches the requested permission and returns normally.
*
*
The normal use of the "privileged" feature is as follows. If you
@@ -137,17 +137,17 @@ import sun.reflect.Reflection;
*
*
* PrivilegedAction is an interface with a single method, named
- * run.
+ * {@code run}.
* The above example shows creation of an implementation
* of that interface; a concrete implementation of the
- * run method is supplied.
- * When the call to doPrivileged is made, an
+ * {@code run} method is supplied.
+ * When the call to {@code doPrivileged} is made, an
* instance of the PrivilegedAction implementation is passed
- * to it. The doPrivileged method calls the
- * run method from the PrivilegedAction
+ * to it. The {@code doPrivileged} method calls the
+ * {@code run} method from the PrivilegedAction
* implementation after enabling privileges, and returns the
- * run method's return value as the
- * doPrivileged return value (which is
+ * {@code run} method's return value as the
+ * {@code doPrivileged} return value (which is
* ignored in this example).
*
*
If you need to return a value, you can do something like the following:
@@ -164,11 +164,11 @@ import sun.reflect.Reflection;
* ...normal code here...
* }}
*
- * If the action performed in your run method could
- * throw a "checked" exception (those listed in the throws clause
+ *
If the action performed in your {@code run} method could
+ * throw a "checked" exception (those listed in the {@code throws} clause
* of a method), then you need to use the
- * PrivilegedExceptionAction interface instead of the
- * PrivilegedAction interface:
+ * {@code PrivilegedExceptionAction} interface instead of the
+ * {@code PrivilegedAction} interface:
*
*
{@code
* somemethod() throws FileNotFoundException {
@@ -191,18 +191,18 @@ import sun.reflect.Reflection;
*
* Be *very* careful in your use of the "privileged" construct, and
* always remember to make the privileged code section as small as possible.
- * You can pass Permission arguments to further limit the
+ * You can pass {@code Permission} arguments to further limit the
* scope of the "privilege" (see below).
*
*
- *
Note that checkPermission always performs security checks
+ *
Note that {@code checkPermission} always performs security checks
* within the context of the currently executing thread.
* Sometimes a security check that should be made within a given context
* will actually need to be done from within a
* different context (for example, from within a worker thread).
* The {@link #getContext() getContext} method and
* AccessControlContext class are provided
- * for this situation. The getContext method takes a "snapshot"
+ * for this situation. The {@code getContext} method takes a "snapshot"
* of the current calling context, and places
* it in an AccessControlContext object, which it returns. A sample call is
* the following:
@@ -214,7 +214,7 @@ import sun.reflect.Reflection;
*
*
*
- * AccessControlContext itself has a checkPermission method
+ * AccessControlContext itself has a {@code checkPermission} method
* that makes access decisions based on the context it encapsulates,
* rather than that of the current execution thread.
* Code within a different context can thus call that method on the
@@ -230,7 +230,7 @@ import sun.reflect.Reflection;
*
There are also times where you don't know a priori which permissions
* to check the context against. In these cases you can use the
* doPrivileged method that takes a context. You can also limit the scope
- * of the privileged code by passing additional Permission
+ * of the privileged code by passing additional {@code Permission}
* parameters.
*
*
{@code
@@ -248,12 +248,12 @@ import sun.reflect.Reflection;
* }, acc, new FilePermission("/temp/*", read));
* ...normal code here...
* }}
- * Passing a limiting Permission argument of an instance of
- * AllPermission is equivalent to calling the equivalent
- * doPrivileged method without limiting Permission
- * arguments. Passing a zero length array of Permission disables
+ *
Passing a limiting {@code Permission} argument of an instance of
+ * {@code AllPermission} is equivalent to calling the equivalent
+ * {@code doPrivileged} method without limiting {@code Permission}
+ * arguments. Passing a zero length array of {@code Permission} disables
* the code privileges so that checking always continues beyond the caller of
- * that doPrivileged method.
+ * that {@code doPrivileged} method.
*
* @see AccessControlContext
*
@@ -269,11 +269,11 @@ public final class AccessController {
private AccessController() { }
/**
- * Performs the specified PrivilegedAction with privileges
+ * Performs the specified {@code PrivilegedAction} with privileges
* enabled. The action is performed with all of the permissions
* possessed by the caller's protection domain.
*
- *
If the action's run method throws an (unchecked)
+ *
If the action's {@code run} method throws an (unchecked) * exception, it will propagate through this method. * *
Note that any DomainCombiner associated with the current
@@ -281,9 +281,9 @@ public final class AccessController {
*
* @param action the action to be performed.
*
- * @return the value returned by the action's If the action's If the action's {@code run} method throws an (unchecked)
* exception, it will propagate through this method.
*
* This method preserves the current AccessControlContext's
@@ -307,9 +307,9 @@ public final class AccessController {
*
* @param action the action to be performed.
*
- * @return the value returned by the action's
- * If the action's
- * If the action's This method preserves the current AccessControlContext's
@@ -434,16 +434,16 @@ public final class AccessController {
* representing the restriction to be applied to the
* caller's domain's privileges before performing
* the specified action. If the context is
- * If the action's If the action's {@code run} method throws an unchecked
* exception, it will propagate through this method.
*
* Note that any DomainCombiner associated with the current
@@ -481,11 +481,11 @@ public final class AccessController {
*
* @param action the action to be performed
*
- * @return the value returned by the action's If the action's If the action's {@code run} method throws an unchecked
* exception, it will propagate through this method.
*
* This method preserves the current AccessControlContext's
@@ -511,11 +511,11 @@ public final class AccessController {
*
* @param action the action to be performed.
*
- * @return the value returned by the action's
- * If the action's
- * If the action's This method preserves the current AccessControlContext's
@@ -681,18 +681,18 @@ public final class AccessController {
* representing the restriction to be applied to the
* caller's domain's privileges before performing
* the specified action. If the context is
- * The object that will generate the parameters can be initialized
@@ -61,17 +61,17 @@ import java.security.spec.AlgorithmParameterSpec;
*
* In case the client does not explicitly initialize the
* AlgorithmParameterGenerator
- * (via a call to an Every implementation of the Java platform is required to support the
- * following standard All the abstract methods in this class must be implemented by each
@@ -37,7 +37,7 @@ import java.security.spec.AlgorithmParameterSpec;
* of a parameter generator for a particular algorithm.
*
* In case the client does not explicitly initialize the
- * AlgorithmParameterGenerator (via a call to an An An {@code AlgorithmParameters} object for managing the parameters
* for a particular algorithm can be obtained by
- * calling one of the Once an Once an {@code AlgorithmParameters} object is obtained, it must be
+ * initialized via a call to {@code init}, using an appropriate parameter
* specification or parameter encoding.
*
* A transparent parameter specification is obtained from an
- * Every implementation of the Java platform is required to support the
- * following standard The returned parameter object must be initialized via a call to
- * The returned parameter object must be initialized via a call to
- * The returned parameter object must be initialized via a call to
- * All the abstract methods in this class must be implemented by each
@@ -52,7 +52,7 @@ public abstract class AlgorithmParametersSpi {
/**
* Initializes this parameters object using the parameters
- * specified in While callers may invoke While callers may invoke {@code login} directly,
+ * the provider may also invoke {@code login} on behalf of callers
* if it determines that a login must be performed
* prior to certain operations.
*
@@ -56,11 +56,11 @@ public abstract class AuthProvider extends Provider {
/**
* Log in to this provider.
*
- * The provider relies on a The provider relies on a {@code CallbackHandler}
* to obtain authentication information from the caller
- * (a PIN, for example). If the caller passes a The provider uses this handler if one is not passed to the
- * BasicPermission objects must be stored in a manner that allows them
* to be inserted in any order, but that also enables the
- * PermissionCollection To complete the message digest computation, call one of the
- * It is possible to turn this stream on or off (see
* {@link #on(boolean) on}). When it is on, a call to one of the
- * To complete the message digest computation, call one of the
- * It is possible to turn this stream on or off (see
* {@link #on(boolean) on}). When it is on, a call to one of the
- * A A {@code DomainCombiner} is passed as a parameter to the
+ * appropriate constructor for {@code AccessControlContext}.
* The newly constructed context is then passed to the
- * The combine method takes two arguments. The first argument represents
* an array of ProtectionDomains from the current execution Thread,
- * since the most recent call to The The {@code combine} method investigates the two input arrays
* of ProtectionDomains and returns a single array containing the updated
- * ProtectionDomains. In the simplest case, the After the After the {@code AccessController.getContext} method
* receives the combined stack of ProtectionDomains back from
- * the
*
* @param assignedDomains an array of inherited ProtectionDomains.
* ProtectionDomains may be inherited from a parent Thread,
- * or from a privileged This interface represents a guard, which is an object that is used
* to protect access to another object.
*
- * This interface contains a single method, This interface contains a single method, {@code checkGuard},
+ * with a single {@code object} argument. {@code checkGuard} is
+ * invoked (by the GuardedObject {@code getObject} method)
* to determine whether or not to allow access to the object.
*
* @see GuardedObject
@@ -44,7 +44,7 @@ public interface Guard {
/**
* Determines whether or not to allow access to the guarded object
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "setIdentityPublicKey"}
* as its argument to see if it's ok to set the public key.
*
* @param key the public key for this identity.
@@ -174,7 +174,7 @@ public abstract class Identity implements Principal, Serializable {
* identity's scope has the same public key, or if another exception occurs.
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "setIdentityInfo"}
* as its argument to see if it's ok to specify the information string.
*
* @param info the information string.
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "addIdentityCertificate"}
* as its argument to see if it's ok to add a certificate.
*
* @param certificate the certificate to be added.
@@ -237,7 +237,7 @@ public abstract class Identity implements Principal, Serializable {
* this identity's public key, or if another exception occurs.
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "removeIdentityCertificate"}
* as its argument to see if it's ok to remove a certificate.
*
* @param certificate the certificate to be removed.
@@ -287,7 +287,7 @@ public abstract class Identity implements Principal, Serializable {
* missing, or if another exception occurs.
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "printIdentity"}
* as its argument to see if it's ok to return the string.
*
* @return information about this identity, such as its name and the
* name of its scope (if any).
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "printIdentity"}
* as its argument to see if it's ok to return the string.
*
* @param detailed whether or not to provide detailed information.
*
- * @return information about this identity. If First, if there is a security manager, its
- * Multiple compatible key specifications may exist for the same key.
* For example, a DSA public key may be specified using
- * The following is an example of how to use a key factory in order to
@@ -68,11 +68,11 @@ import sun.security.jca.GetInstance.Instance;
* Every implementation of the Java platform is required to support the
- * following standard Key factories are used to convert keys (opaque
- * cryptographic keys of type Multiple compatible key specifications may exist for the same key.
* For example, a DSA public key may be specified using
- * A provider should document all the key specifications supported by its
@@ -100,11 +100,11 @@ public abstract class KeyFactorySpi {
/**
* Returns a specification (key material) of the given key
* object.
- * Note that this constructor only stores references to the public
* and private key components in the generated key pair. This is safe,
- * because A Key pair generator for a particular algorithm creates a public/private
@@ -58,21 +58,21 @@ import sun.security.jca.GetInstance.Instance;
* {@link #initialize(int, java.security.SecureRandom) initialize}
* method in this KeyPairGenerator class that takes these two universally
* shared types of arguments. There is also one that takes just a
- * Since no other parameters are specified when you call the above
- * algorithm-independent If the algorithm is the DSA algorithm, and the keysize (modulus
* size) is 512, 768, or 1024, then the Sun provider uses a set of
- * precomputed values for the For situations where a set of algorithm-specific parameters already
* exists (e.g., so-called community parameters in DSA), there are two
* {@link #initialize(java.security.spec.AlgorithmParameterSpec)
- * initialize} methods that have an In case the client does not explicitly initialize the KeyPairGenerator
- * (via a call to an Note that this class is abstract and extends from
- * Every implementation of the Java platform is required to support the
- * following standard This concrete method has been added to this previously-defined
@@ -382,10 +382,10 @@ public abstract class KeyPairGenerator extends KeyPairGeneratorSpi {
* {@link KeyPairGeneratorSpi#initialize(
* java.security.spec.AlgorithmParameterSpec,
* java.security.SecureRandom) initialize} method,
- * passing it This class defines the Service Provider Interface (SPI)
- * for the All the abstract methods in this class must be implemented by each
@@ -37,7 +37,7 @@ import java.security.spec.AlgorithmParameterSpec;
* of a key pair generator for a particular algorithm.
*
* In case the client does not explicitly initialize the KeyPairGenerator
- * (via a call to an A A {@code KeyStore} manages different types of entries.
+ * Each type of entry implements the {@code KeyStore.Entry} interface.
+ * Three basic {@code KeyStore.Entry} implementations are provided:
*
* This type of entry holds a cryptographic This type of entry holds a cryptographic {@code PrivateKey},
* which is optionally stored in a protected format to prevent
* unauthorized access. It is also accompanied by a certificate chain
* for the corresponding public key.
@@ -58,12 +58,12 @@ import javax.security.auth.callback.*;
* and/or licensing software.
*
* This type of entry holds a cryptographic This type of entry holds a cryptographic {@code SecretKey},
* which is optionally stored in a protected format to prevent
* unauthorized access.
*
* This type of entry contains a single public key This type of entry contains a single public key {@code Certificate}
* belonging to another party. It is called a trusted certificate
* because the keystore owner trusts that the public key in the certificate
* indeed belongs to the identity identified by the subject (owner)
@@ -121,8 +121,8 @@ import javax.security.auth.callback.*;
* }
*
*
- * To create an empty keystore using the above Once the keystore has been loaded, it is possible
* to read existing entries from the keystore, or to write new entries
@@ -156,9 +156,9 @@ import javax.security.auth.callback.*;
* may also be used.
*
* Every implementation of the Java platform is required to support
- * the following standard The information stored in a The information stored in a {@code ProtectionParameter}
* object protects the contents of a keystore.
* For example, protection parameters may be used to check
* the integrity of keystore data, or to protect the
* confidentiality of sensitive keystore data
- * (such as a The specified The specified {@code password} is cloned before it is stored
+ * in the new {@code PasswordProtection} object.
*
- * @param password the password, which may be The specified The specified {@code chain} is cloned before it is stored
+ * in the new {@code PrivateKeyEntry} object.
*
- * @param privateKey the The stored chain is cloned before being returned.
*
- * @return an array of If the given alias name identifies an entry
- * created by a call to If the given alias name identifies an entry
- * created by a call to If the given key is of type If the given key is of type {@code java.security.PrivateKey},
* it must be accompanied by a certificate chain certifying the
* corresponding public key.
*
@@ -1251,7 +1251,7 @@ public class KeyStore {
* @param password the password to protect the key
* @param chain the certificate chain for the corresponding public
* key (only required if the given key is of type
- * If the protected key is of type
- * If the given alias already exists, the keystore information
* associated with it is overridden by the given key (and possibly
@@ -1292,7 +1292,7 @@ public class KeyStore {
* @param key the key (in protected format) to be associated with the alias
* @param chain the certificate chain for the corresponding public
* key (only useful if the protected key is of type
- * If the given alias identifies an existing entry
- * created by a call to This method attempts to match the given certificate with each
* keystore entry. If the entry being considered was
- * created by a call to If the entry being considered was
- * created by a call to In order to create an empty keystore, or if the keystore cannot
- * be initialized from a stream, pass Note that if this keystore has already been loaded, it is
* reinitialized and loaded again from the given input stream.
*
* @param stream the input stream from which the keystore is loaded,
- * or Note that if this KeyStore has already been loaded, it is
* reinitialized and loaded again from the given parameter.
*
- * @param param the If an entry already exists for the specified alias,
* it is overridden.
*
- * @param alias save the keystore This is useful if an existing KeyStore object needs to be
* used with Builder-based APIs.
@@ -1832,15 +1832,15 @@ public class KeyStore {
* Returns a new Builder object.
*
* The first call to the {@link #getKeyStore} method on the returned
- * builder will create a KeyStore of type Subsequent calls to {@link #getKeyStore} return the same object
@@ -1848,13 +1848,13 @@ public class KeyStore {
* KeyStoreException, subsequent calls also throw a
* KeyStoreException.
*
- * The KeyStore is instantiated from The KeyStore is instantiated from {@code provider} if
* non-null. Otherwise, all installed providers are searched.
*
* Calls to {@link #getProtectionParameter getProtectionParameter()}
* will return a {@link KeyStore.PasswordProtection PasswordProtection}
* object encapsulating the password that was used to invoke the
- * Note that the {@link #getKeyStore} method is executed
* within the {@link AccessControlContext} of the code invoking this
@@ -2013,17 +2013,17 @@ public class KeyStore {
* Returns a new Builder object.
*
* Each call to the {@link #getKeyStore} method on the returned
- * builder will return a new KeyStore object of type The KeyStore is instantiated from The KeyStore is instantiated from {@code provider} if
* non-null. Otherwise, all installed providers are searched.
*
* Calls to {@link #getProtectionParameter getProtectionParameter()}
- * will return Note that the {@link #getKeyStore} method is executed
* within the {@link AccessControlContext} of the code invoking this
diff --git a/src/share/classes/java/security/KeyStoreException.java b/src/share/classes/java/security/KeyStoreException.java
index 707a558037bd1c346de347e8577de11863dcd902..cf56d6aa54264bc2e26195db4ea43e170b935103 100644
--- a/src/share/classes/java/security/KeyStoreException.java
+++ b/src/share/classes/java/security/KeyStoreException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -59,13 +59,13 @@ public class KeyStoreException extends GeneralSecurityException {
}
/**
- * Creates a If the given alias name identifies an entry
- * created by a call to If the given alias name identifies an entry
- * created by a call to If the given key is of type If the given key is of type {@code java.security.PrivateKey},
* it must be accompanied by a certificate chain certifying the
* corresponding public key.
*
@@ -139,7 +139,7 @@ public abstract class KeyStoreSpi {
* @param password the password to protect the key
* @param chain the certificate chain for the corresponding public
* key (only required if the given key is of type
- * If the protected key is of type
- * If the given alias identifies an existing entry
- * created by a call to This method attempts to match the given certificate with each
* keystore entry. If the entry being considered was
- * created by a call to If the entry being considered was
- * created by a call to Note that if this KeyStore has already been loaded, it is
* reinitialized and loaded again from the given parameter.
*
- * @param param the If an entry already exists for the specified alias,
* it is overridden.
*
- * @param alias save the The The {@code digest} method can be called once for a given number
+ * of updates. After {@code digest} has been called, the MessageDigest
* object is reset to its initialized state.
*
* Implementations are free to implement the Cloneable interface.
@@ -75,18 +75,18 @@ import java.nio.ByteBuffer;
* several instances, if the number of digests is known in advance.
*
* Note that this class is abstract and extends from
- * Every implementation of the Java platform is required to support
- * the following standard Most Permission objects also include an "actions" list that tells the actions
* that are permitted for the object. For example,
- * for a An important method that must be implemented by each subclass is
- * the The The {@code implies} method is used by the AccessController to determine
* whether or not a requested permission is implied by another permission that
* is known to be valid in the current execution context.
*
@@ -124,8 +124,8 @@ public abstract class Permission implements Guard, java.io.Serializable {
/**
* Checks two Permission objects for equality.
*
- * Do not use the
- * The required
*
* With a PermissionCollection, you can:
*
*
* When it is desirable to group together a number of Permission objects
- * of the same type, the The PermissionCollection returned by the
- * Whenever a permission is added to a heterogeneous PermissionCollection
* such as Permissions, and the PermissionCollection doesn't yet contain a
* PermissionCollection of the specified permission's type, the
* PermissionCollection should call
- * the Subclass implementations of PermissionCollection should assume
* that they may be called simultaneously from multiple threads,
* and therefore should be synchronized properly. Furthermore,
- * Enumerations returned via the By default, the object is not readonly. It can be set to
- * readonly by a call to When the When the {@code add} method is called to add a Permission, the
* Permission is stored in the appropriate PermissionCollection. If no such
* collection exists yet, the Permission object's class is determined and the
- * Enumerations returned via the Enumerations returned via the {@code elements} method are
* not fail-fast. Modifications to a collection should not be
* performed while enumerating over that collection.
*
@@ -155,9 +155,9 @@ implements Serializable
* "read" access for all files in all subdirectories of the "/tmp"
* directory, and another FilePermission that specifies "write" access
* for all files in the "/tmp/scratch/foo" directory.
- * Then if the Additionally, if this PermissionCollection contains the
@@ -214,11 +214,11 @@ implements Serializable
* If createEmpty is true,
* this method creates a new PermissionCollection object for the specified
* type of permission objects if one does not yet exist.
- * To do so, it first calls the There is only one Policy object installed in the runtime at any
* given time. A Policy object can be installed by calling the
- * If no Policy object has been installed in the runtime, a call to
- * Application code can directly subclass Policy to provide a custom
* implementation. In addition, an instance of a Policy object can be
- * constructed by invoking one of the Once a Policy instance has been installed (either by default, or by
- * calling The The {@code refresh} method causes the policy object to
* refresh/reload its data. This operation is implementation-dependent.
* For example, if the policy object stores its data in configuration files,
- * calling This Policy instance will only have a Provider if it
- * was obtained via a call to This Policy instance will only have a type if it
- * was obtained via a call to This Policy instance will only have parameters if it
- * was obtained via a call to Applications are discouraged from calling this method
* since this operation may not be supported by all policy implementations.
- * Applications should solely rely on the The default implementation of this method returns
* Policy.UNSUPPORTED_EMPTY_COLLECTION. This method can be
@@ -613,15 +613,15 @@ public abstract class Policy {
*
* Applications are discouraged from calling this method
* since this operation may not be supported by all policy implementations.
- * Applications should rely on the The default implementation of this method first retrieves
- * the permissions returned via The default implementation of this method does nothing.
@@ -794,8 +794,8 @@ public abstract class Policy {
/**
* This class represents a read-only empty PermissionCollection object that
- * is returned from the Subclass implementations of this abstract class must provide
- * a public constructor that takes a The default implementation of this method does nothing.
diff --git a/src/share/classes/java/security/PrivilegedAction.java b/src/share/classes/java/security/PrivilegedAction.java
index 4ace38f94f837ec9855b98ba6dfce8668346945a..b993cea4d2f8d64c3d5fbd853480df8e69ee821d 100644
--- a/src/share/classes/java/security/PrivilegedAction.java
+++ b/src/share/classes/java/security/PrivilegedAction.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -28,10 +28,10 @@ package java.security;
/**
* A computation to be performed with privileges enabled. The computation is
- * performed by invoking As of release 1.4, this exception has been retrofitted to conform to
@@ -69,14 +69,14 @@ public class PrivilegedActionException extends Exception {
/**
* Returns the exception thrown by the privileged computation that
- * resulted in this This method predates the general-purpose exception chaining facility.
* The {@link Throwable#getCause()} method is now the preferred means of
* obtaining this information.
*
* @return the exception thrown by the privileged computation that
- * resulted in this The service type The service type {@code Provider} is reserved for use by the
* security framework. Services of this type cannot be added, removed,
* or modified by applications.
* The following attributes are automatically placed in each Provider object:
* First, if there is a security manager, its
- * First, if there is a security manager, its
- * First, if there is a security manager, its
- * Also, if there is a security manager, its
- * Also, if there is a security manager, its
- * If there is a security manager, this method first
- * calls the security manager's
* @param parent the parent ClassLoader
* @exception SecurityException if a security manager exists and its
- * If there is a security manager, this method first
- * calls the security manager's
- * @param name the expected name of the class, or
* If a non-null CodeSource is supplied a ProtectionDomain is
* constructed and associated with the class being defined.
*
- * @param name the expected name of the class, or A caller obtains a SecureRandom instance via the
- * no-argument constructor or one of the Callers may also invoke the Callers may also invoke the {@code generateSeed} method
* to generate a given number of seed bytes (to seed other random number
* generators, for example):
* The returned SecureRandom object has not been seeded. To seed the
- * returned object, call the The returned SecureRandom object has not been seeded. To seed the
- * returned object, call the The returned SecureRandom object has not been seeded. To seed the
- * returned object, call the The returned SecureRandom object has not been seeded. To seed the
- * returned object, call the This method is defined for compatibility with
- * If a call to If a call to {@code setSeed} had not occurred previously,
* the first call to this method forces this SecureRandom object
* to seed itself. This self-seeding will not occur if
- * This method is only included for backwards compatibility.
* The caller is encouraged to use one of the alternative
- * If a call to If a call to {@code engineSetSeed} had not occurred previously,
* the first call to this method forces this SecureRandom implementation
* to seed itself. This self-seeding will not occur if
- * If the given provider is installed at the requested position,
* the provider that used to be at that position, and all providers
- * with a position greater than A provider cannot be added if it is already installed.
*
* First, if there is a security manager, its
- * First, if there is a security manager, its
- * First, if there is a security manager, its
- * First, if there is a security manager, its
- * First, if there is a security manager, its
- * The signature algorithm can be, among others, the NIST standard
* DSA, using DSA and SHA-1. The DSA algorithm using the
- * SHA-1 message digest algorithm can be specified as SHA1withDSA.
+ * SHA-1 message digest algorithm can be specified as {@code SHA1withDSA}.
* In the case of RSA, there are multiple choices for the message digest
* algorithm, so the signing algorithm could be specified as, for example,
- * MD2withRSA, MD5withRSA, or SHA1withRSA.
+ * {@code MD2withRSA}, {@code MD5withRSA}, or {@code SHA1withRSA}.
* The algorithm name must be specified, as there is no default.
*
* A Signature object can be used to generate and verify digital
@@ -92,18 +92,18 @@ import sun.security.jca.GetInstance.Instance;
*
*
* Note that this class is abstract and extends from
- * Every implementation of the Java platform is required to support the
- * following standard A call to this method resets this signature object to the state
* it was in when previously initialized for signing via a
- * call to This signature object is reset to its initial state (the state it
- * was in after a call to one of the A call to this method resets this signature object to the state
* it was in when previously initialized for verification via a
- * call to A call to this method resets this signature object to the state
* it was in when previously initialized for verification via a
- * call to The signature implementation is reset to its initial state
* (the state it was in after a call to one of the
- * The underlying signing algorithm is designated by the Signature
- * object passed to the constructor and the A typical usage for verification is the following (having
- * received SignedObject Several points are worth noting. First, there is no need to
* initialize the signing or verification engine, as it will be
- * re-initialized inside the constructor and the More importantly, for flexibility reasons, the
- * constructor and The signature algorithm can be, among others, the NIST standard
@@ -92,7 +92,7 @@ import java.io.*;
*
* The name of the Cryptography Package Provider is designated
* also by the Signature parameter to the constructor and the
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "getSignerPrivateKey"}
* as its argument to see if it's ok to return the private key.
*
* @return this signer's private key, or null if the private key has
* not yet been set.
*
* @exception SecurityException if a security manager exists and its
- * First, if there is a security manager, its First, if there is a security manager, its {@code checkSecurityAccess}
+ * method is called with {@code "setSignerKeyPair"}
* as its argument to see if it's ok to set the key pair.
*
* @param pair an initialized key pair.
@@ -124,7 +124,7 @@ public abstract class Signer extends Identity {
* @exception KeyException if the key pair cannot be set for any
* other reason.
* @exception SecurityException if a security manager exists and its
- * The newly created permission object replaces the
* UnresolvedPermission, which is removed.
*
- * Note that the Note that the {@code getName} method for an
+ * {@code UnresolvedPermission} returns the
+ * {@code type} (class name) for the underlying permission
* that has not been resolved.
*
* @see java.security.Permission
@@ -440,7 +440,7 @@ implements java.io.Serializable
* has not been resolved.
*
* @return the target name of the underlying permission that
- * has not been resolved, or
*
- * The The The {@code initialize} methods may each be called any number
+ * of times. If no {@code initialize} method is called on a
* DSAKeyPairGenerator, the default is to generate 1024-bit keys, using
* precomputed p, q and g parameters and an instance of SecureRandom as
* the random bit source.
@@ -42,22 +42,22 @@ import java.security.*;
*
*
*
+ * {@code initialize} methods from this DSAKeyPairGenerator interface.
*
- * Note: it is not always necessary to do do algorithm-specific
* initialization for a DSA key pair generator. That is, it is not always
- * necessary to call an If If {@code genParams} is true, this method generates new
* p, q and g parameters. If it is false, the method uses precomputed
* parameters for the modulus length requested. If there are no
* precomputed parameters for that modulus length, an exception will be
@@ -108,8 +108,8 @@ public interface DSAKeyPairGenerator {
* @param genParams whether or not to generate new parameters for
* the modulus length requested.
*
- * @exception InvalidParameterException if
+ * Note that these interfaces are intended only for key
+ * implementations whose key material is accessible and
+ * available. These interfaces are not intended for key
+ * implementations whose key material resides in
+ * inaccessible, protected storage (such as in a
+ * hardware device).
+ *
+ * For more developer information on how to use these
+ * interfaces, including information on how to design
+ * {@code Key} classes for hardware devices, please refer
+ * to these cryptographic provider developer guides:
+ *
-Note that these interfaces are intended only for key
-implementations whose key material is accessible and
-available. These interfaces are not intended for key
-implementations whose key material resides in
-inaccessible, protected storage (such as in a
-hardware device).
-
-For more developer information on how to use these
-interfaces, including information on how to design
- A key specification is a transparent representation of the key material
+ * that constitutes a key. A key may be specified in an algorithm-specific
+ * way, or in an algorithm-independent encoding format (such as ASN.1).
+ * This package contains key specifications for DSA public and private keys,
+ * RSA public and private keys, PKCS #8 private keys in DER-encoded format,
+ * and X.509 public and private keys in DER-encoded format.
+ *
+ * An algorithm parameter specification is a transparent representation
+ * of the sets of parameters used with an algorithm. This package contains
+ * an algorithm parameter specification for parameters used with the
+ * DSA algorithm.
+ *
+ * A key specification is a transparent representation of the key material
-that constitutes a key. A key may be specified in an algorithm-specific
-way, or in an algorithm-independent encoding format (such as ASN.1).
-This package contains key specifications for DSA public and private keys,
-RSA public and private keys, PKCS #8 private keys in DER-encoded format,
-and X.509 public and private keys in DER-encoded format.
-
- An algorithm parameter specification is a transparent representation
-of the sets of parameters used with an algorithm. This package contains
-an algorithm parameter specification for parameters used with the
-DSA algorithm.
-
-run method.
+ * @return the value returned by the action's {@code run} method.
*
- * @exception NullPointerException if the action is null
+ * @exception NullPointerException if the action is {@code null}
*
* @see #doPrivileged(PrivilegedAction,AccessControlContext)
* @see #doPrivileged(PrivilegedExceptionAction)
@@ -295,11 +295,11 @@ public final class AccessController {
public static native PrivilegedAction with privileges
+ * Performs the specified {@code PrivilegedAction} with privileges
* enabled. The action is performed with all of the permissions
* possessed by the caller's protection domain.
*
- * run method throws an (unchecked)
+ * run method.
+ * @return the value returned by the action's {@code run} method.
*
- * @exception NullPointerException if the action is null
+ * @exception NullPointerException if the action is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see java.security.DomainCombiner
@@ -364,17 +364,17 @@ public final class AccessController {
/**
- * Performs the specified PrivilegedAction with privileges
+ * Performs the specified {@code PrivilegedAction} with privileges
* enabled and restricted by the specified
- * AccessControlContext and with a privilege scope limited
- * by specified Permission arguments.
+ * {@code AccessControlContext} and with a privilege scope limited
+ * by specified {@code Permission} arguments.
*
* The action is performed with the intersection of the permissions
* possessed by the caller's protection domain, and those possessed
* by the domains represented by the specified
- * AccessControlContext.
+ * {@code AccessControlContext}.
* run method throws an (unchecked) exception,
+ * If the action's {@code run} method throws an (unchecked) exception,
* it will propagate through this method.
*
* @param action the action to be performed.
@@ -382,16 +382,16 @@ public final class AccessController {
* representing the restriction to be applied to the
* caller's domain's privileges before performing
* the specified action. If the context is
- * null,
+ * {@code null},
* then no additional restriction is applied.
- * @param perms the Permission arguments which limit the
+ * @param perms the {@code Permission} arguments which limit the
* scope of the caller's privileges. The number of arguments
* is variable.
*
- * @return the value returned by the action's run method.
+ * @return the value returned by the action's {@code run} method.
*
* @throws NullPointerException if action or perms or any element of
- * perms is null
+ * perms is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedExceptionAction,AccessControlContext)
@@ -413,17 +413,17 @@ public final class AccessController {
/**
- * Performs the specified PrivilegedAction with privileges
+ * Performs the specified {@code PrivilegedAction} with privileges
* enabled and restricted by the specified
- * AccessControlContext and with a privilege scope limited
- * by specified Permission arguments.
+ * {@code AccessControlContext} and with a privilege scope limited
+ * by specified {@code Permission} arguments.
*
* The action is performed with the intersection of the permissions
* possessed by the caller's protection domain, and those possessed
* by the domains represented by the specified
- * AccessControlContext.
+ * {@code AccessControlContext}.
* run method throws an (unchecked) exception,
+ * If the action's {@code run} method throws an (unchecked) exception,
* it will propagate through this method.
*
* null,
+ * {@code null},
* then no additional restriction is applied.
- * @param perms the Permission arguments which limit the
+ * @param perms the {@code Permission} arguments which limit the
* scope of the caller's privileges. The number of arguments
* is variable.
*
- * @return the value returned by the action's run method.
+ * @return the value returned by the action's {@code run} method.
*
* @throws NullPointerException if action or perms or any element of
- * perms is null
+ * perms is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedExceptionAction,AccessControlContext)
@@ -469,11 +469,11 @@ public final class AccessController {
}
/**
- * Performs the specified PrivilegedExceptionAction with
+ * Performs the specified {@code PrivilegedExceptionAction} with
* privileges enabled. The action is performed with all of the
* permissions possessed by the caller's protection domain.
*
- * run method throws an unchecked
+ * run method
+ * @return the value returned by the action's {@code run} method
*
* @exception PrivilegedActionException if the specified action's
- * run method threw a checked exception
- * @exception NullPointerException if the action is null
+ * {@code run} method threw a checked exception
+ * @exception NullPointerException if the action is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedExceptionAction,AccessControlContext)
@@ -499,11 +499,11 @@ public final class AccessController {
/**
- * Performs the specified PrivilegedExceptionAction with
+ * Performs the specified {@code PrivilegedExceptionAction} with
* privileges enabled. The action is performed with all of the
* permissions possessed by the caller's protection domain.
*
- * run method throws an unchecked
+ * run method
+ * @return the value returned by the action's {@code run} method
*
* @exception PrivilegedActionException if the specified action's
- * run method threw a checked exception
- * @exception NullPointerException if the action is null
+ * {@code run} method threw a checked exception
+ * @exception NullPointerException if the action is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedExceptionAction,AccessControlContext)
@@ -609,17 +609,17 @@ public final class AccessController {
/**
- * Performs the specified PrivilegedExceptionAction with
+ * Performs the specified {@code PrivilegedExceptionAction} with
* privileges enabled and restricted by the specified
- * AccessControlContext and with a privilege scope limited by
- * specified Permission arguments.
+ * {@code AccessControlContext} and with a privilege scope limited by
+ * specified {@code Permission} arguments.
*
* The action is performed with the intersection of the permissions
* possessed by the caller's protection domain, and those possessed
* by the domains represented by the specified
- * AccessControlContext.
+ * {@code AccessControlContext}.
* run method throws an (unchecked) exception,
+ * If the action's {@code run} method throws an (unchecked) exception,
* it will propagate through this method.
*
* @param action the action to be performed.
@@ -627,18 +627,18 @@ public final class AccessController {
* representing the restriction to be applied to the
* caller's domain's privileges before performing
* the specified action. If the context is
- * null,
+ * {@code null},
* then no additional restriction is applied.
- * @param perms the Permission arguments which limit the
+ * @param perms the {@code Permission} arguments which limit the
* scope of the caller's privileges. The number of arguments
* is variable.
*
- * @return the value returned by the action's run method.
+ * @return the value returned by the action's {@code run} method.
*
* @throws PrivilegedActionException if the specified action's
- * run method threw a checked exception
+ * {@code run} method threw a checked exception
* @throws NullPointerException if action or perms or any element of
- * perms is null
+ * perms is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedAction,AccessControlContext)
@@ -660,17 +660,17 @@ public final class AccessController {
/**
- * Performs the specified PrivilegedExceptionAction with
+ * Performs the specified {@code PrivilegedExceptionAction} with
* privileges enabled and restricted by the specified
- * AccessControlContext and with a privilege scope limited by
- * specified Permission arguments.
+ * {@code AccessControlContext} and with a privilege scope limited by
+ * specified {@code Permission} arguments.
*
* The action is performed with the intersection of the permissions
* possessed by the caller's protection domain, and those possessed
* by the domains represented by the specified
- * AccessControlContext.
+ * {@code AccessControlContext}.
* run method throws an (unchecked) exception,
+ * If the action's {@code run} method throws an (unchecked) exception,
* it will propagate through this method.
*
* null,
+ * {@code null},
* then no additional restriction is applied.
- * @param perms the Permission arguments which limit the
+ * @param perms the {@code Permission} arguments which limit the
* scope of the caller's privileges. The number of arguments
* is variable.
*
- * @return the value returned by the action's run method.
+ * @return the value returned by the action's {@code run} method.
*
* @throws PrivilegedActionException if the specified action's
- * run method threw a checked exception
+ * {@code run} method threw a checked exception
* @throws NullPointerException if action or perms or any element of
- * perms is null
+ * perms is {@code null}
*
* @see #doPrivileged(PrivilegedAction)
* @see #doPrivileged(PrivilegedAction,AccessControlContext)
@@ -770,14 +770,14 @@ public final class AccessController {
* This method quietly returns if the access request
* is permitted, or throws an AccessControlException otherwise. The
* getPermission method of the AccessControlException returns the
- * perm Permission object instance.
+ * {@code perm} Permission object instance.
*
* @param perm the requested permission.
*
* @exception AccessControlException if the specified permission
* is not permitted, based on the current security policy.
* @exception NullPointerException if the specified permission
- * is null and is checked based on the
+ * is {@code null} and is checked based on the
* security policy currently in effect.
*/
diff --git a/src/share/classes/java/security/AlgorithmParameterGenerator.java b/src/share/classes/java/security/AlgorithmParameterGenerator.java
index b85eac0dc0be6cc56590fd88097a44dd122afbc0..307aaaf17eb48b2a65f14cdf58168041b36c1913 100644
--- a/src/share/classes/java/security/AlgorithmParameterGenerator.java
+++ b/src/share/classes/java/security/AlgorithmParameterGenerator.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -28,10 +28,10 @@ package java.security;
import java.security.spec.AlgorithmParameterSpec;
/**
- * The AlgorithmParameterGenerator class is used to generate a
+ * The {@code AlgorithmParameterGenerator} class is used to generate a
* set of
* parameters to be used with a certain algorithm. Parameter generators
- * are constructed using the getInstance factory methods
+ * are constructed using the {@code getInstance} factory methods
* (static methods that return instances of a given class).
*
* init method), each provider must supply (and
+ * (via a call to an {@code init} method), each provider must supply (and
* document) a default initialization. For example, the Sun provider uses a
* default modulus prime size of 1024 bits for the generation of DSA
* parameters.
*
* AlgorithmParameterGenerator algorithms and
+ * following standard {@code AlgorithmParameterGenerator} algorithms and
* keysizes in parentheses:
*
- *
* These algorithms are described in the
@@ -272,11 +272,11 @@ public class AlgorithmParameterGenerator {
/**
* Initializes this parameter generator for a certain size.
- * To create the parameters, the SecureRandom
+ * To create the parameters, the {@code SecureRandom}
* implementation of the highest-priority installed provider is used as
* the source of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness is
+ * {@code SecureRandom}, a system-provided source of randomness is
* used.)
*
* @param size the size (number of bits).
@@ -299,11 +299,11 @@ public class AlgorithmParameterGenerator {
/**
* Initializes this parameter generator with a set of algorithm-specific
* parameter generation values.
- * To generate the parameters, the SecureRandom
+ * To generate the parameters, the {@code SecureRandom}
* implementation of the highest-priority installed provider is used as
* the source of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness is
+ * {@code SecureRandom}, a system-provided source of randomness is
* used.)
*
* @param genParamSpec the set of algorithm-specific parameter generation values.
diff --git a/src/share/classes/java/security/AlgorithmParameterGeneratorSpi.java b/src/share/classes/java/security/AlgorithmParameterGeneratorSpi.java
index 729470ab85c95cf017dd494dc55659a775238fa6..721fb52ac180726506bf4a263a6d2e821203346a 100644
--- a/src/share/classes/java/security/AlgorithmParameterGeneratorSpi.java
+++ b/src/share/classes/java/security/AlgorithmParameterGeneratorSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -29,7 +29,7 @@ import java.security.spec.AlgorithmParameterSpec;
/**
* This class defines the Service Provider Interface (SPI)
- * for the AlgorithmParameterGenerator class, which
+ * for the {@code AlgorithmParameterGenerator} class, which
* is used to generate a set of parameters to be used with a certain algorithm.
*
* engineInit
+ * AlgorithmParameterGenerator (via a call to an {@code engineInit}
* method), each provider must supply (and document) a default initialization.
* For example, the Sun provider uses a default modulus prime size of 1024
* bits for the generation of DSA parameters.
diff --git a/src/share/classes/java/security/AlgorithmParameters.java b/src/share/classes/java/security/AlgorithmParameters.java
index 36ba66eb38b3b26f40fcbbfce1b48cdb21d52dba..c603a196c9f003981a0d01f188c608be1616484a 100644
--- a/src/share/classes/java/security/AlgorithmParameters.java
+++ b/src/share/classes/java/security/AlgorithmParameters.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -32,28 +32,28 @@ import java.security.spec.InvalidParameterSpecException;
/**
* This class is used as an opaque representation of cryptographic parameters.
*
- * AlgorithmParameters object for managing the parameters
+ * getInstance factory methods
+ * calling one of the {@code getInstance} factory methods
* (static methods that return instances of a given class).
*
- * AlgorithmParameters object is obtained, it must be
- * initialized via a call to init, using an appropriate parameter
+ * AlgorithmParameters object via a call to
- * getParameterSpec, and a byte encoding of the parameters is
- * obtained via a call to getEncoded.
+ * {@code AlgorithmParameters} object via a call to
+ * {@code getParameterSpec}, and a byte encoding of the parameters is
+ * obtained via a call to {@code getEncoded}.
*
* AlgorithmParameters algorithms:
+ * following standard {@code AlgorithmParameters} algorithms:
*
- *
* These algorithms are described in the
@@ -123,7 +123,7 @@ public class AlgorithmParameters {
* the {@link Security#getProviders() Security.getProviders()} method.
*
* init, using an appropriate parameter specification or
+ * {@code init}, using an appropriate parameter specification or
* parameter encoding.
*
* @param algorithm the name of the algorithm requested.
@@ -165,7 +165,7 @@ public class AlgorithmParameters {
* the {@link Security#getProviders() Security.getProviders()} method.
*
* init, using an appropriate parameter specification or
+ * {@code init}, using an appropriate parameter specification or
* parameter encoding.
*
* @param algorithm the name of the algorithm requested.
@@ -212,7 +212,7 @@ public class AlgorithmParameters {
* does not have to be registered in the provider list.
*
* init, using an appropriate parameter specification or
+ * {@code init}, using an appropriate parameter specification or
* parameter encoding.
*
* @param algorithm the name of the algorithm requested.
@@ -259,7 +259,7 @@ public class AlgorithmParameters {
/**
* Initializes this parameter object using the parameters
- * specified in paramSpec.
+ * specified in {@code paramSpec}.
*
* @param paramSpec the parameter specification.
*
@@ -295,9 +295,9 @@ public class AlgorithmParameters {
}
/**
- * Imports the parameters from params and decodes them
+ * Imports the parameters from {@code params} and decodes them
* according to the specified decoding scheme.
- * If format is null, the
+ * If {@code format} is null, the
* primary decoding format for parameters is used. The primary decoding
* format is ASN.1, if an ASN.1 specification for these parameters
* exists.
@@ -318,11 +318,11 @@ public class AlgorithmParameters {
/**
* Returns a (transparent) specification of this parameter object.
- * paramSpec identifies the specification class in which
+ * {@code paramSpec} identifies the specification class in which
* the parameters should be returned. It could, for example, be
- * DSAParameterSpec.class, to indicate that the
+ * {@code DSAParameterSpec.class}, to indicate that the
* parameters should be returned in an instance of the
- * DSAParameterSpec class.
+ * {@code DSAParameterSpec} class.
*
* @param paramSpec the specification class in which
* the parameters should be returned.
@@ -363,7 +363,7 @@ public class AlgorithmParameters {
/**
* Returns the parameters encoded in the specified scheme.
- * If format is null, the
+ * If {@code format} is null, the
* primary encoding format for parameters is used. The primary encoding
* format is ASN.1, if an ASN.1 specification for these parameters
* exists.
diff --git a/src/share/classes/java/security/AlgorithmParametersSpi.java b/src/share/classes/java/security/AlgorithmParametersSpi.java
index 17db77ed28dc881fabe0f8211c4bc6809b594291..be231a4cafe1b60e336cb786e6f2ae63dc5b009f 100644
--- a/src/share/classes/java/security/AlgorithmParametersSpi.java
+++ b/src/share/classes/java/security/AlgorithmParametersSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -31,7 +31,7 @@ import java.security.spec.InvalidParameterSpecException;
/**
* This class defines the Service Provider Interface (SPI)
- * for the AlgorithmParameters class, which is used to manage
+ * for the {@code AlgorithmParameters} class, which is used to manage
* algorithm parameters.
*
* paramSpec.
+ * specified in {@code paramSpec}.
*
* @param paramSpec the parameter specification.
*
@@ -77,9 +77,9 @@ public abstract class AlgorithmParametersSpi {
throws IOException;
/**
- * Imports the parameters from params and
+ * Imports the parameters from {@code params} and
* decodes them according to the specified decoding format.
- * If format is null, the
+ * If {@code format} is null, the
* primary decoding format for parameters is used. The primary decoding
* format is ASN.1, if an ASN.1 specification for these parameters
* exists.
@@ -96,11 +96,11 @@ public abstract class AlgorithmParametersSpi {
/**
* Returns a (transparent) specification of this parameters
* object.
- * paramSpec identifies the specification class in which
+ * {@code paramSpec} identifies the specification class in which
* the parameters should be returned. It could, for example, be
- * DSAParameterSpec.class, to indicate that the
+ * {@code DSAParameterSpec.class}, to indicate that the
* parameters should be returned in an instance of the
- * DSAParameterSpec class.
+ * {@code DSAParameterSpec} class.
*
* @param paramSpec the specification class in which
* the parameters should be returned.
@@ -128,7 +128,7 @@ public abstract class AlgorithmParametersSpi {
/**
* Returns the parameters encoded in the specified format.
- * If format is null, the
+ * If {@code format} is null, the
* primary encoding format for parameters is used. The primary encoding
* format is ASN.1, if an ASN.1 specification for these parameters
* exists.
diff --git a/src/share/classes/java/security/AllPermission.java b/src/share/classes/java/security/AllPermission.java
index 5ca8b2ad91a2eff3950959f4837bff1c5525ebc8..c01b134f074cd08794215fce520e91e2f3a771a1 100644
--- a/src/share/classes/java/security/AllPermission.java
+++ b/src/share/classes/java/security/AllPermission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -69,7 +69,7 @@ public final class AllPermission extends Permission {
/**
* Creates a new AllPermission object. This
- * constructor exists for use by the Policy object
+ * constructor exists for use by the {@code Policy} object
* to instantiate new Permission objects.
*
* @param name ignored
diff --git a/src/share/classes/java/security/AuthProvider.java b/src/share/classes/java/security/AuthProvider.java
index fe37d5c3c60656ae17b0922e0d14fddf11cf87ec..a5310aa9f4279faca11d3b74fe2ac46ffcf9b5b3 100644
--- a/src/share/classes/java/security/AuthProvider.java
+++ b/src/share/classes/java/security/AuthProvider.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -32,8 +32,8 @@ import javax.security.auth.callback.CallbackHandler;
/**
* This class defines login and logout methods for a provider.
*
- * login directly,
- * the provider may also invoke login on behalf of callers
+ * CallbackHandler
+ * null
+ * (a PIN, for example). If the caller passes a {@code null}
* handler to this method, the provider uses the handler set in the
- * setCallbackHandler method.
+ * {@code setCallbackHandler} method.
* If no handler was set in that method, the provider queries the
* auth.login.defaultCallbackHandler security property
* for the fully qualified class name of a default handler implementation.
@@ -68,21 +68,21 @@ public abstract class AuthProvider extends Provider {
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
- * @param subject the Subject which may contain
+ * @param subject the {@code Subject} which may contain
* principals/credentials used for authentication,
* or may be populated with additional principals/credentials
* after successful authentication has completed.
- * This parameter may be null.
- * @param handler the CallbackHandler used by
+ * This parameter may be {@code null}.
+ * @param handler the {@code CallbackHandler} used by
* this provider to obtain authentication information
- * from the caller, which may be null
+ * from the caller, which may be {@code null}
*
* @exception LoginException if the login operation fails
* @exception SecurityException if the caller does not pass a
* security check for
- * SecurityPermission("authProvider.name"),
- * where name is the value returned by
- * this provider's getName method
+ * {@code SecurityPermission("authProvider.name")},
+ * where {@code name} is the value returned by
+ * this provider's {@code getName} method
*/
public abstract void login(Subject subject, CallbackHandler handler)
throws LoginException;
@@ -93,18 +93,18 @@ public abstract class AuthProvider extends Provider {
* @exception LoginException if the logout operation fails
* @exception SecurityException if the caller does not pass a
* security check for
- * SecurityPermission("authProvider.name"),
- * where name is the value returned by
- * this provider's getName method
+ * {@code SecurityPermission("authProvider.name")},
+ * where {@code name} is the value returned by
+ * this provider's {@code getName} method
*/
public abstract void logout() throws LoginException;
/**
- * Set a CallbackHandler.
+ * Set a {@code CallbackHandler}.
*
* login method. The provider also uses this handler
- * if it invokes login on behalf of callers.
+ * {@code login} method. The provider also uses this handler
+ * if it invokes {@code login} on behalf of callers.
* In either case if a handler is not set via this method,
* the provider queries the
* auth.login.defaultCallbackHandler security property
@@ -113,14 +113,14 @@ public abstract class AuthProvider extends Provider {
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
- * @param handler a CallbackHandler for obtaining
- * authentication information, which may be null
+ * @param handler a {@code CallbackHandler} for obtaining
+ * authentication information, which may be {@code null}
*
* @exception SecurityException if the caller does not pass a
* security check for
- * SecurityPermission("authProvider.name"),
- * where name is the value returned by
- * this provider's getName method
+ * {@code SecurityPermission("authProvider.name")},
+ * where {@code name} is the value returned by
+ * this provider's {@code getName} method
*/
public abstract void setCallbackHandler(CallbackHandler handler);
}
diff --git a/src/share/classes/java/security/BasicPermission.java b/src/share/classes/java/security/BasicPermission.java
index 439eefa83f1948b0e45bda4f658b1b12d586a014..2d0c96665eefb1b1f7383994d10b1d9610e1634c 100644
--- a/src/share/classes/java/security/BasicPermission.java
+++ b/src/share/classes/java/security/BasicPermission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -124,8 +124,8 @@ public abstract class BasicPermission extends Permission
*
* @param name the name of the BasicPermission.
*
- * @throws NullPointerException if name is null.
- * @throws IllegalArgumentException if name is empty.
+ * @throws NullPointerException if {@code name} is {@code null}.
+ * @throws IllegalArgumentException if {@code name} is empty.
*/
public BasicPermission(String name) {
super(name);
@@ -141,8 +141,8 @@ public abstract class BasicPermission extends Permission
* @param name the name of the BasicPermission.
* @param actions ignored.
*
- * @throws NullPointerException if name is null.
- * @throws IllegalArgumentException if name is empty.
+ * @throws NullPointerException if {@code name} is {@code null}.
+ * @throws IllegalArgumentException if {@code name} is empty.
*/
public BasicPermission(String name, String actions) {
super(name);
@@ -217,7 +217,7 @@ public abstract class BasicPermission extends Permission
/**
* Returns the hash code value for this object.
* The hash code used is the hash code of the name, that is,
- * getName().hashCode(), where getName is
+ * {@code getName().hashCode()}, where {@code getName} is
* from the Permission superclass.
*
* @return a hash code value for this object.
@@ -243,7 +243,7 @@ public abstract class BasicPermission extends Permission
*
* implies method
+ * PermissionCollection {@code implies} method
* to be implemented in an efficient (and consistent) manner.
*
* @return a new PermissionCollection object suitable for
@@ -312,7 +312,7 @@ final class BasicPermissionCollection
private transient Maptrue if this BasicPermissionCollection
+ * This is set to {@code true} if this BasicPermissionCollection
* contains a BasicPermission with '*' as its permission name.
*
* @see #serialPersistentFields
@@ -477,7 +477,7 @@ final class BasicPermissionCollection
* The Hashtable is indexed by the BasicPermission name; the value
* of the Hashtable entry is the permission.
* @serialField all_allowed boolean
- * This is set to true if this BasicPermissionCollection
+ * This is set to {@code true} if this BasicPermissionCollection
* contains a BasicPermission with '*' as its permission name.
* @serialField permClass java.lang.Class
* The class to which all BasicPermissions in this
diff --git a/src/share/classes/java/security/Certificate.java b/src/share/classes/java/security/Certificate.java
index 000a5e0bb5915a93af6dab6ed6abf46a7e69fb4e..489c6d620afae5424699ae3cfc6626b9a0c65b07 100644
--- a/src/share/classes/java/security/Certificate.java
+++ b/src/share/classes/java/security/Certificate.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -96,7 +96,7 @@ public interface Certificate {
/**
* Encodes the certificate to an output stream in a format that can
- * be decoded by the decode method.
+ * be decoded by the {@code decode} method.
*
* @param stream the output stream to which to encode the
* certificate.
@@ -115,8 +115,8 @@ public interface Certificate {
/**
* Decodes a certificate from an input stream. The format should be
- * that returned by getFormat and produced by
- * encode.
+ * that returned by {@code getFormat} and produced by
+ * {@code encode}.
*
* @param stream the input stream from which to fetch the data
* being decoded.
@@ -137,8 +137,8 @@ public interface Certificate {
/**
* Returns the name of the coding format. This is used as a hint to find
* an appropriate parser. It could be "X.509", "PGP", etc. This is
- * the format produced and understood by the encode
- * and decode methods.
+ * the format produced and understood by the {@code encode}
+ * and {@code decode} methods.
*
* @return the name of the coding format.
*/
diff --git a/src/share/classes/java/security/CodeSigner.java b/src/share/classes/java/security/CodeSigner.java
index 0b233d321faf2ecff57c41a7af3108503d3aa15b..37c12b153b3d8d06097c397c9f12ce80e420cef4 100644
--- a/src/share/classes/java/security/CodeSigner.java
+++ b/src/share/classes/java/security/CodeSigner.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -63,12 +63,12 @@ public final class CodeSigner implements Serializable {
* Constructs a CodeSigner object.
*
* @param signerCertPath The signer's certificate path.
- * It must not be null.
+ * It must not be {@code null}.
* @param timestamp A signature timestamp.
- * If null then no timestamp was generated
+ * If {@code null} then no timestamp was generated
* for the signature.
- * @throws NullPointerException if signerCertPath is
- * null.
+ * @throws NullPointerException if {@code signerCertPath} is
+ * {@code null}.
*/
public CodeSigner(CertPath signerCertPath, Timestamp timestamp) {
if (signerCertPath == null) {
@@ -90,7 +90,7 @@ public final class CodeSigner implements Serializable {
/**
* Returns the signature timestamp.
*
- * @return The timestamp or null if none is present.
+ * @return The timestamp or {@code null} if none is present.
*/
public Timestamp getTimestamp() {
return timestamp;
diff --git a/src/share/classes/java/security/CodeSource.java b/src/share/classes/java/security/CodeSource.java
index 7ab76111417e512f6251c91a07b757d8d73f79fd..b6167cb008b615f717a73d961fa140323adca874 100644
--- a/src/share/classes/java/security/CodeSource.java
+++ b/src/share/classes/java/security/CodeSource.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -485,13 +485,13 @@ public class CodeSource implements java.io.Serializable {
/**
* Writes this object out to a stream (i.e., serializes it).
*
- * @serialData An initial URL is followed by an
- * int indicating the number of certificates to follow
+ * @serialData An initial {@code URL} is followed by an
+ * {@code int} indicating the number of certificates to follow
* (a value of "zero" denotes that there are no certificates associated
* with this object).
- * Each certificate is written out starting with a String
+ * Each certificate is written out starting with a {@code String}
* denoting the certificate type, followed by an
- * int specifying the length of the certificate encoding,
+ * {@code int} specifying the length of the certificate encoding,
* followed by the certificate encoding itself which is written out as an
* array of bytes. Finally, if any code signers are present then the array
* of code signers is serialized and written out too.
diff --git a/src/share/classes/java/security/DigestException.java b/src/share/classes/java/security/DigestException.java
index 9d447509478aafea887ba47117feafce3223f09b..2327c982845abcc481da62838903b6037883cd42 100644
--- a/src/share/classes/java/security/DigestException.java
+++ b/src/share/classes/java/security/DigestException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -55,13 +55,13 @@ public class DigestException extends GeneralSecurityException {
}
/**
- * Creates a DigestException with the specified
+ * Creates a {@code DigestException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -70,13 +70,13 @@ public class DigestException extends GeneralSecurityException {
}
/**
- * Creates a DigestException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code DigestException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/DigestInputStream.java b/src/share/classes/java/security/DigestInputStream.java
index 8aa16dc0f6281ea374c774ac1c9b935e8d67562d..a1bf55ac9e7b4d9ce9a96f70047f1fab986f015c 100644
--- a/src/share/classes/java/security/DigestInputStream.java
+++ b/src/share/classes/java/security/DigestInputStream.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -37,13 +37,13 @@ import java.io.ByteArrayInputStream;
* the bits going through the stream.
*
* digest methods on the associated message
+ * {@code digest} methods on the associated message
* digest after your calls to one of this digest input stream's
* {@link #read() read} methods.
*
* read methods
+ * {@code read} methods
* results in an update on the message digest. But when it is off,
* the message digest is not updated. The default is for the stream
* to be on.
@@ -111,7 +111,7 @@ public class DigestInputStream extends FilterInputStream {
* function is on). That is, this method reads a byte from the
* input stream, blocking until the byte is actually read. If the
* digest function is on (see {@link #on(boolean) on}), this method
- * will then call update on the message digest associated
+ * will then call {@code update} on the message digest associated
* with this stream, passing it the byte read.
*
* @return the byte read.
@@ -131,25 +131,25 @@ public class DigestInputStream extends FilterInputStream {
/**
* Reads into a byte array, and updates the message digest (if the
* digest function is on). That is, this method reads up to
- * len bytes from the input stream into the array
- * b, starting at offset off. This method
+ * {@code len} bytes from the input stream into the array
+ * {@code b}, starting at offset {@code off}. This method
* blocks until the data is actually
* read. If the digest function is on (see
- * {@link #on(boolean) on}), this method will then call update
+ * {@link #on(boolean) on}), this method will then call {@code update}
* on the message digest associated with this stream, passing it
* the data.
*
* @param b the array into which the data is read.
*
- * @param off the starting offset into b of where the
+ * @param off the starting offset into {@code b} of where the
* data should be placed.
*
* @param len the maximum number of bytes to be read from the input
- * stream into b, starting at offset off.
+ * stream into b, starting at offset {@code off}.
*
* @return the actual number of bytes read. This is less than
- * len if the end of the stream is reached prior to
- * reading len bytes. -1 is returned if no bytes were
+ * {@code len} if the end of the stream is reached prior to
+ * reading {@code len} bytes. -1 is returned if no bytes were
* read because the end of the stream had already been reached when
* the call was made.
*
@@ -167,7 +167,7 @@ public class DigestInputStream extends FilterInputStream {
/**
* Turns the digest function on or off. The default is on. When
- * it is on, a call to one of the read methods results in an
+ * it is on, a call to one of the {@code read} methods results in an
* update on the message digest. But when it is off, the message
* digest is not updated.
*
diff --git a/src/share/classes/java/security/DigestOutputStream.java b/src/share/classes/java/security/DigestOutputStream.java
index 31b77259ea6f78c1bdab9278559fdaf20c5606da..5634a2252ecb2d5b2477cc307660faf5cbb297dd 100644
--- a/src/share/classes/java/security/DigestOutputStream.java
+++ b/src/share/classes/java/security/DigestOutputStream.java
@@ -37,13 +37,13 @@ import java.io.ByteArrayOutputStream;
* the bits going through the stream.
*
* digest methods on the associated message
+ * {@code digest} methods on the associated message
* digest after your calls to one of this digest ouput stream's
* {@link #write(int) write} methods.
*
* write methods results in
+ * {@code write} methods results in
* an update on the message digest. But when it is off, the message
* digest is not updated. The default is for the stream to be on.
*
@@ -99,8 +99,8 @@ public class DigestOutputStream extends FilterOutputStream {
* the specified byte, and in any case writes the byte
* to the output stream. That is, if the digest function is on
* (see {@link #on(boolean) on}), this method calls
- * update on the message digest associated with this
- * stream, passing it the byte b. This method then
+ * {@code update} on the message digest associated with this
+ * stream, passing it the byte {@code b}. This method then
* writes the byte to the output stream, blocking until the byte
* is actually written.
*
@@ -122,7 +122,7 @@ public class DigestOutputStream extends FilterOutputStream {
* Updates the message digest (if the digest function is on) using
* the specified subarray, and in any case writes the subarray to
* the output stream. That is, if the digest function is on (see
- * {@link #on(boolean) on}), this method calls update
+ * {@link #on(boolean) on}), this method calls {@code update}
* on the message digest associated with this stream, passing it
* the subarray specifications. This method then writes the subarray
* bytes to the output stream, blocking until the bytes are actually
@@ -131,11 +131,11 @@ public class DigestOutputStream extends FilterOutputStream {
* @param b the array containing the subarray to be used for updating
* and writing to the output stream.
*
- * @param off the offset into b of the first byte to
+ * @param off the offset into {@code b} of the first byte to
* be updated and written.
*
* @param len the number of bytes of data to be updated and written
- * from b, starting at offset off.
+ * from {@code b}, starting at offset {@code off}.
*
* @exception IOException if an I/O error occurs.
*
@@ -150,7 +150,7 @@ public class DigestOutputStream extends FilterOutputStream {
/**
* Turns the digest function on or off. The default is on. When
- * it is on, a call to one of the write methods results in an
+ * it is on, a call to one of the {@code write} methods results in an
* update on the message digest. But when it is off, the message
* digest is not updated.
*
diff --git a/src/share/classes/java/security/DomainCombiner.java b/src/share/classes/java/security/DomainCombiner.java
index e6549de0888c23912a868778d84f82400f2bd681..7aadc7e7b2f3135871ff7af78db8813ddf9a9c3c 100644
--- a/src/share/classes/java/security/DomainCombiner.java
+++ b/src/share/classes/java/security/DomainCombiner.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -26,27 +26,27 @@
package java.security;
/**
- * A DomainCombiner provides a means to dynamically
+ * A {@code DomainCombiner} provides a means to dynamically
* update the ProtectionDomains associated with the current
- * AccessControlContext.
+ * {@code AccessControlContext}.
*
- * DomainCombiner is passed as a parameter to the
- * appropriate constructor for AccessControlContext.
+ * AccessController.doPrivileged(..., context) method
- * to bind the provided context (and associated DomainCombiner)
+ * {@code AccessController.doPrivileged(..., context)} method
+ * to bind the provided context (and associated {@code DomainCombiner})
* with the current execution Thread. Subsequent calls to
- * AccessController.getContext or
- * AccessController.checkPermission
- * cause the DomainCombiner.combine to get invoked.
+ * {@code AccessController.getContext} or
+ * {@code AccessController.checkPermission}
+ * cause the {@code DomainCombiner.combine} to get invoked.
*
* AccessController.doPrivileged.
+ * since the most recent call to {@code AccessController.doPrivileged}.
* If no call to doPrivileged was made, then the first argument will contain
* all the ProtectionDomains from the current execution Thread.
* The second argument represents an array of inherited ProtectionDomains,
- * which may be null. ProtectionDomains may be inherited
+ * which may be {@code null}. ProtectionDomains may be inherited
* from a parent Thread, or from a privileged context. If no call to
* doPrivileged was made, then the second argument will contain the
* ProtectionDomains inherited from the parent Thread. If one or more calls
@@ -54,25 +54,25 @@ package java.security;
* doPrivileged(action, context), then the second argument will contain the
* ProtectionDomains from the privileged context. If the most recent call
* was to doPrivileged(action), then there is no privileged context,
- * and the second argument will be null.
+ * and the second argument will be {@code null}.
*
- * combine method investigates the two input arrays
+ * combine
+ * ProtectionDomains. In the simplest case, the {@code combine}
* method merges the two stacks into one. In more complex cases,
- * the combine method returns a modified
+ * the {@code combine} method returns a modified
* stack of ProtectionDomains. The modification may have added new
* ProtectionDomains, removed certain ProtectionDomains, or simply
* updated existing ProtectionDomains. Re-ordering and other optimizations
* to the ProtectionDomains are also permitted. Typically the
- * combine method bases its updates on the information
- * encapsulated in the DomainCombiner.
+ * {@code combine} method bases its updates on the information
+ * encapsulated in the {@code DomainCombiner}.
*
- * AccessController.getContext method
+ * DomainCombiner, it returns a new
+ * the {@code DomainCombiner}, it returns a new
* AccessControlContext that has both the combined ProtectionDomains
- * as well as the DomainCombiner.
+ * as well as the {@code DomainCombiner}.
*
* @see AccessController
* @see AccessControlContext
@@ -91,21 +91,21 @@ public interface DomainCombiner {
*
* @param currentDomains the ProtectionDomains associated with the
* current execution Thread, up to the most recent
- * privileged ProtectionDomain.
+ * privileged {@code ProtectionDomain}.
* The ProtectionDomains are are listed in order of execution,
- * with the most recently executing ProtectionDomain
+ * with the most recently executing {@code ProtectionDomain}
* residing at the beginning of the array. This parameter may
- * be null if the current execution Thread
+ * be {@code null} if the current execution Thread
* has no associated ProtectionDomains.AccessControlContext.
- * This parameter may be null
+ * or from a privileged {@code AccessControlContext}.
+ * This parameter may be {@code null}
* if there are no inherited ProtectionDomains.
*
* @return a new array consisting of the updated ProtectionDomains,
- * or null.
+ * or {@code null}.
*/
ProtectionDomain[] combine(ProtectionDomain[] currentDomains,
ProtectionDomain[] assignedDomains);
diff --git a/src/share/classes/java/security/GeneralSecurityException.java b/src/share/classes/java/security/GeneralSecurityException.java
index 60b568858451c349c1385a55c8bd7cfb1be368dd..dc9ea06ecce6edb19a75dba3a85be73c774bfb43 100644
--- a/src/share/classes/java/security/GeneralSecurityException.java
+++ b/src/share/classes/java/security/GeneralSecurityException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -26,7 +26,7 @@
package java.security;
/**
- * The GeneralSecurityException class is a generic
+ * The {@code GeneralSecurityException} class is a generic
* security exception class that provides type safety for all the
* security-related exception classes that extend from it.
*
@@ -57,13 +57,13 @@ public class GeneralSecurityException extends Exception {
}
/**
- * Creates a GeneralSecurityException with the specified
+ * Creates a {@code GeneralSecurityException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -72,13 +72,13 @@ public class GeneralSecurityException extends Exception {
}
/**
- * Creates a GeneralSecurityException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code GeneralSecurityException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/Guard.java b/src/share/classes/java/security/Guard.java
index 7cfd25b6ca1d94676e4f3d214fc22f26df126a80..abafb5886594fb136aafe386e3433f1bf47a8b3e 100644
--- a/src/share/classes/java/security/Guard.java
+++ b/src/share/classes/java/security/Guard.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 1998, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -29,9 +29,9 @@ package java.security;
* checkGuard,
- * with a single object argument. checkGuard is
- * invoked (by the GuardedObject getObject method)
+ * object. Returns silently if access is allowed.
+ * {@code object}. Returns silently if access is allowed.
* Otherwise, throws a SecurityException.
*
* @param object the object being protected by the guard.
diff --git a/src/share/classes/java/security/GuardedObject.java b/src/share/classes/java/security/GuardedObject.java
index c4edb234a50ea203e27f2ea31fb1e2f094925cea..a275ddf043ee593eaf04a311b8682676e0993ff1 100644
--- a/src/share/classes/java/security/GuardedObject.java
+++ b/src/share/classes/java/security/GuardedObject.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -33,9 +33,9 @@ package java.security;
* such that access to the target object is possible
* only if the Guard object allows it.
* Once an object is encapsulated by a GuardedObject,
- * access to that object is controlled by the getObject
+ * access to that object is controlled by the {@code getObject}
* method, which invokes the
- * checkGuard method on the Guard object that is
+ * {@code checkGuard} method on the Guard object that is
* guarding access. If access is not allowed,
* an exception is thrown.
*
diff --git a/src/share/classes/java/security/Identity.java b/src/share/classes/java/security/Identity.java
index b7a36c4b340c7fe83d22922b534d2ac952ae7fc9..6a5e87e20fab312f7f3d47fd6eb21249931df10c 100644
--- a/src/share/classes/java/security/Identity.java
+++ b/src/share/classes/java/security/Identity.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -52,9 +52,9 @@ import java.util.*;
*
* @author Benjamin Renaud
* @deprecated This class is no longer used. Its functionality has been
- * replaced by java.security.KeyStore, the
- * java.security.cert package, and
- * java.security.Principal.
+ * replaced by {@code java.security.KeyStore}, the
+ * {@code java.security.cert} package, and
+ * {@code java.security.Principal}.
*/
@Deprecated
public abstract class Identity implements Principal, Serializable {
@@ -164,8 +164,8 @@ public abstract class Identity implements Principal, Serializable {
* Sets this identity's public key. The old key and all of this
* identity's certificates are removed by this operation.
*
- * checkSecurityAccess
- * method is called with "setIdentityPublicKey"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* setting the public key.
*
* @see #getPublicKey
@@ -191,14 +191,14 @@ public abstract class Identity implements Principal, Serializable {
/**
* Specifies a general information string for this identity.
*
- * checkSecurityAccess
- * method is called with "setIdentityInfo"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* setting the information string.
*
* @see #getInfo
@@ -226,8 +226,8 @@ public abstract class Identity implements Principal, Serializable {
* the identity does not have a public key, the identity's
* public key is set to be that specified in the certificate.
*
- * checkSecurityAccess
- * method is called with "addIdentityCertificate"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* adding a certificate.
*
* @see SecurityManager#checkSecurityAccess
@@ -277,8 +277,8 @@ public abstract class Identity implements Principal, Serializable {
/**
* Removes a certificate from this identity.
*
- * checkSecurityAccess
- * method is called with "removeIdentityCertificate"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* removing a certificate.
*
* @see SecurityManager#checkSecurityAccess
@@ -390,15 +390,15 @@ public abstract class Identity implements Principal, Serializable {
* Returns a short string describing this identity, telling its
* name and its scope (if any).
*
- * checkSecurityAccess
- * method is called with "printIdentity"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* returning a string describing this identity.
*
* @see SecurityManager#checkSecurityAccess
@@ -415,20 +415,20 @@ public abstract class Identity implements Principal, Serializable {
/**
* Returns a string representation of this identity, with
* optionally more details than that provided by the
- * toString method without any arguments.
+ * {@code toString} method without any arguments.
*
- * checkSecurityAccess
- * method is called with "printIdentity"
+ * detailed
+ * @return information about this identity. If {@code detailed}
* is true, then this method returns more information than that
- * provided by the toString method without any arguments.
+ * provided by the {@code toString} method without any arguments.
*
* @exception SecurityException if a security manager exists and its
- * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* returning a string describing this identity.
*
* @see #toString
diff --git a/src/share/classes/java/security/IdentityScope.java b/src/share/classes/java/security/IdentityScope.java
index 7c58e019473b7e43a6a93c0975acc19670f61144..64c4a6343746d0c22d738274f9cffe1ca743ab8a 100644
--- a/src/share/classes/java/security/IdentityScope.java
+++ b/src/share/classes/java/security/IdentityScope.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -57,9 +57,9 @@ import java.util.Properties;
* @author Benjamin Renaud
*
* @deprecated This class is no longer used. Its functionality has been
- * replaced by java.security.KeyStore, the
- * java.security.cert package, and
- * java.security.Principal.
+ * replaced by {@code java.security.KeyStore}, the
+ * {@code java.security.cert} package, and
+ * {@code java.security.Principal}.
*/
@Deprecated
public abstract
@@ -146,14 +146,14 @@ class IdentityScope extends Identity {
* Sets the system's identity scope.
*
* checkSecurityAccess
- * method is called with "setSystemScope"
+ * {@code checkSecurityAccess}
+ * method is called with {@code "setSystemScope"}
* as its argument to see if it's ok to set the identity scope.
*
* @param scope the scope to set.
*
* @exception SecurityException if a security manager exists and its
- * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* setting the identity scope.
*
* @see #getSystemScope
@@ -176,8 +176,8 @@ class IdentityScope extends Identity {
*
* @param name the name of the identity to be retrieved.
*
- * @return the identity named name, or null if there are
- * no identities named name in this scope.
+ * @return the identity named {@code name}, or null if there are
+ * no identities named {@code name} in this scope.
*/
public abstract Identity getIdentity(String name);
diff --git a/src/share/classes/java/security/InvalidAlgorithmParameterException.java b/src/share/classes/java/security/InvalidAlgorithmParameterException.java
index b4f1a08eefca076e6aab446c713cc55d0b1dec47..559a8beed09daf8f22e0b0b7a884373132431b99 100644
--- a/src/share/classes/java/security/InvalidAlgorithmParameterException.java
+++ b/src/share/classes/java/security/InvalidAlgorithmParameterException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -65,13 +65,13 @@ extends GeneralSecurityException {
}
/**
- * Creates a InvalidAlgorithmParameterException with the
+ * Creates a {@code InvalidAlgorithmParameterException} with the
* specified detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -80,14 +80,14 @@ extends GeneralSecurityException {
}
/**
- * Creates a InvalidAlgorithmParameterException with the
+ * Creates a {@code InvalidAlgorithmParameterException} with the
* specified cause and a detail message of
- * (cause==null ? null : cause.toString())
+ * {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/InvalidKeyException.java b/src/share/classes/java/security/InvalidKeyException.java
index e9130f7104aeeb16448ac79d4b27b081c9ad50ff..35fc64c3d9e90ed7c55a5a3074a3dece5bca3eb9 100644
--- a/src/share/classes/java/security/InvalidKeyException.java
+++ b/src/share/classes/java/security/InvalidKeyException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -58,13 +58,13 @@ public class InvalidKeyException extends KeyException {
}
/**
- * Creates a InvalidKeyException with the specified
+ * Creates a {@code InvalidKeyException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -73,13 +73,13 @@ public class InvalidKeyException extends KeyException {
}
/**
- * Creates a InvalidKeyException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code InvalidKeyException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/Key.java b/src/share/classes/java/security/Key.java
index 2df0f3e6a488682e96543688d418a41c04a3f41a..0ae4e3851b35f27f94541406249f1670db1f9746 100644
--- a/src/share/classes/java/security/Key.java
+++ b/src/share/classes/java/security/Key.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -47,9 +47,9 @@ package java.security;
* representation of the key is needed outside the Java Virtual Machine,
* as when transmitting the key to some other party. The key
* is encoded according to a standard format (such as
- * X.509 SubjectPublicKeyInfo or PKCS#8), and
+ * X.509 {@code SubjectPublicKeyInfo} or PKCS#8), and
* is returned using the {@link #getEncoded() getEncoded} method.
- * Note: The syntax of the ASN.1 type SubjectPublicKeyInfo
+ * Note: The syntax of the ASN.1 type {@code SubjectPublicKeyInfo}
* is defined as follows:
*
*
@@ -132,11 +132,11 @@ public interface Key extends java.io.Serializable {
* For example, the name of the ASN.1 data format for public
* keys is SubjectPublicKeyInfo, as
* defined by the X.509 standard; in this case, the returned format is
- *
*
* "X.509". Similarly,
+ * {@code "X.509"}. Similarly,
* the name of the ASN.1 data format for private keys is
* PrivateKeyInfo,
* as defined by the PKCS #8 standard; in this case, the returned format is
- * "PKCS#8".
+ * {@code "PKCS#8"}.
*
* @return the primary encoding format of the key.
*/
diff --git a/src/share/classes/java/security/KeyException.java b/src/share/classes/java/security/KeyException.java
index cd79fcb30bab612723440199a1a963dd1bff8402..59cdd6f3ab515be6ac0e660827d189b3b4d7fcf5 100644
--- a/src/share/classes/java/security/KeyException.java
+++ b/src/share/classes/java/security/KeyException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -59,13 +59,13 @@ public class KeyException extends GeneralSecurityException {
}
/**
- * Creates a KeyException with the specified
+ * Creates a {@code KeyException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -74,13 +74,13 @@ public class KeyException extends GeneralSecurityException {
}
/**
- * Creates a KeyException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code KeyException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/KeyFactory.java b/src/share/classes/java/security/KeyFactory.java
index 85210bb76902d0293965bc82c3f5aeef10e84ec2..0eb6b754107712d2222ed2091fe71007158d85d4 100644
--- a/src/share/classes/java/security/KeyFactory.java
+++ b/src/share/classes/java/security/KeyFactory.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -37,7 +37,7 @@ import sun.security.jca.GetInstance.Instance;
/**
* Key factories are used to convert keys (opaque
- * cryptographic keys of type Key) into key specifications
+ * cryptographic keys of type {@code Key}) into key specifications
* (transparent representations of the underlying key material), and vice
* versa.
*
@@ -47,8 +47,8 @@ import sun.security.jca.GetInstance.Instance;
*
* DSAPublicKeySpec or
- * X509EncodedKeySpec. A key factory can be used to translate
+ * {@code DSAPublicKeySpec} or
+ * {@code X509EncodedKeySpec}. A key factory can be used to translate
* between compatible key specifications.
*
* KeyFactory algorithms:
+ * following standard {@code KeyFactory} algorithms:
*
- *
* These algorithms are described in the
@@ -120,7 +120,7 @@ public class KeyFactory {
* @param keyFacSpi the delegate
* @param provider the provider
* @param algorithm the name of the algorithm
- * to associate with this KeyFactory
+ * to associate with this {@code KeyFactory}
*/
protected KeyFactory(KeyFactorySpi keyFacSpi, Provider provider,
String algorithm) {
@@ -266,10 +266,10 @@ public class KeyFactory {
/**
* Gets the name of the algorithm
- * associated with this KeyFactory.
+ * associated with this {@code KeyFactory}.
*
* @return the name of the algorithm associated with this
- * KeyFactory
+ * {@code KeyFactory}
*/
public final String getAlgorithm() {
return this.algorithm;
@@ -389,11 +389,11 @@ public class KeyFactory {
/**
* Returns a specification (key material) of the given key object.
- * keySpec identifies the specification class in which
+ * {@code keySpec} identifies the specification class in which
* the key material should be returned. It could, for example, be
- * DSAPublicKeySpec.class, to indicate that the
+ * {@code DSAPublicKeySpec.class}, to indicate that the
* key material should be returned in an instance of the
- * DSAPublicKeySpec class.
+ * {@code DSAPublicKeySpec} class.
*
* @param key the key.
*
diff --git a/src/share/classes/java/security/KeyFactorySpi.java b/src/share/classes/java/security/KeyFactorySpi.java
index f1f4d4a30f3360b1ce7f64ab178d597c95338aa9..877c3a11be1ed0493f01bb0fb4fadf84f04ccdf2 100644
--- a/src/share/classes/java/security/KeyFactorySpi.java
+++ b/src/share/classes/java/security/KeyFactorySpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -30,13 +30,13 @@ import java.security.spec.InvalidKeySpecException;
/**
* This class defines the Service Provider Interface (SPI)
- * for the KeyFactory class.
+ * for the {@code KeyFactory} class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a key factory for a particular algorithm.
*
* Key) into key specifications
+ * cryptographic keys of type {@code Key}) into key specifications
* (transparent representations of the underlying key material), and vice
* versa.
*
@@ -46,8 +46,8 @@ import java.security.spec.InvalidKeySpecException;
*
* DSAPublicKeySpec or
- * X509EncodedKeySpec. A key factory can be used to translate
+ * {@code DSAPublicKeySpec} or
+ * {@code X509EncodedKeySpec}. A key factory can be used to translate
* between compatible key specifications.
*
* keySpec identifies the specification class in which
+ * {@code keySpec} identifies the specification class in which
* the key material should be returned. It could, for example, be
- * DSAPublicKeySpec.class, to indicate that the
+ * {@code DSAPublicKeySpec.class}, to indicate that the
* key material should be returned in an instance of the
- * DSAPublicKeySpec class.
+ * {@code DSAPublicKeySpec} class.
*
* @param key the key.
*
diff --git a/src/share/classes/java/security/KeyManagementException.java b/src/share/classes/java/security/KeyManagementException.java
index 403e36ac55f94e2d1672c58a640e87099b622c9e..be212b9fdc16c612c3ae9aac49509d7e0d018107 100644
--- a/src/share/classes/java/security/KeyManagementException.java
+++ b/src/share/classes/java/security/KeyManagementException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -68,13 +68,13 @@ public class KeyManagementException extends KeyException {
}
/**
- * Creates a KeyManagementException with the specified
+ * Creates a {@code KeyManagementException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -83,13 +83,13 @@ public class KeyManagementException extends KeyException {
}
/**
- * Creates a KeyManagementException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code KeyManagementException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/KeyPair.java b/src/share/classes/java/security/KeyPair.java
index 16815533fb4e51a92b3d64cd08dc12441c0865b9..6147a16aa59be2cab7a0a603c8ead27502f5a726 100644
--- a/src/share/classes/java/security/KeyPair.java
+++ b/src/share/classes/java/security/KeyPair.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -50,7 +50,7 @@ public final class KeyPair implements java.io.Serializable {
*
* Key objects are immutable.
+ * because {@code Key} objects are immutable.
*
* @param publicKey the public key.
*
diff --git a/src/share/classes/java/security/KeyPairGenerator.java b/src/share/classes/java/security/KeyPairGenerator.java
index 2d7f427529d2e8fc8842155ce54cc681e5c673e9..78b100c3afa4684526d0bfd52b9e4ba8ce214102 100644
--- a/src/share/classes/java/security/KeyPairGenerator.java
+++ b/src/share/classes/java/security/KeyPairGenerator.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -37,7 +37,7 @@ import sun.security.jca.GetInstance.Instance;
/**
* The KeyPairGenerator class is used to generate pairs of
* public and private keys. Key pair generators are constructed using the
- * getInstance factory methods (static methods that
+ * {@code getInstance} factory methods (static methods that
* return instances of a given class).
*
* keysize argument, and uses the SecureRandom
+ * {@code keysize} argument, and uses the {@code SecureRandom}
* implementation of the highest-priority installed provider as the source
* of randomness. (If none of the installed providers supply an implementation
- * of SecureRandom, a system-provided source of randomness is
+ * of {@code SecureRandom}, a system-provided source of randomness is
* used.)
*
* initialize methods, it is up to the
+ * algorithm-independent {@code initialize} methods, it is up to the
* provider what to do about the algorithm-specific parameters (if any) to be
* associated with each of the keys.
*
* p, q, and
- * g parameters. If the modulus size is not one of the above
+ * precomputed values for the {@code p}, {@code q}, and
+ * {@code g} parameters. If the modulus size is not one of the above
* values, the Sun provider creates a new set of parameters. Other
* providers might have precomputed parameter sets for more than just the
* three modulus sizes mentioned above. Still others might not have a list of
@@ -83,35 +83,35 @@ import sun.security.jca.GetInstance.Instance;
* AlgorithmParameterSpec
- * argument. One also has a SecureRandom argument, while the
- * the other uses the SecureRandom
+ * initialize} methods that have an {@code AlgorithmParameterSpec}
+ * argument. One also has a {@code SecureRandom} argument, while the
+ * the other uses the {@code SecureRandom}
* implementation of the highest-priority installed provider as the source
* of randomness. (If none of the installed providers supply an implementation
- * of SecureRandom, a system-provided source of randomness is
+ * of {@code SecureRandom}, a system-provided source of randomness is
* used.)
*
*
* initialize method), each provider must
+ * (via a call to an {@code initialize} method), each provider must
* supply (and document) a default initialization.
* For example, the Sun provider uses a default modulus size (keysize)
* of 1024 bits.
*
* KeyPairGeneratorSpi for historical reasons.
+ * {@code KeyPairGeneratorSpi} for historical reasons.
* Application developers should only take notice of the methods defined in
- * this KeyPairGenerator class; all the methods in
+ * this {@code KeyPairGenerator} class; all the methods in
* the superclass are intended for cryptographic service providers who wish to
* supply their own implementations of key pair generators.
*
* KeyPairGenerator algorithms and keysizes in
+ * following standard {@code KeyPairGenerator} algorithms and keysizes in
* parentheses:
*
- *
* These algorithms are described in the
@@ -322,18 +322,18 @@ public abstract class KeyPairGenerator extends KeyPairGeneratorSpi {
/**
* Initializes the key pair generator for a certain keysize using
- * a default parameter set and the SecureRandom
+ * a default parameter set and the {@code SecureRandom}
* implementation of the highest-priority installed provider as the source
* of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness is
+ * {@code SecureRandom}, a system-provided source of randomness is
* used.)
*
* @param keysize the keysize. This is an
* algorithm-specific metric, such as modulus length, specified in
* number of bits.
*
- * @exception InvalidParameterException if the keysize is not
+ * @exception InvalidParameterException if the {@code keysize} is not
* supported by this KeyPairGenerator object.
*/
public void initialize(int keysize) {
@@ -349,7 +349,7 @@ public abstract class KeyPairGenerator extends KeyPairGeneratorSpi {
* number of bits.
* @param random the source of randomness.
*
- * @exception InvalidParameterException if the keysize is not
+ * @exception InvalidParameterException if the {@code keysize} is not
* supported by this KeyPairGenerator object.
*
* @since 1.2
@@ -369,11 +369,11 @@ public abstract class KeyPairGenerator extends KeyPairGeneratorSpi {
/**
* Initializes the key pair generator using the specified parameter
- * set and the SecureRandom
+ * set and the {@code SecureRandom}
* implementation of the highest-priority installed provider as the source
* of randomness.
* (If none of the installed providers supply an implementation of
- * SecureRandom, a system-provided source of randomness is
+ * {@code SecureRandom}, a system-provided source of randomness is
* used.).
*
* params and a source of randomness (obtained
+ * passing it {@code params} and a source of randomness (obtained
* from the highest-priority installed provider or system-provided if none
* of the installed providers supply one).
- * That initialize method always throws an
+ * That {@code initialize} method always throws an
* UnsupportedOperationException if it is not overridden by the provider.
*
* @param params the parameter set used to generate the keys.
@@ -410,8 +410,8 @@ public abstract class KeyPairGenerator extends KeyPairGeneratorSpi {
* KeyPairGeneratorSpi#initialize(
* java.security.spec.AlgorithmParameterSpec,
* java.security.SecureRandom) initialize} method,
- * passing it params and random.
- * That initialize
+ * passing it {@code params} and {@code random}.
+ * That {@code initialize}
* method always throws an
* UnsupportedOperationException if it is not overridden by the provider.
*
diff --git a/src/share/classes/java/security/KeyPairGeneratorSpi.java b/src/share/classes/java/security/KeyPairGeneratorSpi.java
index 28139adcf6888ead30c33659e0cf5daa3ed54edc..dfe8c04218dc1f0f734a06e7df94c6f2b651693e 100644
--- a/src/share/classes/java/security/KeyPairGeneratorSpi.java
+++ b/src/share/classes/java/security/KeyPairGeneratorSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -29,7 +29,7 @@ import java.security.spec.AlgorithmParameterSpec;
/**
* KeyPairGenerator class, which is used to generate
+ * for the {@code KeyPairGenerator} class, which is used to generate
* pairs of public and private keys.
*
* initialize method), each provider must
+ * (via a call to an {@code initialize} method), each provider must
* supply (and document) a default initialization.
* For example, the Sun provider uses a default modulus size (keysize)
* of 1024 bits.
@@ -61,7 +61,7 @@ public abstract class KeyPairGeneratorSpi {
*
* @param random the source of randomness for this generator.
*
- * @exception InvalidParameterException if the keysize is not
+ * @exception InvalidParameterException if the {@code keysize} is not
* supported by this KeyPairGeneratorSpi object.
*/
public abstract void initialize(int keysize, SecureRandom random);
@@ -100,7 +100,7 @@ public abstract class KeyPairGeneratorSpi {
* will be used. This will generate a new key pair every time it
* is called.
*
- * @return the newly generated KeyPair
+ * @return the newly generated {@code KeyPair}
*/
public abstract KeyPair generateKeyPair();
}
diff --git a/src/share/classes/java/security/KeyRep.java b/src/share/classes/java/security/KeyRep.java
index 6c0231c5497d065de9e4d3d653952fe34a9fc356..0b1412c1563c15e843d18d07b5b76b9fe5a81434 100644
--- a/src/share/classes/java/security/KeyRep.java
+++ b/src/share/classes/java/security/KeyRep.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -116,17 +116,17 @@ public class KeyRep implements Serializable {
*
* @param type either one of Type.SECRET, Type.PUBLIC, or Type.PRIVATE
* @param algorithm the algorithm returned from
- * Key.getAlgorithm()
+ * {@code Key.getAlgorithm()}
* @param format the encoding format returned from
- * Key.getFormat()
+ * {@code Key.getFormat()}
* @param encoded the encoded bytes returned from
- * Key.getEncoded()
+ * {@code Key.getEncoded()}
*
* @exception NullPointerException
- * if type is null,
- * if algorithm is null,
- * if format is null,
- * or if encoded is null
+ * if type is {@code null},
+ * if algorithm is {@code null},
+ * if format is {@code null},
+ * or if encoded is {@code null}
*/
public KeyRep(Type type, String algorithm,
String format, byte[] encoded) {
diff --git a/src/share/classes/java/security/KeyStore.java b/src/share/classes/java/security/KeyStore.java
index 64bb4f261b5f987565dfaff5329add8f3a619655..68df16ed113f76913b46dde51a6fa3cae71a9b17 100644
--- a/src/share/classes/java/security/KeyStore.java
+++ b/src/share/classes/java/security/KeyStore.java
@@ -41,13 +41,13 @@ import javax.security.auth.callback.*;
* This class represents a storage facility for cryptographic
* keys and certificates.
*
- * KeyStore manages different types of entries.
- * Each type of entry implements the KeyStore.Entry interface.
- * Three basic KeyStore.Entry implementations are provided:
+ *
*
PrivateKey,
+ * SecretKey,
+ * Certificate
+ * load method,
- * pass null as the InputStream argument.
+ * To create an empty keystore using the above {@code load} method,
+ * pass {@code null} as the {@code InputStream} argument.
*
* KeyStore type:
+ * the following standard {@code KeyStore} type:
*
- *
* This type is described in the
@@ -201,7 +201,7 @@ public class KeyStore {
private boolean initialized = false;
/**
- * A marker interface for KeyStore
+ * A marker interface for {@code KeyStore}
* {@link #load(KeyStore.LoadStoreParameter) load}
* and
* {@link #store(KeyStore.LoadStoreParameter) store}
@@ -365,19 +365,19 @@ public class KeyStore {
/**
* A marker interface for keystore protection parameters.
*
- * ProtectionParameter
+ * PrivateKey).
+ * (such as a {@code PrivateKey}).
*
* @since 1.5
*/
public static interface ProtectionParameter { }
/**
- * A password-based implementation of ProtectionParameter.
+ * A password-based implementation of {@code ProtectionParameter}.
*
* @since 1.5
*/
@@ -392,10 +392,10 @@ public class KeyStore {
/**
* Creates a password parameter.
*
- * password is cloned before it is stored
- * in the new PasswordProtection object.
+ * null
+ * @param password the password, which may be {@code null}
*/
public PasswordProtection(char[] password) {
this.password = (password == null) ? null : password.clone();
@@ -476,7 +476,7 @@ public class KeyStore {
* after it is no longer needed.
*
* @see #destroy()
- * @return the password, which may be null
+ * @return the password, which may be {@code null}
* @exception IllegalStateException if the password has
* been cleared (destroyed)
*/
@@ -546,7 +546,7 @@ public class KeyStore {
}
/**
- * A marker interface for KeyStore entry types.
+ * A marker interface for {@code KeyStore} entry types.
*
* @since 1.5
*/
@@ -590,7 +590,7 @@ public class KeyStore {
}
/**
- * A KeyStore entry that holds a PrivateKey
+ * A {@code KeyStore} entry that holds a {@code PrivateKey}
* and corresponding certificate chain.
*
* @since 1.5
@@ -602,28 +602,28 @@ public class KeyStore {
private final SetPrivateKeyEntry with a
- * PrivateKey and corresponding certificate chain.
+ * Constructs a {@code PrivateKeyEntry} with a
+ * {@code PrivateKey} and corresponding certificate chain.
*
- * chain is cloned before it is stored
- * in the new PrivateKeyEntry object.
+ * PrivateKey
- * @param chain an array of Certificates
+ * @param privateKey the {@code PrivateKey}
+ * @param chain an array of {@code Certificate}s
* representing the certificate chain.
* The chain must be ordered and contain a
- * Certificate at index 0
+ * {@code Certificate} at index 0
* corresponding to the private key.
*
* @exception NullPointerException if
- * privateKey or chain
- * is null
+ * {@code privateKey} or {@code chain}
+ * is {@code null}
* @exception IllegalArgumentException if the specified chain has a
* length of 0, if the specified chain does not contain
- * Certificates of the same type,
- * or if the PrivateKey algorithm
- * does not match the algorithm of the PublicKey
- * in the end entity Certificate (at index 0)
+ * {@code Certificate}s of the same type,
+ * or if the {@code PrivateKey} algorithm
+ * does not match the algorithm of the {@code PublicKey}
+ * in the end entity {@code Certificate} (at index 0)
*/
public PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain) {
this(privateKey, chain, Collections.PrivateKey from this entry.
+ * Gets the {@code PrivateKey} from this entry.
*
- * @return the PrivateKey from this entry
+ * @return the {@code PrivateKey} from this entry
*/
public PrivateKey getPrivateKey() {
return privKey;
}
/**
- * Gets the Certificate chain from this entry.
+ * Gets the {@code Certificate} chain from this entry.
*
* Certificates corresponding
+ * @return an array of {@code Certificate}s corresponding
* to the certificate chain for the public key.
* If the certificates are of type X.509,
* the runtime type of the returned array is
- * X509Certificate[].
+ * {@code X509Certificate[]}.
*/
public Certificate[] getCertificateChain() {
return chain.clone();
}
/**
- * Gets the end entity Certificate
+ * Gets the end entity {@code Certificate}
* from the certificate chain in this entry.
*
- * @return the end entity Certificate (at index 0)
+ * @return the end entity {@code Certificate} (at index 0)
* from the certificate chain in this entry.
* If the certificate is of type X.509,
* the runtime type of the returned certificate is
- * X509Certificate.
+ * {@code X509Certificate}.
*/
public Certificate getCertificate() {
return chain[0];
@@ -767,7 +767,7 @@ public class KeyStore {
}
/**
- * A KeyStore entry that holds a SecretKey.
+ * A {@code KeyStore} entry that holds a {@code SecretKey}.
*
* @since 1.5
*/
@@ -777,13 +777,13 @@ public class KeyStore {
private final SetSecretKeyEntry with a
- * SecretKey.
+ * Constructs a {@code SecretKeyEntry} with a
+ * {@code SecretKey}.
*
- * @param secretKey the SecretKey
+ * @param secretKey the {@code SecretKey}
*
- * @exception NullPointerException if secretKey
- * is null
+ * @exception NullPointerException if {@code secretKey}
+ * is {@code null}
*/
public SecretKeyEntry(SecretKey secretKey) {
if (secretKey == null) {
@@ -819,9 +819,9 @@ public class KeyStore {
}
/**
- * Gets the SecretKey from this entry.
+ * Gets the {@code SecretKey} from this entry.
*
- * @return the SecretKey from this entry
+ * @return the {@code SecretKey} from this entry
*/
public SecretKey getSecretKey() {
return sKey;
@@ -850,8 +850,8 @@ public class KeyStore {
}
/**
- * A KeyStore entry that holds a trusted
- * Certificate.
+ * A {@code KeyStore} entry that holds a trusted
+ * {@code Certificate}.
*
* @since 1.5
*/
@@ -861,13 +861,13 @@ public class KeyStore {
private final SetTrustedCertificateEntry with a
- * trusted Certificate.
+ * Constructs a {@code TrustedCertificateEntry} with a
+ * trusted {@code Certificate}.
*
- * @param trustedCert the trusted Certificate
+ * @param trustedCert the trusted {@code Certificate}
*
* @exception NullPointerException if
- * trustedCert is null
+ * {@code trustedCert} is {@code null}
*/
public TrustedCertificateEntry(Certificate trustedCert) {
if (trustedCert == null) {
@@ -903,9 +903,9 @@ public class KeyStore {
}
/**
- * Gets the trusted Certficate from this entry.
+ * Gets the trusted {@code Certficate} from this entry.
*
- * @return the trusted Certificate from this entry
+ * @return the trusted {@code Certificate} from this entry
*/
public Certificate getTrustedCertificate() {
return cert;
@@ -1129,9 +1129,9 @@ public class KeyStore {
/**
* Returns the key associated with the given alias, using the given
* password to recover it. The key must have been associated with
- * the alias by a call to setKeyEntry,
- * or by a call to setEntry with a
- * PrivateKeyEntry or SecretKeyEntry.
+ * the alias by a call to {@code setKeyEntry},
+ * or by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry} or {@code SecretKeyEntry}.
*
* @param alias the alias name
* @param password the password for recovering the key
@@ -1159,9 +1159,9 @@ public class KeyStore {
/**
* Returns the certificate chain associated with the given alias.
* The certificate chain must have been associated with the alias
- * by a call to setKeyEntry,
- * or by a call to setEntry with a
- * PrivateKeyEntry.
+ * by a call to {@code setKeyEntry},
+ * or by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry}.
*
* @param alias the alias name
*
@@ -1185,15 +1185,15 @@ public class KeyStore {
* Returns the certificate associated with the given alias.
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* then the trusted certificate contained in that entry is returned.
*
* setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry,
+ * created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry},
* then the first element of the certificate chain in that entry
* is returned.
*
@@ -1238,7 +1238,7 @@ public class KeyStore {
* Assigns the given key to the given alias, protecting it with the given
* password.
*
- * java.security.PrivateKey,
+ * java.security.PrivateKey).
+ * {@code java.security.PrivateKey}).
*
* @exception KeyStoreException if the keystore has not been initialized
* (loaded), the given key cannot be protected, or this operation fails
@@ -1278,11 +1278,11 @@ public class KeyStore {
* alias.
*
* java.security.PrivateKey, it must be accompanied by a
+ * {@code java.security.PrivateKey}, it must be accompanied by a
* certificate chain certifying the corresponding public key. If the
- * underlying keystore implementation is of type jks,
- * key must be encoded as an
- * EncryptedPrivateKeyInfo as defined in the PKCS #8 standard.
+ * underlying keystore implementation is of type {@code jks},
+ * {@code key} must be encoded as an
+ * {@code EncryptedPrivateKeyInfo} as defined in the PKCS #8 standard.
*
* java.security.PrivateKey).
+ * {@code java.security.PrivateKey}).
*
* @exception KeyStoreException if the keystore has not been initialized
* (loaded), or if this operation fails for some other reason.
@@ -1311,9 +1311,9 @@ public class KeyStore {
* Assigns the given trusted certificate to the given alias.
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* the trusted certificate in the existing entry
* is overridden by the given certificate.
*
@@ -1406,9 +1406,9 @@ public class KeyStore {
/**
* Returns true if the entry identified by the given alias
- * was created by a call to setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry or a SecretKeyEntry.
+ * was created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry} or a {@code SecretKeyEntry}.
*
* @param alias the alias for the keystore entry to be checked
*
@@ -1429,9 +1429,9 @@ public class KeyStore {
/**
* Returns true if the entry identified by the given alias
- * was created by a call to setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry.
+ * was created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry}.
*
* @param alias the alias for the keystore entry to be checked
*
@@ -1456,15 +1456,15 @@ public class KeyStore {
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* then the given certificate is compared to that entry's certificate.
*
* setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry,
+ * created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry},
* then the given certificate is compared to the first
* element of that entry's certificate chain.
*
@@ -1511,14 +1511,14 @@ public class KeyStore {
}
/**
- * Stores this keystore using the given LoadStoreParameter.
+ * Stores this keystore using the given {@code LoadStoreParameter}.
*
- * @param param the LoadStoreParameter
+ * @param param the {@code LoadStoreParameter}
* that specifies how to store the keystore,
- * which may be null
+ * which may be {@code null}
*
* @exception IllegalArgumentException if the given
- * LoadStoreParameter
+ * {@code LoadStoreParameter}
* input is not recognized
* @exception KeyStoreException if the keystore has not been initialized
* (loaded)
@@ -1549,24 +1549,24 @@ public class KeyStore {
* then integrity checking is not performed.
*
* null
- * as the stream argument.
+ * be initialized from a stream, pass {@code null}
+ * as the {@code stream} argument.
*
* null
+ * or {@code null}
* @param password the password used to check the integrity of
* the keystore, the password used to unlock the keystore,
- * or null
+ * or {@code null}
*
* @exception IOException if there is an I/O or format problem with the
* keystore data, if a password is required but not given,
* or if the given password was incorrect. If the error is due to a
* wrong password, the {@link Throwable#getCause cause} of the
- * IOException should be an
- * UnrecoverableKeyException
+ * {@code IOException} should be an
+ * {@code UnrecoverableKeyException}
* @exception NoSuchAlgorithmException if the algorithm used to check
* the integrity of the keystore cannot be found
* @exception CertificateException if any of the certificates in the
@@ -1580,24 +1580,24 @@ public class KeyStore {
}
/**
- * Loads this keystore using the given LoadStoreParameter.
+ * Loads this keystore using the given {@code LoadStoreParameter}.
*
* LoadStoreParameter
+ * @param param the {@code LoadStoreParameter}
* that specifies how to load the keystore,
- * which may be null
+ * which may be {@code null}
*
* @exception IllegalArgumentException if the given
- * LoadStoreParameter
+ * {@code LoadStoreParameter}
* input is not recognized
* @exception IOException if there is an I/O or format problem with the
* keystore data. If the error is due to an incorrect
- * ProtectionParameter (e.g. wrong password)
+ * {@code ProtectionParameter} (e.g. wrong password)
* the {@link Throwable#getCause cause} of the
- * IOException should be an
- * UnrecoverableKeyException
+ * {@code IOException} should be an
+ * {@code UnrecoverableKeyException}
* @exception NoSuchAlgorithmException if the algorithm used to check
* the integrity of the keystore cannot be found
* @exception CertificateException if any of the certificates in the
@@ -1614,26 +1614,26 @@ public class KeyStore {
}
/**
- * Gets a keystore Entry for the specified alias
+ * Gets a keystore {@code Entry} for the specified alias
* with the specified protection parameter.
*
- * @param alias get the keystore Entry for this alias
- * @param protParam the ProtectionParameter
- * used to protect the Entry,
- * which may be null
+ * @param alias get the keystore {@code Entry} for this alias
+ * @param protParam the {@code ProtectionParameter}
+ * used to protect the {@code Entry},
+ * which may be {@code null}
*
- * @return the keystore Entry for the specified alias,
- * or null if there is no such entry
+ * @return the keystore {@code Entry} for the specified alias,
+ * or {@code null} if there is no such entry
*
* @exception NullPointerException if
- * alias is null
+ * {@code alias} is {@code null}
* @exception NoSuchAlgorithmException if the algorithm for recovering the
* entry cannot be found
* @exception UnrecoverableEntryException if the specified
- * protParam were insufficient or invalid
+ * {@code protParam} were insufficient or invalid
* @exception UnrecoverableKeyException if the entry is a
- * PrivateKeyEntry or SecretKeyEntry
- * and the specified protParam does not contain
+ * {@code PrivateKeyEntry} or {@code SecretKeyEntry}
+ * and the specified {@code protParam} does not contain
* the information needed to recover the key (e.g. wrong password)
* @exception KeyStoreException if the keystore has not been initialized
* (loaded).
@@ -1655,22 +1655,22 @@ public class KeyStore {
}
/**
- * Saves a keystore Entry under the specified alias.
+ * Saves a keystore {@code Entry} under the specified alias.
* The protection parameter is used to protect the
- * Entry.
+ * {@code Entry}.
*
* Entry under this alias
- * @param entry the Entry to save
- * @param protParam the ProtectionParameter
- * used to protect the Entry,
- * which may be null
+ * @param alias save the keystore {@code Entry} under this alias
+ * @param entry the {@code Entry} to save
+ * @param protParam the {@code ProtectionParameter}
+ * used to protect the {@code Entry},
+ * which may be {@code null}
*
* @exception NullPointerException if
- * alias or entry
- * is null
+ * {@code alias} or {@code entry}
+ * is {@code null}
* @exception KeyStoreException if the keystore has not been initialized
* (loaded), or if this operation fails for some other reason
*
@@ -1691,20 +1691,20 @@ public class KeyStore {
}
/**
- * Determines if the keystore Entry for the specified
- * alias is an instance or subclass of the specified
- * entryClass.
+ * Determines if the keystore {@code Entry} for the specified
+ * {@code alias} is an instance or subclass of the specified
+ * {@code entryClass}.
*
* @param alias the alias name
* @param entryClass the entry class
*
- * @return true if the keystore Entry for the specified
- * alias is an instance or subclass of the
- * specified entryClass, false otherwise
+ * @return true if the keystore {@code Entry} for the specified
+ * {@code alias} is an instance or subclass of the
+ * specified {@code entryClass}, false otherwise
*
* @exception NullPointerException if
- * alias or entryClass
- * is null
+ * {@code alias} or {@code entryClass}
+ * is {@code null}
* @exception KeyStoreException if the keystore has not been
* initialized (loaded)
*
@@ -1764,7 +1764,7 @@ public class KeyStore {
/**
* Returns the ProtectionParameters that should be used to obtain
* the {@link KeyStore.Entry Entry} with the given alias.
- * The getKeyStore method must be invoked before this
+ * The {@code getKeyStore} method must be invoked before this
* method may be called.
*
* @return the ProtectionParameters that should be used to obtain
@@ -1782,9 +1782,9 @@ public class KeyStore {
/**
* Returns a new Builder that encapsulates the given KeyStore.
* The {@linkplain #getKeyStore} method of the returned object
- * will return keyStore, the {@linkplain
+ * will return {@code keyStore}, the {@linkplain
* #getProtectionParameter getProtectionParameter()} method will
- * return protectionParameters.
+ * return {@code protectionParameters}.
*
* type and call
+ * builder will create a KeyStore of type {@code type} and call
* its {@link KeyStore#load load()} method.
- * The inputStream argument is constructed from
- * file.
- * If protection is a
- * PasswordProtection, the password is obtained by
- * calling the getPassword method.
- * Otherwise, if protection is a
- * CallbackHandlerProtection, the password is obtained
+ * The {@code inputStream} argument is constructed from
+ * {@code file}.
+ * If {@code protection} is a
+ * {@code PasswordProtection}, the password is obtained by
+ * calling the {@code getPassword} method.
+ * Otherwise, if {@code protection} is a
+ * {@code CallbackHandlerProtection}, the password is obtained
* by invoking the CallbackHandler.
*
* provider if
+ * load method.
+ * {@code load} method.
*
* type.
+ * builder will return a new KeyStore object of type {@code type}.
* Its {@link KeyStore#load(KeyStore.LoadStoreParameter) load()}
* method is invoked using a
- * LoadStoreParameter that encapsulates
- * protection.
+ * {@code LoadStoreParameter} that encapsulates
+ * {@code protection}.
*
- * provider if
+ * protection.
+ * will return {@code protection}.
*
* KeyStoreException with the specified
+ * Creates a {@code KeyStoreException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -74,13 +74,13 @@ public class KeyStoreException extends GeneralSecurityException {
}
/**
- * Creates a KeyStoreException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code KeyStoreException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/KeyStoreSpi.java b/src/share/classes/java/security/KeyStoreSpi.java
index 8afd7d9f01fef687bf082f8a84de427a2374d1bb..f71aed439e31eaec5235cafbbc74f313dd6b022a 100644
--- a/src/share/classes/java/security/KeyStoreSpi.java
+++ b/src/share/classes/java/security/KeyStoreSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -38,7 +38,7 @@ import javax.security.auth.callback.*;
/**
* This class defines the Service Provider Interface (SPI)
- * for the KeyStore class.
+ * for the {@code KeyStore} class.
* All the abstract methods in this class must be implemented by each
* cryptographic service provider who wishes to supply the implementation
* of a keystore for a particular keystore type.
@@ -56,9 +56,9 @@ public abstract class KeyStoreSpi {
/**
* Returns the key associated with the given alias, using the given
* password to recover it. The key must have been associated with
- * the alias by a call to setKeyEntry,
- * or by a call to setEntry with a
- * PrivateKeyEntry or SecretKeyEntry.
+ * the alias by a call to {@code setKeyEntry},
+ * or by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry} or {@code SecretKeyEntry}.
*
* @param alias the alias name
* @param password the password for recovering the key
@@ -77,9 +77,9 @@ public abstract class KeyStoreSpi {
/**
* Returns the certificate chain associated with the given alias.
* The certificate chain must have been associated with the alias
- * by a call to setKeyEntry,
- * or by a call to setEntry with a
- * PrivateKeyEntry.
+ * by a call to {@code setKeyEntry},
+ * or by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry}.
*
* @param alias the alias name
*
@@ -93,15 +93,15 @@ public abstract class KeyStoreSpi {
* Returns the certificate associated with the given alias.
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* then the trusted certificate contained in that entry is returned.
*
* setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry,
+ * created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry},
* then the first element of the certificate chain in that entry
* (if a chain exists) is returned.
*
@@ -126,7 +126,7 @@ public abstract class KeyStoreSpi {
* Assigns the given key to the given alias, protecting it with the given
* password.
*
- * java.security.PrivateKey,
+ * java.security.PrivateKey).
+ * {@code java.security.PrivateKey}).
*
* @exception KeyStoreException if the given key cannot be protected, or
* this operation fails for some other reason
@@ -154,7 +154,7 @@ public abstract class KeyStoreSpi {
* alias.
*
* java.security.PrivateKey,
+ * {@code java.security.PrivateKey},
* it must be accompanied by a certificate chain certifying the
* corresponding public key.
*
@@ -166,7 +166,7 @@ public abstract class KeyStoreSpi {
* @param key the key (in protected format) to be associated with the alias
* @param chain the certificate chain for the corresponding public
* key (only useful if the protected key is of type
- * java.security.PrivateKey).
+ * {@code java.security.PrivateKey}).
*
* @exception KeyStoreException if this operation fails.
*/
@@ -178,9 +178,9 @@ public abstract class KeyStoreSpi {
* Assigns the given certificate to the given alias.
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* the trusted certificate in the existing entry
* is overridden by the given certificate.
*
@@ -230,9 +230,9 @@ public abstract class KeyStoreSpi {
/**
* Returns true if the entry identified by the given alias
- * was created by a call to setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry or a SecretKeyEntry.
+ * was created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry} or a {@code SecretKeyEntry}.
*
* @param alias the alias for the keystore entry to be checked
*
@@ -243,9 +243,9 @@ public abstract class KeyStoreSpi {
/**
* Returns true if the entry identified by the given alias
- * was created by a call to setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry.
+ * was created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry}.
*
* @param alias the alias for the keystore entry to be checked
*
@@ -260,15 +260,15 @@ public abstract class KeyStoreSpi {
*
* setCertificateEntry,
- * or created by a call to setEntry with a
- * TrustedCertificateEntry,
+ * created by a call to {@code setCertificateEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code TrustedCertificateEntry},
* then the given certificate is compared to that entry's certificate.
*
* setKeyEntry,
- * or created by a call to setEntry with a
- * PrivateKeyEntry,
+ * created by a call to {@code setKeyEntry},
+ * or created by a call to {@code setEntry} with a
+ * {@code PrivateKeyEntry},
* then the given certificate is compared to the first
* element of that entry's certificate chain.
*
@@ -297,14 +297,14 @@ public abstract class KeyStoreSpi {
/**
* Stores this keystore using the given
- * KeyStore.LoadStoreParmeter.
+ * {@code KeyStore.LoadStoreParmeter}.
*
- * @param param the KeyStore.LoadStoreParmeter
+ * @param param the {@code KeyStore.LoadStoreParmeter}
* that specifies how to store the keystore,
- * which may be null
+ * which may be {@code null}
*
* @exception IllegalArgumentException if the given
- * KeyStore.LoadStoreParmeter
+ * {@code KeyStore.LoadStoreParmeter}
* input is not recognized
* @exception IOException if there was an I/O problem with data
* @exception NoSuchAlgorithmException if the appropriate data integrity
@@ -330,17 +330,17 @@ public abstract class KeyStoreSpi {
* then integrity checking is not performed.
*
* @param stream the input stream from which the keystore is loaded,
- * or null
+ * or {@code null}
* @param password the password used to check the integrity of
* the keystore, the password used to unlock the keystore,
- * or null
+ * or {@code null}
*
* @exception IOException if there is an I/O or format problem with the
* keystore data, if a password is required but not given,
* or if the given password was incorrect. If the error is due to a
* wrong password, the {@link Throwable#getCause cause} of the
- * IOException should be an
- * UnrecoverableKeyException
+ * {@code IOException} should be an
+ * {@code UnrecoverableKeyException}
* @exception NoSuchAlgorithmException if the algorithm used to check
* the integrity of the keystore cannot be found
* @exception CertificateException if any of the certificates in the
@@ -351,24 +351,24 @@ public abstract class KeyStoreSpi {
/**
* Loads the keystore using the given
- * KeyStore.LoadStoreParameter.
+ * {@code KeyStore.LoadStoreParameter}.
*
* KeyStore.LoadStoreParameter
+ * @param param the {@code KeyStore.LoadStoreParameter}
* that specifies how to load the keystore,
- * which may be null
+ * which may be {@code null}
*
* @exception IllegalArgumentException if the given
- * KeyStore.LoadStoreParameter
+ * {@code KeyStore.LoadStoreParameter}
* input is not recognized
* @exception IOException if there is an I/O or format problem with the
* keystore data. If the error is due to an incorrect
- * ProtectionParameter (e.g. wrong password)
+ * {@code ProtectionParameter} (e.g. wrong password)
* the {@link Throwable#getCause cause} of the
- * IOException should be an
- * UnrecoverableKeyException
+ * {@code IOException} should be an
+ * {@code UnrecoverableKeyException}
* @exception NoSuchAlgorithmException if the algorithm used to check
* the integrity of the keystore cannot be found
* @exception CertificateException if any of the certificates in the
@@ -419,25 +419,25 @@ public abstract class KeyStoreSpi {
}
/**
- * Gets a KeyStore.Entry for the specified alias
+ * Gets a {@code KeyStore.Entry} for the specified alias
* with the specified protection parameter.
*
- * @param alias get the KeyStore.Entry for this alias
- * @param protParam the ProtectionParameter
- * used to protect the Entry,
- * which may be null
+ * @param alias get the {@code KeyStore.Entry} for this alias
+ * @param protParam the {@code ProtectionParameter}
+ * used to protect the {@code Entry},
+ * which may be {@code null}
*
- * @return the KeyStore.Entry for the specified alias,
- * or null if there is no such entry
+ * @return the {@code KeyStore.Entry} for the specified alias,
+ * or {@code null} if there is no such entry
*
* @exception KeyStoreException if the operation failed
* @exception NoSuchAlgorithmException if the algorithm for recovering the
* entry cannot be found
* @exception UnrecoverableEntryException if the specified
- * protParam were insufficient or invalid
+ * {@code protParam} were insufficient or invalid
* @exception UnrecoverableKeyException if the entry is a
- * PrivateKeyEntry or SecretKeyEntry
- * and the specified protParam does not contain
+ * {@code PrivateKeyEntry} or {@code SecretKeyEntry}
+ * and the specified {@code protParam} does not contain
* the information needed to recover the key (e.g. wrong password)
*
* @since 1.5
@@ -484,18 +484,18 @@ public abstract class KeyStoreSpi {
}
/**
- * Saves a KeyStore.Entry under the specified alias.
+ * Saves a {@code KeyStore.Entry} under the specified alias.
* The specified protection parameter is used to protect the
- * Entry.
+ * {@code Entry}.
*
* KeyStore.Entry under this alias
- * @param entry the Entry to save
- * @param protParam the ProtectionParameter
- * used to protect the Entry,
- * which may be null
+ * @param alias save the {@code KeyStore.Entry} under this alias
+ * @param entry the {@code Entry} to save
+ * @param protParam the {@code ProtectionParameter}
+ * used to protect the {@code Entry},
+ * which may be {@code null}
*
* @exception KeyStoreException if this operation fails
*
@@ -560,16 +560,16 @@ public abstract class KeyStoreSpi {
}
/**
- * Determines if the keystore Entry for the specified
- * alias is an instance or subclass of the specified
- * entryClass.
+ * Determines if the keystore {@code Entry} for the specified
+ * {@code alias} is an instance or subclass of the specified
+ * {@code entryClass}.
*
* @param alias the alias name
* @param entryClass the entry class
*
- * @return true if the keystore Entry for the specified
- * alias is an instance or subclass of the
- * specified entryClass, false otherwise
+ * @return true if the keystore {@code Entry} for the specified
+ * {@code alias} is an instance or subclass of the
+ * specified {@code entryClass}, false otherwise
*
* @since 1.5
*/
diff --git a/src/share/classes/java/security/MessageDigest.java b/src/share/classes/java/security/MessageDigest.java
index d1fe343c5c5bd371d293b7e1a4a2a2e8b9197c2c..fa686785c45c36d3d9a1e481a4ea8e0d128b390a 100644
--- a/src/share/classes/java/security/MessageDigest.java
+++ b/src/share/classes/java/security/MessageDigest.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -48,8 +48,8 @@ import java.nio.ByteBuffer;
* updated, one of the {@link #digest() digest} methods should
* be called to complete the hash computation.
*
- * digest method can be called once for a given number
- * of updates. After digest has been called, the MessageDigest
+ * MessageDigestSpi for historical reasons.
+ * {@code MessageDigestSpi} for historical reasons.
* Application developers should only take notice of the methods defined in
- * this MessageDigest class; all the methods in
+ * this {@code MessageDigest} class; all the methods in
* the superclass are intended for cryptographic service providers who wish to
* supply their own implementations of message digest algorithms.
*
* MessageDigest algorithms:
+ * the following standard {@code MessageDigest} algorithms:
*
- *
* These algorithms are described in the
@@ -301,7 +301,7 @@ public abstract class MessageDigest extends MessageDigestSpi {
* @param offset the offset to start from in the array of bytes.
*
* @param len the number of bytes to use, starting at
- * offset.
+ * {@code offset}.
*/
public void update(byte[] input, int offset, int len) {
if (input == null) {
@@ -326,8 +326,8 @@ public abstract class MessageDigest extends MessageDigestSpi {
/**
* Update the digest using the specified ByteBuffer. The digest is
- * updated using the input.remaining() bytes starting
- * at input.position().
+ * updated using the {@code input.remaining()} bytes starting
+ * at {@code input.position()}.
* Upon return, the buffer's position will be equal to its limit;
* its limit will not have changed.
*
@@ -365,7 +365,7 @@ public abstract class MessageDigest extends MessageDigestSpi {
*
* @param len number of bytes within buf allotted for the digest
*
- * @return the number of bytes placed into buf
+ * @return the number of bytes placed into {@code buf}
*
* @exception DigestException if an error occurs.
*/
@@ -386,7 +386,7 @@ public abstract class MessageDigest extends MessageDigestSpi {
* Performs a final update on the digest using the specified array
* of bytes, then completes the digest computation. That is, this
* method first calls {@link #update(byte[]) update(input)},
- * passing the input array to the update method,
+ * passing the input array to the {@code update} method,
* then calls {@link #digest() digest()}.
*
* @param input the input to be updated before the digest is
@@ -492,7 +492,7 @@ public abstract class MessageDigest extends MessageDigestSpi {
* @return a clone if the implementation is cloneable.
*
* @exception CloneNotSupportedException if this is called on an
- * implementation that does not support Cloneable.
+ * implementation that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
if (this instanceof Cloneable) {
@@ -536,7 +536,7 @@ public abstract class MessageDigest extends MessageDigestSpi {
* @return a clone if the delegate is cloneable.
*
* @exception CloneNotSupportedException if this is called on a
- * delegate that does not support Cloneable.
+ * delegate that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
if (digestSpi instanceof Cloneable) {
diff --git a/src/share/classes/java/security/MessageDigestSpi.java b/src/share/classes/java/security/MessageDigestSpi.java
index 700d7255b34d8a691590ca212819e31e60d2f29e..0d5ace1f7bfa1b84b33b4de497a9ae93921310c8 100644
--- a/src/share/classes/java/security/MessageDigestSpi.java
+++ b/src/share/classes/java/security/MessageDigestSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -31,7 +31,7 @@ import sun.security.jca.JCAUtil;
/**
* This class defines the Service Provider Interface (SPI)
- * for the MessageDigest class, which provides the functionality
+ * for the {@code MessageDigest} class, which provides the functionality
* of a message digest algorithm, such as MD5 or SHA. Message digests are
* secure one-way hash functions that take arbitrary-sized data and output a
* fixed-length hash value.
@@ -88,14 +88,14 @@ public abstract class MessageDigestSpi {
* @param offset the offset to start from in the array of bytes.
*
* @param len the number of bytes to use, starting at
- * offset.
+ * {@code offset}.
*/
protected abstract void engineUpdate(byte[] input, int offset, int len);
/**
* Update the digest using the specified ByteBuffer. The digest is
- * updated using the input.remaining() bytes starting
- * at input.position().
+ * updated using the {@code input.remaining()} bytes starting
+ * at {@code input.position()}.
* Upon return, the buffer's position will be equal to its limit;
* its limit will not have changed.
*
@@ -130,7 +130,7 @@ public abstract class MessageDigestSpi {
/**
* Completes the hash computation by performing final
- * operations such as padding. Once engineDigest has
+ * operations such as padding. Once {@code engineDigest} has
* been called, the engine should be reset (see
* {@link #engineReset() engineReset}).
* Resetting is the responsibility of the
@@ -142,7 +142,7 @@ public abstract class MessageDigestSpi {
/**
* Completes the hash computation by performing final
- * operations such as padding. Once engineDigest has
+ * operations such as padding. Once {@code engineDigest} has
* been called, the engine should be reset (see
* {@link #engineReset() engineReset}).
* Resetting is the responsibility of the
@@ -194,7 +194,7 @@ public abstract class MessageDigestSpi {
* @return a clone if the implementation is cloneable.
*
* @exception CloneNotSupportedException if this is called on an
- * implementation that does not support Cloneable.
+ * implementation that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
if (this instanceof Cloneable) {
diff --git a/src/share/classes/java/security/NoSuchAlgorithmException.java b/src/share/classes/java/security/NoSuchAlgorithmException.java
index fb3498130a26ca750d61394caef28a08e4e9591d..951e44e41dcb031fc49db62aca2bc8ae249014d9 100644
--- a/src/share/classes/java/security/NoSuchAlgorithmException.java
+++ b/src/share/classes/java/security/NoSuchAlgorithmException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -58,13 +58,13 @@ public class NoSuchAlgorithmException extends GeneralSecurityException {
}
/**
- * Creates a NoSuchAlgorithmException with the specified
+ * Creates a {@code NoSuchAlgorithmException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -73,13 +73,13 @@ public class NoSuchAlgorithmException extends GeneralSecurityException {
}
/**
- * Creates a NoSuchAlgorithmException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code NoSuchAlgorithmException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/Permission.java b/src/share/classes/java/security/Permission.java
index deee87c0ab7ecdb954f754c9aadfed1459ab2fee..dfa7163b43529d63830413c492726a8f56017f7d 100644
--- a/src/share/classes/java/security/Permission.java
+++ b/src/share/classes/java/security/Permission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2009, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -33,17 +33,17 @@ package java.security;
*
* java.io.FilePermission object, the permission name is
+ * for a {@code java.io.FilePermission} object, the permission name is
* the pathname of a file (or directory), and the actions list
* (such as "read, write") specifies which actions are granted for the
* specified file (or for files in the specified directory).
* The actions list is optional for Permission objects, such as
- * java.lang.RuntimePermission,
+ * {@code java.lang.RuntimePermission},
* that don't need such a list; you either have the named permission (such
* as "system.exit") or you don't.
*
* implies method to compare Permissions. Basically,
+ * the {@code implies} method to compare Permissions. Basically,
* "permission p1 implies permission p2" means that
* if one is granted permission p1, one is naturally granted permission p2.
* Thus, this is not an equality test, but rather more of a
@@ -81,7 +81,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
/**
* Implements the guard interface for a permission. The
- * SecurityManager.checkPermission method is called,
+ * {@code SecurityManager.checkPermission} method is called,
* passing this permission object as the permission to check.
* Returns silently if access is granted. Otherwise, throws
* a SecurityException.
@@ -90,7 +90,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
*
* @throws SecurityException
* if a security manager exists and its
- * checkPermission method doesn't allow access.
+ * {@code checkPermission} method doesn't allow access.
*
* @see Guard
* @see GuardedObject
@@ -109,7 +109,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
* This must be implemented by subclasses of Permission, as they are the
* only ones that can impose semantics on a Permission object.
*
- * implies method is used by the AccessController to determine
+ * equals method for making access control
- * decisions; use the implies method.
+ * Do not use the {@code equals} method for making access control
+ * decisions; use the {@code implies} method.
*
* @param obj the object we are testing for equality with this object.
*
@@ -137,18 +137,18 @@ public abstract class Permission implements Guard, java.io.Serializable {
/**
* Returns the hash code value for this Permission object.
* hashCode behavior for Permission Objects is
+ * The required {@code hashCode} behavior for Permission Objects is
* the following:
*
*
@@ -159,7 +159,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
/**
* Returns the name of this Permission.
- * For example, in the case of a hashCode method
+ * {@code hashCode} method
* must consistently return the same integer. This integer need not
* remain consistent from one execution of an application to another
* execution of the same application. equals
- * method, then calling the hashCode method on each of the
+ * {@code equals}
+ * method, then calling the {@code hashCode} method on each of the
* two Permission objects must produce the same integer result.
* java.io.FilePermission,
+ * For example, in the case of a {@code java.io.FilePermission},
* the name will be a pathname.
*
* @return the name of this Permission.
@@ -184,7 +184,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
*
*
* both return
- * "read,write" when the getActions method is invoked.
+ * "read,write" when the {@code getActions} method is invoked.
*
* @return the actions of this Permission.
*
@@ -197,7 +197,7 @@ public abstract class Permission implements Guard, java.io.Serializable {
* one is not defined. Subclasses of class Permission should
* override this if they need to store their permissions in a particular
* PermissionCollection object in order to provide the correct semantics
- * when the PermissionCollection.implies method is called.
+ * when the {@code PermissionCollection.implies} method is called.
* If null is returned,
* then the caller of this method is free to store permissions of this
* type in any PermissionCollection they choose (one that uses a Hashtable,
diff --git a/src/share/classes/java/security/PermissionCollection.java b/src/share/classes/java/security/PermissionCollection.java
index e6e1a18c74d03fa157397c1c87d0bc390c6d568b..58b7bdfd99f1582d206684b6d32067145fd72dcd 100644
--- a/src/share/classes/java/security/PermissionCollection.java
+++ b/src/share/classes/java/security/PermissionCollection.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -32,29 +32,29 @@ import java.util.*;
*
*
- *
* add method.
+ * implies method.
- * elements method.
+ * collection, using the {@code implies} method.
+ * newPermissionCollection method on that
+ * of the same type, the {@code newPermissionCollection} method on that
* particular type of Permission object should first be called. The default
* behavior (from the Permission class) is to simply return null.
* Subclasses of class Permission override the method if they need to store
* their permissions in a particular PermissionCollection object in order
* to provide the correct semantics when the
- * PermissionCollection.implies method is called.
+ * {@code PermissionCollection.implies} method is called.
* If a non-null value is returned, that PermissionCollection must be used.
- * If null is returned, then the caller of newPermissionCollection
+ * If null is returned, then the caller of {@code newPermissionCollection}
* is free to store permissions of the
* given type in any PermissionCollection they choose
* (one that uses a Hashtable, one that uses a Vector, etc).
*
* Permission.newPermissionCollection
+ * {@code Permission.newPermissionCollection}
* method is a homogeneous collection, which stores only Permission objects
* for a given Permission type. A PermissionCollection may also be
* heterogeneous. For example, Permissions is a PermissionCollection
@@ -62,16 +62,16 @@ import java.util.*;
* That is, its members are each a homogeneous PermissionCollection.
* For example, a Permissions object might have a FilePermissionCollection
* for all the FilePermission objects, a SocketPermissionCollection for all the
- * SocketPermission objects, and so on. Its add method adds a
+ * SocketPermission objects, and so on. Its {@code add} method adds a
* permission to the appropriate collection.
*
* newPermissionCollection method on the permission's class
+ * the {@code newPermissionCollection} method on the permission's class
* to see if it requires a special PermissionCollection. If
- * newPermissionCollection
+ * {@code newPermissionCollection}
* returns null, the PermissionCollection
* is free to store the permission in any type of PermissionCollection it
* desires (one using a Hashtable, one using a Vector, etc.). For example,
@@ -81,7 +81,7 @@ import java.util.*;
* elements method are
+ * Enumerations returned via the {@code elements} method are
* not fail-fast. Modifications to a collection should not be
* performed while enumerating over that collection.
*
@@ -134,7 +134,7 @@ public abstract class PermissionCollection implements java.io.Serializable {
* Marks this PermissionCollection object as "readonly". After
* a PermissionCollection object
* is marked as readonly, no new Permission objects can be added to it
- * using add.
+ * using {@code add}.
*/
public void setReadOnly() {
readOnly = true;
@@ -143,10 +143,10 @@ public abstract class PermissionCollection implements java.io.Serializable {
/**
* Returns true if this PermissionCollection object is marked as readonly.
* If it is readonly, no new Permission objects can be added to it
- * using add.
+ * using {@code add}.
*
* setReadOnly.
+ * readonly by a call to {@code setReadOnly}.
*
* @return true if this PermissionCollection object is marked as readonly,
* false otherwise.
@@ -166,7 +166,7 @@ public abstract class PermissionCollection implements java.io.Serializable {
* // one per line..
* )
*
- * super.toString is a call to the toString
+ * {@code super.toString} is a call to the {@code toString}
* method of this
* object's superclass, which is Object. The result is
* this PermissionCollection's type name followed by this object's
diff --git a/src/share/classes/java/security/Permissions.java b/src/share/classes/java/security/Permissions.java
index 986fd4b2c0e380b10c91178747c8c8a3ef86179f..cce9f5f56f3d5b804a5595002435db3274657b1a 100644
--- a/src/share/classes/java/security/Permissions.java
+++ b/src/share/classes/java/security/Permissions.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -44,26 +44,26 @@ import java.io.IOException;
* This class represents a heterogeneous collection of Permissions. That is,
* it contains different types of Permission objects, organized into
* PermissionCollections. For example, if any
- * java.io.FilePermission objects are added to an instance of
+ * {@code java.io.FilePermission} objects are added to an instance of
* this class, they are all stored in a single
* PermissionCollection. It is the PermissionCollection returned by a call to
- * the newPermissionCollection method in the FilePermission class.
- * Similarly, any java.lang.RuntimePermission objects are
+ * the {@code newPermissionCollection} method in the FilePermission class.
+ * Similarly, any {@code java.lang.RuntimePermission} objects are
* stored in the PermissionCollection returned by a call to the
- * newPermissionCollection method in the
+ * {@code newPermissionCollection} method in the
* RuntimePermission class. Thus, this class represents a collection of
* PermissionCollections.
*
- * add method is called to add a Permission, the
+ * newPermissionCollection method is called on that class to create
+ * {@code newPermissionCollection} method is called on that class to create
* the PermissionCollection and add it to the Permissions object. If
- * newPermissionCollection returns null, then a default
+ * {@code newPermissionCollection} returns null, then a default
* PermissionCollection that uses a hashtable will be created and used. Each
* hashtable entry stores a Permission object as both the key and the value.
*
- * elements method are
+ * implies method
+ * Then if the {@code implies} method
* is called with a permission specifying both "read" and "write" access
- * to files in the "/tmp/scratch/foo" directory, true is
+ * to files in the "/tmp/scratch/foo" directory, {@code true} is
* returned.
*
* newPermissionCollection method
+ * To do so, it first calls the {@code newPermissionCollection} method
* on p. Subclasses of class Permission
* override that method if they need to store their permissions in a
* particular PermissionCollection object in order to provide the
- * correct semantics when the PermissionCollection.implies
+ * correct semantics when the {@code PermissionCollection.implies}
* method is called.
* If the call returns a PermissionCollection, that collection is stored
* in this Permissions object. If the call returns null and createEmpty
diff --git a/src/share/classes/java/security/Policy.java b/src/share/classes/java/security/Policy.java
index 0daf12606087224e1d34f039cd35202763235d7d..ffbcb44cf3f00a6659b0a26696604f2faf3d5529 100644
--- a/src/share/classes/java/security/Policy.java
+++ b/src/share/classes/java/security/Policy.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -41,11 +41,11 @@ import sun.security.util.SecurityConstants;
*
* setPolicy method. The installed Policy object can be
- * obtained by calling the getPolicy method.
+ * {@code setPolicy} method. The installed Policy object can be
+ * obtained by calling the {@code getPolicy} method.
*
* getPolicy installs an instance of the default Policy
+ * {@code getPolicy} installs an instance of the default Policy
* implementation (a default subclass implementation of this abstract class).
* The default Policy implementation can be changed by setting the value
* of the {@code policy.provider} security property to the fully qualified
@@ -53,26 +53,26 @@ import sun.security.util.SecurityConstants;
*
* getInstance factory methods
+ * constructed by invoking one of the {@code getInstance} factory methods
* with a standard type. The default policy type is "JavaPolicy".
*
* setPolicy), the Java runtime invokes its
- * implies method when it needs to
+ * calling {@code setPolicy}), the Java runtime invokes its
+ * {@code implies} method when it needs to
* determine whether executing code (encapsulated in a ProtectionDomain)
* can perform SecurityManager-protected operations. How a Policy object
* retrieves its policy data is up to the Policy implementation itself.
* The policy data may be stored, for example, in a flat ASCII file,
* in a serialized binary file of the Policy class, or in a database.
*
- * refresh method causes the policy object to
+ * refresh will cause it to re-read the configuration
+ * calling {@code refresh} will cause it to re-read the configuration
* policy files. If a refresh operation is not supported, this method does
* nothing. Note that refreshed policy may not have an effect on classes
* in a particular ProtectionDomain. This is dependent on the Policy
- * provider's implementation of the implies
+ * provider's implementation of the {@code implies}
* method and its PermissionCollection caching strategy.
*
* @author Roland Schemers
@@ -130,17 +130,17 @@ public abstract class Policy {
/**
* Returns the installed Policy object. This value should not be cached,
- * as it may be changed by a call to setPolicy.
+ * as it may be changed by a call to {@code setPolicy}.
* This method first calls
- * SecurityManager.checkPermission with a
- * SecurityPermission("getPolicy") permission
+ * {@code SecurityManager.checkPermission} with a
+ * {@code SecurityPermission("getPolicy")} permission
* to ensure it's ok to get the Policy object.
*
* @return the installed Policy.
*
* @throws SecurityException
* if a security manager exists and its
- * checkPermission method doesn't allow
+ * {@code checkPermission} method doesn't allow
* getting the Policy object.
*
* @see SecurityManager#checkPermission(Permission)
@@ -246,15 +246,15 @@ public abstract class Policy {
/**
* Sets the system-wide Policy object. This method first calls
- * SecurityManager.checkPermission with a
- * SecurityPermission("setPolicy")
+ * {@code SecurityManager.checkPermission} with a
+ * {@code SecurityPermission("setPolicy")}
* permission to ensure it's ok to set the Policy.
*
* @param p the new system Policy object.
*
* @throws SecurityException
* if a security manager exists and its
- * checkPermission method doesn't allow
+ * {@code checkPermission} method doesn't allow
* setting the Policy.
*
* @see SecurityManager#checkPermission(Permission)
@@ -536,7 +536,7 @@ public abstract class Policy {
* Return the Provider of this Policy.
*
* Policy.getInstance.
+ * was obtained via a call to {@code Policy.getInstance}.
* Otherwise this method returns null.
*
* @return the Provider of this Policy, or null.
@@ -551,7 +551,7 @@ public abstract class Policy {
* Return the type of this Policy.
*
* Policy.getInstance.
+ * was obtained via a call to {@code Policy.getInstance}.
* Otherwise this method returns null.
*
* @return the type of this Policy, or null.
@@ -566,7 +566,7 @@ public abstract class Policy {
* Return Policy parameters.
*
* Policy.getInstance.
+ * was obtained via a call to {@code Policy.getInstance}.
* Otherwise this method returns null.
*
* @return Policy parameters, or null.
@@ -583,10 +583,10 @@ public abstract class Policy {
*
* implies method
+ * Applications should solely rely on the {@code implies} method
* to perform policy checks. If an application absolutely must call
* a getPermissions method, it should call
- * getPermissions(ProtectionDomain).
+ * {@code getPermissions(ProtectionDomain)}.
*
* implies method
+ * Applications should rely on the {@code implies} method
* to perform policy checks.
*
* getPermissions(CodeSource)
+ * the permissions returned via {@code getPermissions(CodeSource)}
* (the CodeSource is taken from the specified ProtectionDomain),
* as well as the permissions located inside the specified ProtectionDomain.
* All of these permissions are then combined and returned in a new
- * PermissionCollection object. If getPermissions(CodeSource)
+ * PermissionCollection object. If {@code getPermissions(CodeSource)}
* returns Policy.UNSUPPORTED_EMPTY_COLLECTION, then this method
* returns the permissions contained inside the specified ProtectionDomain
* in a new PermissionCollection object.
@@ -733,7 +733,7 @@ public abstract class Policy {
/**
* Refreshes/reloads the policy configuration. The behavior of this method
- * depends on the implementation. For example, calling refresh
+ * depends on the implementation. For example, calling {@code refresh}
* on a file-based policy will cause the file to be re-read.
*
* getPermissions(CodeSource) and
- * getPermissions(ProtectionDomain)
+ * is returned from the {@code getPermissions(CodeSource)} and
+ * {@code getPermissions(ProtectionDomain)}
* methods in the Policy class when those operations are not
* supported by the Policy implementation.
*/
diff --git a/src/share/classes/java/security/PolicySpi.java b/src/share/classes/java/security/PolicySpi.java
index aa66ba83f4138360c861212c5ec2484d49963808..608ce1fa777990982feed0672762c0f3acbd1e96 100644
--- a/src/share/classes/java/security/PolicySpi.java
+++ b/src/share/classes/java/security/PolicySpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -28,15 +28,15 @@ package java.security;
/**
* This class defines the Service Provider Interface (SPI)
- * for the Policy class.
+ * for the {@code Policy} class.
* All the abstract methods in this class must be implemented by each
* service provider who wishes to supply a Policy implementation.
*
* Policy.Parameters
+ * a public constructor that takes a {@code Policy.Parameters}
* object as an input parameter. This constructor also must throw
* an IllegalArgumentException if it does not understand the
- * Policy.Parameters input.
+ * {@code Policy.Parameters} input.
*
*
* @since 1.6
@@ -59,7 +59,7 @@ public abstract class PolicySpi {
/**
* Refreshes/reloads the policy configuration. The behavior of this method
- * depends on the implementation. For example, calling refresh
+ * depends on the implementation. For example, calling {@code refresh}
* on a file-based policy will cause the file to be re-read.
*
* AccessController.doPrivileged on the
- * PrivilegedAction object. This interface is used only for
+ * performed by invoking {@code AccessController.doPrivileged} on the
+ * {@code PrivilegedAction} object. This interface is used only for
* computations that do not throw checked exceptions; computations that
- * throw checked exceptions must use PrivilegedExceptionAction
+ * throw checked exceptions must use {@code PrivilegedExceptionAction}
* instead.
*
* @see AccessController
@@ -42,11 +42,11 @@ package java.security;
public interface PrivilegedActionAccessController.doPrivileged after enabling privileges.
+ * {@code AccessController.doPrivileged} after enabling privileges.
*
* @return a class-dependent value that may represent the results of the
* computation. Each class that implements
- * PrivilegedAction
+ * {@code PrivilegedAction}
* should document what (if anything) this value represents.
* @see AccessController#doPrivileged(PrivilegedAction)
* @see AccessController#doPrivileged(PrivilegedAction,
diff --git a/src/share/classes/java/security/PrivilegedActionException.java b/src/share/classes/java/security/PrivilegedActionException.java
index 04e95366e57fe00b62f86887edc32ce514ae8ed9..2de696985990015860c5ae8eed25d1bb9de0e759 100644
--- a/src/share/classes/java/security/PrivilegedActionException.java
+++ b/src/share/classes/java/security/PrivilegedActionException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -27,13 +27,13 @@ package java.security;
/**
* This exception is thrown by
- * doPrivileged(PrivilegedExceptionAction) and
- * doPrivileged(PrivilegedExceptionAction,
- * AccessControlContext context) to indicate
+ * {@code doPrivileged(PrivilegedExceptionAction)} and
+ * {@code doPrivileged(PrivilegedExceptionAction,
+ * AccessControlContext context)} to indicate
* that the action being performed threw a checked exception. The exception
* thrown by the action can be obtained by calling the
- * getException method. In effect, an
- * PrivilegedActionException is a "wrapper"
+ * {@code getException} method. In effect, an
+ * {@code PrivilegedActionException} is a "wrapper"
* for an exception thrown by a privileged action.
*
* PrivilegedActionException.
+ * resulted in this {@code PrivilegedActionException}.
*
* PrivilegedActionException.
+ * resulted in this {@code PrivilegedActionException}.
* @see PrivilegedExceptionAction
* @see AccessController#doPrivileged(PrivilegedExceptionAction)
* @see AccessController#doPrivileged(PrivilegedExceptionAction,
@@ -89,7 +89,7 @@ public class PrivilegedActionException extends Exception {
/**
* Returns the cause of this exception (the exception thrown by
* the privileged computation that resulted in this
- * PrivilegedActionException).
+ * {@code PrivilegedActionException}).
*
* @return the cause of this exception.
* @since 1.4
diff --git a/src/share/classes/java/security/PrivilegedExceptionAction.java b/src/share/classes/java/security/PrivilegedExceptionAction.java
index ff508ccdecd382bb3eaeda02e20714e2924984eb..59a9ba7dc18d43073b597ea225c127cf46712a08 100644
--- a/src/share/classes/java/security/PrivilegedExceptionAction.java
+++ b/src/share/classes/java/security/PrivilegedExceptionAction.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -29,11 +29,11 @@ package java.security;
/**
* A computation to be performed with privileges enabled, that throws one or
* more checked exceptions. The computation is performed by invoking
- * AccessController.doPrivileged on the
- * PrivilegedExceptionAction object. This interface is
+ * {@code AccessController.doPrivileged} on the
+ * {@code PrivilegedExceptionAction} object. This interface is
* used only for computations that throw checked exceptions;
* computations that do not throw
- * checked exceptions should use PrivilegedAction instead.
+ * checked exceptions should use {@code PrivilegedAction} instead.
*
* @see AccessController
* @see AccessController#doPrivileged(PrivilegedExceptionAction)
@@ -45,14 +45,14 @@ package java.security;
public interface PrivilegedExceptionActionAccessController.doPrivileged after enabling privileges.
+ * {@code AccessController.doPrivileged} after enabling privileges.
*
* @return a class-dependent value that may represent the results of the
* computation. Each class that implements
- * PrivilegedExceptionAction should document what
+ * {@code PrivilegedExceptionAction} should document what
* (if anything) this value represents.
* @throws Exception an exceptional condition has occurred. Each class
- * that implements PrivilegedExceptionAction should
+ * that implements {@code PrivilegedExceptionAction} should
* document the exceptions that its run method can throw.
* @see AccessController#doPrivileged(PrivilegedExceptionAction)
* @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)
diff --git a/src/share/classes/java/security/ProtectionDomain.java b/src/share/classes/java/security/ProtectionDomain.java
index 7cd3098aa564e66a6f03fa15a0763b6c75095b29..3e306edd3767f9da1977b0e47498afc44886647b 100644
--- a/src/share/classes/java/security/ProtectionDomain.java
+++ b/src/share/classes/java/security/ProtectionDomain.java
@@ -119,7 +119,7 @@ public class ProtectionDomain {
/**
* Creates a new ProtectionDomain with the given CodeSource and
* Permissions. If the permissions object is not null, then
- * setReadOnly()) will be called on the passed in
+ * {@code setReadOnly())} will be called on the passed in
* Permissions object. The only permissions granted to this domain
* are the ones specified; the current Policy will not be consulted.
*
@@ -145,7 +145,7 @@ public class ProtectionDomain {
/**
* Creates a new ProtectionDomain qualified by the given CodeSource,
* Permissions, ClassLoader and array of Principals. If the
- * permissions object is not null, then setReadOnly()
+ * permissions object is not null, then {@code setReadOnly()}
* will be called on the passed in Permissions object.
* The permissions granted to this domain are dynamic; they include
* both the static permissions passed to this constructor, and any
@@ -155,7 +155,7 @@ public class ProtectionDomain {
* This constructor is typically used by
* {@link SecureClassLoader ClassLoaders}
* and {@link DomainCombiner DomainCombiners} which delegate to
- * Policy to actively associate the permissions granted to
+ * {@code Policy} to actively associate the permissions granted to
* this domain. This constructor affords the
* Policy provider the opportunity to augment the supplied
* PermissionCollection to reflect policy changes.
diff --git a/src/share/classes/java/security/Provider.java b/src/share/classes/java/security/Provider.java
index 72fcabbd918d7db1f338b067873dcc5d3a8b556f..54cf9327d1d12d420b5e48093ea4c15e4a6ab805 100644
--- a/src/share/classes/java/security/Provider.java
+++ b/src/share/classes/java/security/Provider.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -62,20 +62,20 @@ import java.lang.reflect.*;
* security token. A {@link ProviderException} should be used to indicate
* such errors.
*
- * Provider is reserved for use by the
+ *
*
*
* @author Benjamin Renaud
@@ -185,18 +185,18 @@ public abstract class Provider extends Properties {
* used to look up facilities implemented by the provider.
*
* Name Value
- * Provider.id nameString.valueOf(provider.getName())Provider.id versionString.valueOf(provider.getVersion())Provider.id infoString.valueOf(provider.getInfo())Provider.id classNameprovider.getClass().getName(){@code Provider.id name}
+ * {@code String.valueOf(provider.getName())}
+ * {@code Provider.id version}
+ * {@code String.valueOf(provider.getVersion())}
+ * {@code Provider.id info}
+ {@code String.valueOf(provider.getInfo())}
+ * {@code Provider.id className}
+ * {@code provider.getClass().getName()}
* checkSecurityAccess method is called with the string
- * "clearProviderProperties."+name (where name
+ * {@code checkSecurityAccess} method is called with the string
+ * {@code "clearProviderProperties."+name} (where {@code name}
* is the provider name) to see if it's ok to clear this provider.
- * If the default implementation of checkSecurityAccess
+ * If the default implementation of {@code checkSecurityAccess}
* is used (that is, that method is not overriden), then this results in
- * a call to the security manager's checkPermission method
- * with a SecurityPermission("clearProviderProperties."+name)
+ * a call to the security manager's {@code checkPermission} method
+ * with a {@code SecurityPermission("clearProviderProperties."+name)}
* permission.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies access to clear this provider
*
* @since 1.2
@@ -292,17 +292,17 @@ public abstract class Provider extends Properties {
}
/**
- * Sets the key property to have the specified
- * value.
+ * Sets the {@code key} property to have the specified
+ * {@code value}.
*
* checkSecurityAccess method is called with the string
- * "putProviderProperty."+name, where name is the
+ * {@code checkSecurityAccess} method is called with the string
+ * {@code "putProviderProperty."+name}, where {@code name} is the
* provider name, to see if it's ok to set this provider's property values.
- * If the default implementation of checkSecurityAccess
+ * If the default implementation of {@code checkSecurityAccess}
* is used (that is, that method is not overriden), then this results in
- * a call to the security manager's checkPermission method
- * with a SecurityPermission("putProviderProperty."+name)
+ * a call to the security manager's {@code checkPermission} method
+ * with a {@code SecurityPermission("putProviderProperty."+name)}
* permission.
*
* @param key the property key.
@@ -310,11 +310,11 @@ public abstract class Provider extends Properties {
* @param value the property value.
*
* @return the previous value of the specified property
- * (key), or null if it did not have one.
+ * ({@code key}), or null if it did not have one.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies access to set property values.
*
* @since 1.2
@@ -329,18 +329,18 @@ public abstract class Provider extends Properties {
}
/**
- * Removes the key property (and its corresponding
- * value).
+ * Removes the {@code key} property (and its corresponding
+ * {@code value}).
*
* checkSecurityAccess method is called with the string
- * "removeProviderProperty."+name, where name is
+ * {@code checkSecurityAccess} method is called with the string
+ * {@code "removeProviderProperty."+name}, where {@code name} is
* the provider name, to see if it's ok to remove this provider's
* properties. If the default implementation of
- * checkSecurityAccess is used (that is, that method is not
+ * {@code checkSecurityAccess} is used (that is, that method is not
* overriden), then this results in a call to the security manager's
- * checkPermission method with a
- * SecurityPermission("removeProviderProperty."+name)
+ * {@code checkPermission} method with a
+ * {@code SecurityPermission("removeProviderProperty."+name)}
* permission.
*
* @param key the key for the property to be removed.
@@ -349,8 +349,8 @@ public abstract class Provider extends Properties {
* or null if the key did not have a mapping.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies access to remove this provider's properties.
*
* @since 1.2
@@ -662,9 +662,9 @@ public abstract class Provider extends Properties {
* the service added via {@link #putService putService()} is returned.
*
* @param type the type of {@link Service service} requested
- * (for example, MessageDigest)
+ * (for example, {@code MessageDigest})
* @param algorithm the case insensitive algorithm name (or alternate
- * alias) of the service requested (for example, SHA-1)
+ * alias) of the service requested (for example, {@code SHA-1})
*
* @return the service describing this Provider's matching service
* or null if no such service exists
@@ -739,20 +739,20 @@ public abstract class Provider extends Properties {
* Java Cryptography Architecture API Specification & Reference checkSecurityAccess method is called with the string
- * "putProviderProperty."+name, where name is
+ * {@code checkSecurityAccess} method is called with the string
+ * {@code "putProviderProperty."+name}, where {@code name} is
* the provider name, to see if it's ok to set this provider's property
- * values. If the default implementation of checkSecurityAccess
+ * values. If the default implementation of {@code checkSecurityAccess}
* is used (that is, that method is not overriden), then this results in
- * a call to the security manager's checkPermission method with
- * a SecurityPermission("putProviderProperty."+name)
+ * a call to the security manager's {@code checkPermission} method with
+ * a {@code SecurityPermission("putProviderProperty."+name)}
* permission.
*
* @param s the Service to add
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method denies
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method denies
* access to set property values.
* @throws NullPointerException if s is null
*
@@ -830,21 +830,21 @@ public abstract class Provider extends Properties {
* from this provider's Hashtable.
*
* checkSecurityAccess method is called with the string
- * "removeProviderProperty."+name, where name is
+ * {@code checkSecurityAccess} method is called with the string
+ * {@code "removeProviderProperty."+name}, where {@code name} is
* the provider name, to see if it's ok to remove this provider's
* properties. If the default implementation of
- * checkSecurityAccess is used (that is, that method is not
+ * {@code checkSecurityAccess} is used (that is, that method is not
* overriden), then this results in a call to the security manager's
- * checkPermission method with a
- * SecurityPermission("removeProviderProperty."+name)
+ * {@code checkPermission} method with a
+ * {@code SecurityPermission("removeProviderProperty."+name)}
* permission.
*
* @param s the Service to be removed
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method denies
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method denies
* access to remove this provider's properties.
* @throws NullPointerException if s is null
*
@@ -1122,7 +1122,7 @@ public abstract class Provider extends Properties {
}
/**
- * Get the type of this service. For example, MessageDigest.
+ * Get the type of this service. For example, {@code MessageDigest}.
*
* @return the type of this service
*/
@@ -1132,7 +1132,7 @@ public abstract class Provider extends Properties {
/**
* Return the name of the algorithm of this service. For example,
- * SHA-1.
+ * {@code SHA-1}.
*
* @return the algorithm of this service
*/
diff --git a/src/share/classes/java/security/ProviderException.java b/src/share/classes/java/security/ProviderException.java
index 449c8c361686528495dec678d4264194ab48b62c..b372ee7575272a3ab0285c1ed0acc72c366c0727 100644
--- a/src/share/classes/java/security/ProviderException.java
+++ b/src/share/classes/java/security/ProviderException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -58,13 +58,13 @@ public class ProviderException extends RuntimeException {
}
/**
- * Creates a ProviderException with the specified
+ * Creates a {@code ProviderException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -73,13 +73,13 @@ public class ProviderException extends RuntimeException {
}
/**
- * Creates a ProviderException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code ProviderException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/PublicKey.java b/src/share/classes/java/security/PublicKey.java
index c983ff611d985d36957ca8db75704b98bb826d8d..df49807eea4beb0986cf0bee73349931f2c03bc9 100644
--- a/src/share/classes/java/security/PublicKey.java
+++ b/src/share/classes/java/security/PublicKey.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2001, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -32,7 +32,7 @@ package java.security;
*
* Note: The specialized public key interfaces extend this interface.
* See, for example, the DSAPublicKey interface in
- * java.security.interfaces.
+ * {@code java.security.interfaces}.
*
* @see Key
* @see PrivateKey
diff --git a/src/share/classes/java/security/SecureClassLoader.java b/src/share/classes/java/security/SecureClassLoader.java
index ffcd1a7160f195ae78ad897278564b33de737305..145f4fc482b5d9884369e67f5a4a6e419141a7b4 100644
--- a/src/share/classes/java/security/SecureClassLoader.java
+++ b/src/share/classes/java/security/SecureClassLoader.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -63,12 +63,12 @@ public class SecureClassLoader extends ClassLoader {
* class loader for delegation.
*
* checkCreateClassLoader
+ * calls the security manager's {@code checkCreateClassLoader}
* method to ensure creation of a class loader is allowed.
* checkCreateClassLoader method doesn't allow
+ * {@code checkCreateClassLoader} method doesn't allow
* creation of a class loader.
* @see SecurityManager#checkCreateClassLoader
*/
@@ -87,11 +87,11 @@ public class SecureClassLoader extends ClassLoader {
* loader for delegation.
*
* checkCreateClassLoader
+ * calls the security manager's {@code checkCreateClassLoader}
* method to ensure creation of a class loader is allowed.
*
* @exception SecurityException if a security manager exists and its
- * checkCreateClassLoader method doesn't allow
+ * {@code checkCreateClassLoader} method doesn't allow
* creation of a class loader.
* @see SecurityManager#checkCreateClassLoader
*/
@@ -113,22 +113,22 @@ public class SecureClassLoader extends ClassLoader {
* If a non-null CodeSource is supplied a ProtectionDomain is
* constructed and associated with the class being defined.
* null
+ * @param name the expected name of the class, or {@code null}
* if not known, using '.' and not '/' as the separator
* and without a trailing ".class" suffix.
* @param b the bytes that make up the class data. The bytes in
- * positions off through off+len-1
+ * positions {@code off} through {@code off+len-1}
* should have the format of a valid class file as defined by
* The Java™ Virtual Machine Specification.
- * @param off the start offset in b of the class data
+ * @param off the start offset in {@code b} of the class data
* @param len the length of the class data
- * @param cs the associated CodeSource, or null if none
- * @return the Class object created from the data,
+ * @param cs the associated CodeSource, or {@code null} if none
+ * @return the {@code Class} object created from the data,
* and optional CodeSource.
* @exception ClassFormatError if the data did not contain a valid class
- * @exception IndexOutOfBoundsException if either off or
- * len is negative, or if
- * off+len is greater than b.length.
+ * @exception IndexOutOfBoundsException if either {@code off} or
+ * {@code len} is negative, or if
+ * {@code off+len} is greater than {@code b.length}.
*
* @exception SecurityException if an attempt is made to add this class
* to a package that contains classes that were signed by
@@ -143,22 +143,22 @@ public class SecureClassLoader extends ClassLoader {
}
/**
- * Converts a {@link java.nio.ByteBuffer ByteBuffer}
- * into an instance of class Class, with an optional CodeSource.
+ * Converts a {@link java.nio.ByteBuffer ByteBuffer}
+ * into an instance of class {@code Class}, with an optional CodeSource.
* Before the class can be used it must be resolved.
* null
+ * @param name the expected name of the class, or {@code null}
* if not known, using '.' and not '/' as the separator
* and without a trailing ".class" suffix.
* @param b the bytes that make up the class data. The bytes from positions
- * b.position() through b.position() + b.limit() -1
+ * {@code b.position()} through {@code b.position() + b.limit() -1}
* should have the format of a valid class file as defined by
* The Java™ Virtual Machine Specification.
- * @param cs the associated CodeSource, or null if none
- * @return the Class object created from the data,
+ * @param cs the associated CodeSource, or {@code null} if none
+ * @return the {@code Class} object created from the data,
* and optional CodeSource.
* @exception ClassFormatError if the data did not contain a valid class
* @exception SecurityException if an attempt is made to add this class
diff --git a/src/share/classes/java/security/SecureRandom.java b/src/share/classes/java/security/SecureRandom.java
index 7d25b147ed316d132806e7d7b7a4f8bcd702bdde..5afec7b0797d854571d282bf83e5d15cd839c75f 100644
--- a/src/share/classes/java/security/SecureRandom.java
+++ b/src/share/classes/java/security/SecureRandom.java
@@ -50,7 +50,7 @@ import sun.security.jca.GetInstance.Instance;
* RFC 1750: Randomness Recommendations for SecuritygetInstance methods:
+ * no-argument constructor or one of the {@code getInstance} methods:
*
*
* SecureRandom random = new SecureRandom();
@@ -71,15 +71,15 @@ import sun.security.jca.GetInstance.Instance;
* random.nextBytes(bytes);
*
*
- * generateSeed method
+ *
* byte seed[] = random.generateSeed(20);
*
*
- * Note: Depending on the implementation, the generateSeed and
- * nextBytes methods may block as entropy is being gathered,
+ * Note: Depending on the implementation, the {@code generateSeed} and
+ * {@code nextBytes} methods may block as entropy is being gathered,
* for example, if they need to read from /dev/random on various Unix-like
* operating systems.
*
@@ -140,16 +140,16 @@ public class SecureRandom extends java.util.Random {
* for information about standard RNG algorithm names.
*
* setSeed method.
- * If setSeed is not called, the first call to
- * nextBytes will force the SecureRandom object to seed itself.
- * This self-seeding will not occur if setSeed was
+ * returned object, call the {@code setSeed} method.
+ * If {@code setSeed} is not called, the first call to
+ * {@code nextBytes} will force the SecureRandom object to seed itself.
+ * This self-seeding will not occur if {@code setSeed} was
* previously called.
*/
public SecureRandom() {
/*
* This call to our superclass constructor will result in a call
- * to our own setSeed method, which will return
+ * to our own {@code setSeed} method, which will return
* immediately when it is passed zero.
*/
super(0);
@@ -250,10 +250,10 @@ public class SecureRandom extends java.util.Random {
* the {@link Security#getProviders() Security.getProviders()} method.
*
* setSeed method.
- * If setSeed is not called, the first call to
- * nextBytes will force the SecureRandom object to seed itself.
- * This self-seeding will not occur if setSeed was
+ * returned object, call the {@code setSeed} method.
+ * If {@code setSeed} is not called, the first call to
+ * {@code nextBytes} will force the SecureRandom object to seed itself.
+ * This self-seeding will not occur if {@code setSeed} was
* previously called.
*
* @param algorithm the name of the RNG algorithm.
@@ -293,10 +293,10 @@ public class SecureRandom extends java.util.Random {
* the {@link Security#getProviders() Security.getProviders()} method.
*
* setSeed method.
- * If setSeed is not called, the first call to
- * nextBytes will force the SecureRandom object to seed itself.
- * This self-seeding will not occur if setSeed was
+ * returned object, call the {@code setSeed} method.
+ * If {@code setSeed} is not called, the first call to
+ * {@code nextBytes} will force the SecureRandom object to seed itself.
+ * This self-seeding will not occur if {@code setSeed} was
* previously called.
*
* @param algorithm the name of the RNG algorithm.
@@ -341,10 +341,10 @@ public class SecureRandom extends java.util.Random {
* does not have to be registered in the provider list.
*
* setSeed method.
- * If setSeed is not called, the first call to
- * nextBytes will force the SecureRandom object to seed itself.
- * This self-seeding will not occur if setSeed was
+ * returned object, call the {@code setSeed} method.
+ * If {@code setSeed} is not called, the first call to
+ * {@code nextBytes} will force the SecureRandom object to seed itself.
+ * This self-seeding will not occur if {@code setSeed} was
* previously called.
*
* @param algorithm the name of the RNG algorithm.
@@ -395,7 +395,7 @@ public class SecureRandom extends java.util.Random {
* Returns the name of the algorithm implemented by this SecureRandom
* object.
*
- * @return the name of the algorithm or unknown
+ * @return the name of the algorithm or {@code unknown}
* if the algorithm name cannot be determined.
* @since 1.5
*/
@@ -418,12 +418,12 @@ public class SecureRandom extends java.util.Random {
/**
* Reseeds this random object, using the eight bytes contained
- * in the given long seed. The given seed supplements,
+ * in the given {@code long seed}. The given seed supplements,
* rather than replaces, the existing seed. Thus, repeated calls
* are guaranteed never to reduce randomness.
*
* java.util.Random.
+ * {@code java.util.Random}.
*
* @param seed the seed.
*
@@ -445,10 +445,10 @@ public class SecureRandom extends java.util.Random {
/**
* Generates a user-specified number of random bytes.
*
- * setSeed had not occurred previously,
+ * setSeed was previously called.
+ * {@code setSeed} was previously called.
*
* @param bytes the array to be filled in with random bytes.
*/
@@ -460,15 +460,15 @@ public class SecureRandom extends java.util.Random {
/**
* Generates an integer containing the user-specified number of
* pseudo-random bits (right justified, with leading zeros). This
- * method overrides a java.util.Random method, and serves
+ * method overrides a {@code java.util.Random} method, and serves
* to provide a source of random bits to all of the methods inherited
- * from that class (for example, nextInt,
- * nextLong, and nextFloat).
+ * from that class (for example, {@code nextInt},
+ * {@code nextLong}, and {@code nextFloat}).
*
* @param numBits number of pseudo-random bits to be generated, where
* {@code 0 <= numBits <= 32}.
*
- * @return an int containing the user-specified number
+ * @return an {@code int} containing the user-specified number
* of pseudo-random bits (right justified, with leading zeros).
*/
@Override
@@ -492,8 +492,8 @@ public class SecureRandom extends java.util.Random {
*
* getInstance methods to obtain a SecureRandom object, and
- * then call the generateSeed method to obtain seed bytes
+ * {@code getInstance} methods to obtain a SecureRandom object, and
+ * then call the {@code generateSeed} method to obtain seed bytes
* from that object.
*
* @param numBytes the number of seed bytes to generate.
diff --git a/src/share/classes/java/security/SecureRandomSpi.java b/src/share/classes/java/security/SecureRandomSpi.java
index 12652e98a65f7eee4c535174a072db884a25d782..ef6c243363087f9c4713a567a6f48fc3e9341f41 100644
--- a/src/share/classes/java/security/SecureRandomSpi.java
+++ b/src/share/classes/java/security/SecureRandomSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -27,7 +27,7 @@ package java.security;
/**
* This class defines the Service Provider Interface (SPI)
- * for the SecureRandom class.
+ * for the {@code SecureRandom} class.
* All the abstract methods in this class must be implemented by each
* service provider who wishes to supply the implementation
* of a cryptographically strong pseudo-random number generator.
@@ -53,10 +53,10 @@ public abstract class SecureRandomSpi implements java.io.Serializable {
/**
* Generates a user-specified number of random bytes.
*
- * engineSetSeed had not occurred previously,
+ * engineSetSeed was previously called.
+ * {@code engineSetSeed} was previously called.
*
* @param bytes the array to be filled in with random bytes.
*/
diff --git a/src/share/classes/java/security/Security.java b/src/share/classes/java/security/Security.java
index eccede10b203c251e9591cbdb935f1523f486bd4..c3dd716058d08ddd8573dfebf7fecd7b58edc4f7 100644
--- a/src/share/classes/java/security/Security.java
+++ b/src/share/classes/java/security/Security.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -298,7 +298,7 @@ public final class Security {
* property in the master file of the "SUN" Cryptographic Service
* Provider in order to determine how to parse algorithm-specific
* parameters. Use the new provider-based and algorithm-independent
- * AlgorithmParameters and KeyFactory engine
+ * {@code AlgorithmParameters} and {@code KeyFactory} engine
* classes (introduced in the J2SE version 1.2 platform) instead.
*/
@Deprecated
@@ -321,21 +321,21 @@ public final class Security {
*
* position, are shifted up
+ * with a position greater than {@code position}, are shifted up
* one position (towards the end of the list of installed providers).
*
* checkSecurityAccess
+ * {@code checkSecurityAccess}
* method is called with the string
- * "insertProvider."+provider.getName()
+ * {@code "insertProvider."+provider.getName()}
* to see if it's ok to add a new provider.
- * If the default implementation of checkSecurityAccess
+ * If the default implementation of {@code checkSecurityAccess}
* is used (i.e., that method is not overriden), then this will result in
- * a call to the security manager's checkPermission method
+ * a call to the security manager's {@code checkPermission} method
* with a
- * SecurityPermission("insertProvider."+provider.getName())
+ * {@code SecurityPermission("insertProvider."+provider.getName())}
* permission.
*
* @param provider the provider to be added.
@@ -349,8 +349,8 @@ public final class Security {
*
* @throws NullPointerException if provider is null
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies access to add a new provider
*
* @see #getProvider
@@ -374,15 +374,15 @@ public final class Security {
* Adds a provider to the next position available.
*
* checkSecurityAccess
+ * {@code checkSecurityAccess}
* method is called with the string
- * "insertProvider."+provider.getName()
+ * {@code "insertProvider."+provider.getName()}
* to see if it's ok to add a new provider.
- * If the default implementation of checkSecurityAccess
+ * If the default implementation of {@code checkSecurityAccess}
* is used (i.e., that method is not overriden), then this will result in
- * a call to the security manager's checkPermission method
+ * a call to the security manager's {@code checkPermission} method
* with a
- * SecurityPermission("insertProvider."+provider.getName())
+ * {@code SecurityPermission("insertProvider."+provider.getName())}
* permission.
*
* @param provider the provider to be added.
@@ -393,8 +393,8 @@ public final class Security {
*
* @throws NullPointerException if provider is null
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies access to add a new provider
*
* @see #getProvider
@@ -423,20 +423,20 @@ public final class Security {
* if name is null.
*
* checkSecurityAccess
- * method is called with the string "removeProvider."+name
+ * {@code checkSecurityAccess}
+ * method is called with the string {@code "removeProvider."+name}
* to see if it's ok to remove the provider.
- * If the default implementation of checkSecurityAccess
+ * If the default implementation of {@code checkSecurityAccess}
* is used (i.e., that method is not overriden), then this will result in
- * a call to the security manager's checkPermission method
- * with a SecurityPermission("removeProvider."+name)
+ * a call to the security manager's {@code checkPermission} method
+ * with a {@code SecurityPermission("removeProvider."+name)}
* permission.
*
* @param name the name of the provider to remove.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkSecurityAccess} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkSecurityAccess} method
* denies
* access to remove the provider
*
@@ -689,7 +689,7 @@ public final class Security {
* an instance of an implementation of the requested algorithm
* and type, and the second object in the array identifies the provider
* of that implementation.
- * The provider argument can be null, in which case all
+ * The {@code provider} argument can be null, in which case all
* configured providers will be searched in order of preference.
*/
static Object[] getImpl(String algorithm, String type, String provider)
@@ -720,7 +720,7 @@ public final class Security {
* an instance of an implementation of the requested algorithm
* and type, and the second object in the array identifies the provider
* of that implementation.
- * The provider argument cannot be null.
+ * The {@code provider} argument cannot be null.
*/
static Object[] getImpl(String algorithm, String type, Provider provider)
throws NoSuchAlgorithmException {
@@ -739,8 +739,8 @@ public final class Security {
* Gets a security property value.
*
* checkPermission method is called with a
- * java.security.SecurityPermission("getProperty."+key)
+ * {@code checkPermission} method is called with a
+ * {@code java.security.SecurityPermission("getProperty."+key)}
* permission to see if it's ok to retrieve the specified
* security property value..
*
@@ -749,8 +749,8 @@ public final class Security {
* @return the value of the security property corresponding to key.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkPermission} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkPermission} method
* denies
* access to retrieve the specified security property value
* @throws NullPointerException is key is null
@@ -774,8 +774,8 @@ public final class Security {
* Sets a security property value.
*
* checkPermission method is called with a
- * java.security.SecurityPermission("setProperty."+key)
+ * {@code checkPermission} method is called with a
+ * {@code java.security.SecurityPermission("setProperty."+key)}
* permission to see if it's ok to set the specified
* security property value.
*
@@ -784,8 +784,8 @@ public final class Security {
* @param datum the value of the property to be set.
*
* @throws SecurityException
- * if a security manager exists and its {@link
- * java.lang.SecurityManager#checkPermission} method
+ * if a security manager exists and its {@link
+ * java.lang.SecurityManager#checkPermission} method
* denies access to set the specified security property value
* @throws NullPointerException if key or datum is null
*
diff --git a/src/share/classes/java/security/SecurityPermission.java b/src/share/classes/java/security/SecurityPermission.java
index 69eaf7357338dd0440aba5cf15ce3b9eef0d3350..e0f0f92b40c49d7f7222ccdc4aafd4bf4cd2054a 100644
--- a/src/share/classes/java/security/SecurityPermission.java
+++ b/src/share/classes/java/security/SecurityPermission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -57,7 +57,7 @@ import java.util.StringTokenizer;
* createAccessControlContext
* Creation of an AccessControlContext
* This allows someone to instantiate an AccessControlContext
- * with a
@@ -67,7 +67,7 @@ import java.util.StringTokenizer;
* DomainCombiner. Extreme care must be taken when
+ * with a {@code DomainCombiner}. Extreme care must be taken when
* granting this permission. Malicious code could create a DomainCombiner
* that augments the set of permissions granted to code, and even grant the
* code {@link java.security.AllPermission}.getDomainCombiner
* Retrieval of an AccessControlContext's DomainCombiner
* This allows someone to retrieve an AccessControlContext's
- *
*
*
@@ -76,7 +76,7 @@ import java.util.StringTokenizer;
* DomainCombiner. Since DomainCombiners may contain
+ * {@code DomainCombiner}. Since DomainCombiners may contain
* sensitive information, this could potentially lead to a privacy leak.Retrieval of the system-wide security policy (specifically, of the
* currently-installed Policy object)
* This allows someone to query the policy via the
- * getPermissions call,
+ * {@code getPermissions} call,
* which discloses which permissions would be granted to a given CodeSource.
* While revealing the policy does not compromise the security of
* the system, it does provide malicious code with additional information
@@ -303,8 +303,8 @@ public final class SecurityPermission extends BasicPermission {
*
* @param name the name of the SecurityPermission
*
- * @throws NullPointerException if name is null.
- * @throws IllegalArgumentException if name is empty.
+ * @throws NullPointerException if {@code name} is {@code null}.
+ * @throws IllegalArgumentException if {@code name} is empty.
*/
public SecurityPermission(String name)
@@ -320,8 +320,8 @@ public final class SecurityPermission extends BasicPermission {
* @param name the name of the SecurityPermission
* @param actions should be null.
*
- * @throws NullPointerException if name is null.
- * @throws IllegalArgumentException if name is empty.
+ * @throws NullPointerException if {@code name} is {@code null}.
+ * @throws IllegalArgumentException if {@code name} is empty.
*/
public SecurityPermission(String name, String actions)
diff --git a/src/share/classes/java/security/Signature.java b/src/share/classes/java/security/Signature.java
index 2d014d21efe863362458616eeb060d669e127e37..a40290f8c99abd0339613ffa23609901a4718f59 100644
--- a/src/share/classes/java/security/Signature.java
+++ b/src/share/classes/java/security/Signature.java
@@ -53,10 +53,10 @@ import sun.security.jca.GetInstance.Instance;
*
* SignatureSpi for historical reasons.
+ * {@code SignatureSpi} for historical reasons.
* Application developers should only take notice of the methods defined in
- * this Signature class; all the methods in
+ * this {@code Signature} class; all the methods in
* the superclass are intended for cryptographic service providers who wish to
* supply their own implementations of digital signature algorithms.
*
* Signature algorithms:
+ * following standard {@code Signature} algorithms:
*
- *
* These algorithms are described in the
@@ -461,7 +461,7 @@ public abstract class Signature extends SignatureSpi {
* extension field implies that the public key in
* the certificate and its corresponding private key are not
* supposed to be used for digital signatures, an
- * InvalidKeyException is thrown.
+ * {@code InvalidKeyException} is thrown.
*
* @param certificate the certificate of the identity whose signature is
* going to be verified.
@@ -538,10 +538,10 @@ public abstract class Signature extends SignatureSpi {
*
* initSign(PrivateKey). That is, the object is
+ * call to {@code initSign(PrivateKey)}. That is, the object is
* reset and available to generate another signature from the same
- * signer, if desired, via new calls to update and
- * sign.
+ * signer, if desired, via new calls to {@code update} and
+ * {@code sign}.
*
* @return the signature bytes of the signing operation's result.
*
@@ -559,28 +559,28 @@ public abstract class Signature extends SignatureSpi {
/**
* Finishes the signature operation and stores the resulting signature
- * bytes in the provided buffer outbuf, starting at
- * offset.
+ * bytes in the provided buffer {@code outbuf}, starting at
+ * {@code offset}.
* The format of the signature depends on the underlying
* signature scheme.
*
* initSign methods) and
+ * was in after a call to one of the {@code initSign} methods) and
* can be reused to generate further signatures with the same private key.
*
* @param outbuf buffer for the signature result.
*
- * @param offset offset into outbuf where the signature is
+ * @param offset offset into {@code outbuf} where the signature is
* stored.
*
- * @param len number of bytes within outbuf allotted for the
+ * @param len number of bytes within {@code outbuf} allotted for the
* signature.
*
- * @return the number of bytes placed into outbuf.
+ * @return the number of bytes placed into {@code outbuf}.
*
* @exception SignatureException if this signature object is not
* initialized properly, if this signature algorithm is unable to
- * process the input data provided, or if len is less
+ * process the input data provided, or if {@code len} is less
* than the actual signature length.
*
* @since 1.2
@@ -606,9 +606,9 @@ public abstract class Signature extends SignatureSpi {
*
* initVerify(PublicKey). That is, the object is
+ * call to {@code initVerify(PublicKey)}. That is, the object is
* reset and available to verify another signature from the identity
- * whose public key was specified in the call to initVerify.
+ * whose public key was specified in the call to {@code initVerify}.
*
* @param signature the signature bytes to be verified.
*
@@ -633,9 +633,9 @@ public abstract class Signature extends SignatureSpi {
*
* initVerify(PublicKey). That is, the object is
+ * call to {@code initVerify(PublicKey)}. That is, the object is
* reset and available to verify another signature from the identity
- * whose public key was specified in the call to initVerify.
+ * whose public key was specified in the call to {@code initVerify}.
*
*
* @param signature the signature bytes to be verified.
@@ -648,11 +648,11 @@ public abstract class Signature extends SignatureSpi {
* initialized properly, the passed-in signature is improperly
* encoded or of the wrong type, if this signature algorithm is unable to
* process the input data provided, etc.
- * @exception IllegalArgumentException if the signature
- * byte array is null, or the offset or length
- * is less than 0, or the sum of the offset and
- * length is greater than the length of the
- * signature byte array.
+ * @exception IllegalArgumentException if the {@code signature}
+ * byte array is null, or the {@code offset} or {@code length}
+ * is less than 0, or the sum of the {@code offset} and
+ * {@code length} is greater than the length of the
+ * {@code signature} byte array.
* @since 1.4
*/
public final boolean verify(byte[] signature, int offset, int length)
@@ -722,8 +722,8 @@ public abstract class Signature extends SignatureSpi {
/**
* Updates the data to be signed or verified using the specified
- * ByteBuffer. Processes the data.remaining() bytes
- * starting at at data.position().
+ * ByteBuffer. Processes the {@code data.remaining()} bytes
+ * starting at at {@code data.position()}.
* Upon return, the buffer's position will be equal to its limit;
* its limit will not have changed.
*
@@ -790,7 +790,7 @@ public abstract class Signature extends SignatureSpi {
* @param param the string identifier of the parameter.
* @param value the parameter value.
*
- * @exception InvalidParameterException if param is an
+ * @exception InvalidParameterException if {@code param} is an
* invalid parameter for this signature algorithm engine,
* the parameter is already set
* and cannot be set again, a security exception occurs, and so on.
@@ -856,7 +856,7 @@ public abstract class Signature extends SignatureSpi {
* @return the object that represents the parameter value, or null if
* there is none.
*
- * @exception InvalidParameterException if param is an invalid
+ * @exception InvalidParameterException if {@code param} is an invalid
* parameter for this engine, or another exception occurs while
* trying to get this parameter.
*
@@ -876,7 +876,7 @@ public abstract class Signature extends SignatureSpi {
* @return a clone if the implementation is cloneable.
*
* @exception CloneNotSupportedException if this is called
- * on an implementation that does not support Cloneable.
+ * on an implementation that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
if (this instanceof Cloneable) {
@@ -940,7 +940,7 @@ public abstract class Signature extends SignatureSpi {
* @return a clone if the delegate is cloneable.
*
* @exception CloneNotSupportedException if this is called on a
- * delegate that does not support Cloneable.
+ * delegate that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
chooseFirstProvider();
diff --git a/src/share/classes/java/security/SignatureException.java b/src/share/classes/java/security/SignatureException.java
index c47de3124bcf90587337e2158d10e354e5d6810b..2e1fa592f609cf8875175add96f39deee7c1df25 100644
--- a/src/share/classes/java/security/SignatureException.java
+++ b/src/share/classes/java/security/SignatureException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -56,13 +56,13 @@ public class SignatureException extends GeneralSecurityException {
}
/**
- * Creates a SignatureException with the specified
+ * Creates a {@code SignatureException} with the specified
* detail message and cause.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
@@ -71,13 +71,13 @@ public class SignatureException extends GeneralSecurityException {
}
/**
- * Creates a SignatureException with the specified cause
- * and a detail message of (cause==null ? null : cause.toString())
+ * Creates a {@code SignatureException} with the specified cause
+ * and a detail message of {@code (cause==null ? null : cause.toString())}
* (which typically contains the class and detail message of
- * cause).
+ * {@code cause}).
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is permitted,
+ * {@link #getCause()} method). (A {@code null} value is permitted,
* and indicates that the cause is nonexistent or unknown.)
* @since 1.5
*/
diff --git a/src/share/classes/java/security/SignatureSpi.java b/src/share/classes/java/security/SignatureSpi.java
index cd5318e0e237b2157a514ed38d64e02d56162a49..d6d2bc39b5e7b9b5d415bbaa0080d10636d222bb 100644
--- a/src/share/classes/java/security/SignatureSpi.java
+++ b/src/share/classes/java/security/SignatureSpi.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -35,7 +35,7 @@ import sun.security.jca.JCAUtil;
/**
* This class defines the Service Provider Interface (SPI)
- * for the Signature class, which is used to provide the
+ * for the {@code Signature} class, which is used to provide the
* functionality of a digital signature algorithm. Digital signatures are used
* for authentication and integrity assurance of digital data.
*.
@@ -130,8 +130,8 @@ public abstract class SignatureSpi {
/**
* Updates the data to be signed or verified using the specified
- * ByteBuffer. Processes the data.remaining() bytes
- * starting at at data.position().
+ * ByteBuffer. Processes the {@code data.remaining()} bytes
+ * starting at at {@code data.position()}.
* Upon return, the buffer's position will be equal to its limit;
* its limit will not have changed.
*
@@ -183,14 +183,14 @@ public abstract class SignatureSpi {
/**
* Finishes this signature operation and stores the resulting signature
- * bytes in the provided buffer outbuf, starting at
- * offset.
+ * bytes in the provided buffer {@code outbuf}, starting at
+ * {@code offset}.
* The format of the signature depends on the underlying
* signature scheme.
*
* engineInitSign methods)
+ * {@code engineInitSign} methods)
* and can be reused to generate further signatures with the same private
* key.
*
@@ -200,10 +200,10 @@ public abstract class SignatureSpi {
*
* @param outbuf buffer for the signature result.
*
- * @param offset offset into outbuf where the signature is
+ * @param offset offset into {@code outbuf} where the signature is
* stored.
*
- * @param len number of bytes within outbuf allotted for the
+ * @param len number of bytes within {@code outbuf} allotted for the
* signature.
* Both this default implementation and the SUN provider do not
* return partial digests. If the value of this parameter is less
@@ -212,11 +212,11 @@ public abstract class SignatureSpi {
* This parameter is ignored if its value is greater than or equal to
* the actual signature length.
*
- * @return the number of bytes placed into outbuf
+ * @return the number of bytes placed into {@code outbuf}
*
* @exception SignatureException if the engine is not
* initialized properly, if this signature algorithm is unable to
- * process the input data provided, or if len is less
+ * process the input data provided, or if {@code len} is less
* than the actual signature length.
*
* @since 1.2
@@ -293,7 +293,7 @@ public abstract class SignatureSpi {
*
* @param value the parameter value.
*
- * @exception InvalidParameterException if param is an
+ * @exception InvalidParameterException if {@code param} is an
* invalid parameter for this signature algorithm engine,
* the parameter is already set
* and cannot be set again, a security exception occurs, and so on.
@@ -362,7 +362,7 @@ public abstract class SignatureSpi {
* @return the object that represents the parameter value, or null if
* there is none.
*
- * @exception InvalidParameterException if param is an
+ * @exception InvalidParameterException if {@code param} is an
* invalid parameter for this engine, or another exception occurs while
* trying to get this parameter.
*
@@ -378,7 +378,7 @@ public abstract class SignatureSpi {
* @return a clone if the implementation is cloneable.
*
* @exception CloneNotSupportedException if this is called
- * on an implementation that does not support Cloneable.
+ * on an implementation that does not support {@code Cloneable}.
*/
public Object clone() throws CloneNotSupportedException {
if (this instanceof Cloneable) {
diff --git a/src/share/classes/java/security/SignedObject.java b/src/share/classes/java/security/SignedObject.java
index 1f901fa1c7789e29b330ad501142c46ed17beaab..dba803d88e41f1c74d62a8cedd93c77b54ea2e2e 100644
--- a/src/share/classes/java/security/SignedObject.java
+++ b/src/share/classes/java/security/SignedObject.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -40,44 +40,44 @@ import java.io.*;
* the original object has no side effect on the copy.
*
* verify method.
+ * object passed to the constructor and the {@code verify} method.
* A typical usage for signing is the following:
*
- *
+ * }
*
*
+ *
{@code
* Signature signingEngine = Signature.getInstance(algorithm,
* provider);
* SignedObject so = new SignedObject(myobject, signingKey,
* signingEngine);
- * so):
+ * received SignedObject {@code so}):
*
- *
+ * }
*
*
+ *
{@code
* Signature verificationEngine =
* Signature.getInstance(algorithm, provider);
* if (so.verify(publickey, verificationEngine))
* try {
* Object myobj = so.getObject();
* } catch (java.lang.ClassNotFoundException e) {};
- * verify
+ * re-initialized inside the constructor and the {@code verify}
* method. Secondly, for verification to succeed, the specified
* public key must be the public key corresponding to the private key
* used to generate the SignedObject.
*
* verify method allow for
+ * constructor and {@code verify} method allow for
* customized signature engines, which can implement signature
* algorithms that are not installed formally as part of a crypto
* provider. However, it is crucial that the programmer writing the
- * verifier code be aware what Signature engine is being
- * used, as its own implementation of the verify method
+ * verifier code be aware what {@code Signature} engine is being
+ * used, as its own implementation of the {@code verify} method
* is invoked to verify a signature. In other words, a malicious
- * Signature may choose to always return true on
+ * {@code Signature} may choose to always return true on
* verification in an attempt to bypass a security check.
*
* verify method. If the provider is not
+ * {@code verify} method. If the provider is not
* specified, the default provider is used. Each installation can
* be configured to use a particular provider as default.
*
@@ -214,8 +214,8 @@ public final class SignedObject implements Serializable {
* @exception SignatureException if signature verification failed.
* @exception InvalidKeyException if the verification key is invalid.
*
- * @return true if the signature
- * is valid, false otherwise
+ * @return {@code true} if the signature
+ * is valid, {@code false} otherwise
*/
public boolean verify(PublicKey verificationKey,
Signature verificationEngine)
diff --git a/src/share/classes/java/security/Signer.java b/src/share/classes/java/security/Signer.java
index 9224780c6507fbed0bd2d53838235fdad6fe7707..077538da9798e75be70b4e808f92be6f92831b87 100644
--- a/src/share/classes/java/security/Signer.java
+++ b/src/share/classes/java/security/Signer.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -40,9 +40,9 @@ import java.io.*;
* @author Benjamin Renaud
*
* @deprecated This class is no longer used. Its functionality has been
- * replaced by java.security.KeyStore, the
- * java.security.cert package, and
- * java.security.Principal.
+ * replaced by {@code java.security.KeyStore}, the
+ * {@code java.security.cert} package, and
+ * {@code java.security.Principal}.
*/
@Deprecated
public abstract class Signer extends Identity {
@@ -92,15 +92,15 @@ public abstract class Signer extends Identity {
/**
* Returns this signer's private key.
*
- * checkSecurityAccess
- * method is called with "getSignerPrivateKey"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* returning the private key.
*
* @see SecurityManager#checkSecurityAccess
@@ -113,8 +113,8 @@ public abstract class Signer extends Identity {
/**
* Sets the key pair (public key and private key) for this signer.
*
- * checkSecurityAccess
- * method is called with "setSignerKeyPair"
+ * checkSecurityAccess method doesn't allow
+ * {@code checkSecurityAccess} method doesn't allow
* setting the key pair.
*
* @see SecurityManager#checkSecurityAccess
diff --git a/src/share/classes/java/security/UnresolvedPermission.java b/src/share/classes/java/security/UnresolvedPermission.java
index 5428d17d82d2d8864f6b21287acdf860b5b7d98a..e6a6b36ed2af126c1e43071397d5f2dd139b55a3 100644
--- a/src/share/classes/java/security/UnresolvedPermission.java
+++ b/src/share/classes/java/security/UnresolvedPermission.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -72,11 +72,11 @@ import java.security.cert.*;
* the class provides a zero, one, and/or two-argument constructor.
* The zero-argument constructor would be used to instantiate
* a permission without a name and without actions.
- * A one-arg constructor is assumed to take a String
+ * A one-arg constructor is assumed to take a {@code String}
* name as input, and a two-arg constructor is assumed to take a
- * String name and String actions
+ * {@code String} name and {@code String} actions
* as input. UnresolvedPermission may invoke a
- * constructor with a null name and/or actions.
+ * constructor with a {@code null} name and/or actions.
* If an appropriate permission constructor is not available,
* the UnresolvedPermission is ignored and the relevant permission
* will not be granted to executing code.
@@ -84,9 +84,9 @@ import java.security.cert.*;
* getName method for an
- * UnresolvedPermission returns the
- * type (class name) for the underlying permission
+ * null,
+ * has not been resolved, or {@code null},
* if there is no targe name
*
* @since 1.5
@@ -454,7 +454,7 @@ implements java.io.Serializable
* has not been resolved.
*
* @return the actions for the underlying permission that
- * has not been resolved, or null
+ * has not been resolved, or {@code null}
* if there are no actions
*
* @since 1.5
@@ -503,16 +503,16 @@ implements java.io.Serializable
/**
* Writes this object out to a stream (i.e., serializes it).
*
- * @serialData An initial String denoting the
- * type is followed by a String denoting the
- * name is followed by a String denoting the
- * actions is followed by an int indicating the
+ * @serialData An initial {@code String} denoting the
+ * {@code type} is followed by a {@code String} denoting the
+ * {@code name} is followed by a {@code String} denoting the
+ * {@code actions} is followed by an {@code int} indicating the
* number of certificates to follow
* (a value of "zero" denotes that there are no certificates associated
* with this object).
- * Each certificate is written out starting with a String
+ * Each certificate is written out starting with a {@code String}
* denoting the certificate type, followed by an
- * int specifying the length of the certificate encoding,
+ * {@code int} specifying the length of the certificate encoding,
* followed by the certificate encoding itself which is written out as an
* array of bytes.
*/
diff --git a/src/share/classes/java/security/acl/Acl.java b/src/share/classes/java/security/acl/Acl.java
index e90f740b1f0b943eac6c929652730d11db34fc80..e7b6a21b28c720b623406f48c8a772e559a58f5b 100644
--- a/src/share/classes/java/security/acl/Acl.java
+++ b/src/share/classes/java/security/acl/Acl.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -66,19 +66,19 @@ import java.security.Principal;
*
*
*
- * The java.security.acl package provides the
+ * The {@code java.security.acl } package provides the
* interfaces to the ACL and related data structures (ACL entries,
- * groups, permissions, etc.), and the sun.security.acl
+ * groups, permissions, etc.), and the {@code sun.security.acl }
* classes provide a default implementation of the interfaces. For
- * example, java.security.acl.Acl provides the
- * interface to an ACL and the sun.security.acl.AclImpl
+ * example, {@code java.security.acl.Acl } provides the
+ * interface to an ACL and the {@code sun.security.acl.AclImpl }
* class provides the default implementation of the interface. java.security.acl.Acl interface extends the
- * java.security.acl.Owner interface. The Owner
+ * The {@code java.security.acl.Acl } interface extends the
+ * {@code java.security.acl.Owner } interface. The Owner
* interface is used to maintain a list of owners for each ACL. Only
* owners are allowed to modify an ACL. For example, only an owner can
- * call the ACL's addEntry method to add a new ACL entry
+ * call the ACL's {@code addEntry} method to add a new ACL entry
* to the ACL.
*
* @see java.security.acl.AclEntry
@@ -217,7 +217,7 @@ public interface Acl extends Owner {
* More specifically, this method checks whether the passed permission
* is a member of the allowed permission set of the specified principal.
* The allowed permission set is determined by the same algorithm as is
- * used by the getPermissions method.
+ * used by the {@code getPermissions} method.
*
* @param principal the principal, assumed to be a valid authenticated
* Principal.
diff --git a/src/share/classes/java/security/acl/AclEntry.java b/src/share/classes/java/security/acl/AclEntry.java
index f8dd3a752e006a1982aa0233d156db3f19554e1f..cd9675f34a15054dd39fd99ae7d5da0018cd2d04 100644
--- a/src/share/classes/java/security/acl/AclEntry.java
+++ b/src/share/classes/java/security/acl/AclEntry.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -84,7 +84,7 @@ public interface AclEntry extends Cloneable {
* specified in the entry.
*
* Note: ACL entries are by default positive. An entry becomes a
- * negative entry only if this setNegativePermissions
+ * negative entry only if this {@code setNegativePermissions}
* method is called on it.
*/
public void setNegativePermissions();
diff --git a/src/share/classes/java/security/acl/Group.java b/src/share/classes/java/security/acl/Group.java
index be3578b3c334fcb96496c0ed2f22f29f35193cf7..ebd9c445282e5dca5b3c7d51ab9b1f275ae0b804 100644
--- a/src/share/classes/java/security/acl/Group.java
+++ b/src/share/classes/java/security/acl/Group.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 2004, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -35,7 +35,7 @@ import java.security.Principal;
* Note that Group extends Principal. Thus, either a Principal or a Group can
* be passed as an argument to methods containing a Principal parameter. For
* example, you can add either a Principal or a Group to a Group object by
- * calling the object's addMember method, passing it the
+ * calling the object's {@code addMember} method, passing it the
* Principal or Group.
*
* @author Satish Dharmaraj
diff --git a/src/share/classes/java/security/acl/Owner.java b/src/share/classes/java/security/acl/Owner.java
index 313889528d6cc18adab1721467b0c0a2018bde70..2f649d40b33ac5f9e295c5072adfb7102feb9950 100644
--- a/src/share/classes/java/security/acl/Owner.java
+++ b/src/share/classes/java/security/acl/Owner.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 1997, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -30,7 +30,7 @@ import java.security.Principal;
/**
* Interface for managing owners of Access Control Lists (ACLs) or ACL
* configurations. (Note that the Acl interface in the
- * java.security.acl package extends this Owner
+ * {@code java.security.acl} package extends this Owner
* interface.) The initial owner Principal should be specified as an
* argument to the constructor of the class implementing this interface.
*
diff --git a/src/share/classes/java/security/acl/package-info.java b/src/share/classes/java/security/acl/package-info.java
new file mode 100644
index 0000000000000000000000000000000000000000..356c102e32327027dab18afb49187ecf662b0a32
--- /dev/null
+++ b/src/share/classes/java/security/acl/package-info.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * The classes and interfaces in this package have been
+ * superseded by classes in the java.security package.
+ * See that package and, for example, java.security.Permission for details.
+ *
+ * @since JDK1.1
+ */
+package java.security.acl;
diff --git a/src/share/classes/java/security/acl/package.html b/src/share/classes/java/security/acl/package.html
deleted file mode 100644
index 497dfe8323e5a637240fd021713f4f9f23595372..0000000000000000000000000000000000000000
--- a/src/share/classes/java/security/acl/package.html
+++ /dev/null
@@ -1,54 +0,0 @@
-Package Specification
+ *
+ *
+ *
+ *
+ * Related Documentation
+ *
+ * For information about X.509 certificates and CRLs, please see:
+ *
+ *
+ *
+ * @since 1.2
+ */
+package java.security.cert;
diff --git a/src/share/classes/java/security/cert/package.html b/src/share/classes/java/security/cert/package.html
deleted file mode 100644
index 239f7ffe1dc82474f3bf382369c99de7d859319d..0000000000000000000000000000000000000000
--- a/src/share/classes/java/security/cert/package.html
+++ /dev/null
@@ -1,67 +0,0 @@
-
-
-
-
-
-
-Provides classes and interfaces for parsing and managing
-certificates, certificate revocation lists (CRLs), and
-certification paths. It contains support for X.509 v3
-certificates and X.509 v2 CRLs.
-
-Package Specification
-
-
-
-
-Related Documentation
-
-For information about X.509 certificates and CRLs, please see:
-
-
-
-@since 1.2
-
-
diff --git a/src/share/classes/java/security/interfaces/DSAKeyPairGenerator.java b/src/share/classes/java/security/interfaces/DSAKeyPairGenerator.java
index 96a091ef84a8d46e7a6ae06d47bf3cafe1cff399..390835725b90ece49c1c5c3346e16fd9a068218f 100644
--- a/src/share/classes/java/security/interfaces/DSAKeyPairGenerator.java
+++ b/src/share/classes/java/security/interfaces/DSAKeyPairGenerator.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -30,8 +30,8 @@ import java.security.*;
/**
* An interface to an object capable of generating DSA key pairs.
*
- * initialize methods may each be called any number
- * of times. If no initialize method is called on a
+ *
*
*
*
* getInstance method with "DSA"
+ * KeyPairGenerator {@code getInstance} method with "DSA"
* as its argument.initialize methods from this DSAKeyPairGenerator interface.generateKeyPair
+ * initialize method in this interface.
- * Algorithm-independent initialization using the initialize method
+ * necessary to call an {@code initialize} method in this interface.
+ * Algorithm-independent initialization using the {@code initialize} method
* in the KeyPairGenerator
* interface is all that is needed when you accept defaults for algorithm-specific
* parameters.
@@ -80,7 +80,7 @@ public interface DSAKeyPairGenerator {
* @param random the random bit source to use to generate key bits;
* can be null.
*
- * @exception InvalidParameterException if the params
+ * @exception InvalidParameterException if the {@code params}
* value is invalid, null, or unsupported.
*/
public void initialize(DSAParams params, SecureRandom random)
@@ -92,7 +92,7 @@ public interface DSAKeyPairGenerator {
* If a SecureRandom bit source is needed but not supplied, i.e.
* null, a default SecureRandom instance will be used.
*
- * genParams is true, this method generates new
+ * modlen is
- * invalid, or unsupported, or if genParams is false and there
+ * @exception InvalidParameterException if {@code modlen} is
+ * invalid, or unsupported, or if {@code genParams} is false and there
* are no precomputed parameters for the requested modulus length.
*/
public void initialize(int modlen, boolean genParams, SecureRandom random)
diff --git a/src/share/classes/java/security/interfaces/DSAParams.java b/src/share/classes/java/security/interfaces/DSAParams.java
index f20b8ec386b2e0d26b71986b24ed2023a8ddb24e..8c46ed57e276321fc10827cf056b052f1fb0bf71 100644
--- a/src/share/classes/java/security/interfaces/DSAParams.java
+++ b/src/share/classes/java/security/interfaces/DSAParams.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 1998, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -42,23 +42,23 @@ import java.math.BigInteger;
public interface DSAParams {
/**
- * Returns the prime, p.
+ * Returns the prime, {@code p}.
*
- * @return the prime, p.
+ * @return the prime, {@code p}.
*/
public BigInteger getP();
/**
- * Returns the subprime, q.
+ * Returns the subprime, {@code q}.
*
- * @return the subprime, q.
+ * @return the subprime, {@code q}.
*/
public BigInteger getQ();
/**
- * Returns the base, g.
+ * Returns the base, {@code g}.
*
- * @return the base, g.
+ * @return the base, {@code g}.
*/
public BigInteger getG();
}
diff --git a/src/share/classes/java/security/interfaces/DSAPrivateKey.java b/src/share/classes/java/security/interfaces/DSAPrivateKey.java
index a0d189372e6ec91d4c04f6e7e1cd45239464eed4..81ab3586f699131fbf8ba90aac04dabe568099f4 100644
--- a/src/share/classes/java/security/interfaces/DSAPrivateKey.java
+++ b/src/share/classes/java/security/interfaces/DSAPrivateKey.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -50,9 +50,9 @@ public interface DSAPrivateKey extends DSAKey, java.security.PrivateKey {
static final long serialVersionUID = 7776497482533790279L;
/**
- * Returns the value of the private key, x.
+ * Returns the value of the private key, {@code x}.
*
- * @return the value of the private key, x.
+ * @return the value of the private key, {@code x}.
*/
public BigInteger getX();
}
diff --git a/src/share/classes/java/security/interfaces/DSAPublicKey.java b/src/share/classes/java/security/interfaces/DSAPublicKey.java
index b27373880e683e30fb1e9cbe0cace4fade7721d5..e56b795ae70a87f90700e5279d638a3bd1c9d7df 100644
--- a/src/share/classes/java/security/interfaces/DSAPublicKey.java
+++ b/src/share/classes/java/security/interfaces/DSAPublicKey.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -50,9 +50,9 @@ public interface DSAPublicKey extends DSAKey, java.security.PublicKey {
static final long serialVersionUID = 1234526332779022332L;
/**
- * Returns the value of the public key, y.
+ * Returns the value of the public key, {@code y}.
*
- * @return the value of the public key, y.
+ * @return the value of the public key, {@code y}.
*/
public BigInteger getY();
}
diff --git a/src/share/classes/java/security/interfaces/package-info.java b/src/share/classes/java/security/interfaces/package-info.java
new file mode 100644
index 0000000000000000000000000000000000000000..54c9397e6914efe2caa711190762d67e5cc9a2d9
--- /dev/null
+++ b/src/share/classes/java/security/interfaces/package-info.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * Provides interfaces for generating RSA (Rivest, Shamir and
+ * Adleman AsymmetricCipher algorithm)
+ * keys as defined in the RSA Laboratory Technical Note
+ * PKCS#1, and DSA (Digital Signature
+ * Algorithm) keys as defined in NIST's FIPS-186.
+ * Package Specification
+ *
+ *
+ *
+ *
+ * Related Documentation
+ *
+ * For further documentation, please see:
+ *
+ *
+ * @since JDK1.1
+ */
+package java.security.interfaces;
diff --git a/src/share/classes/java/security/interfaces/package.html b/src/share/classes/java/security/interfaces/package.html
deleted file mode 100644
index 70820dd70a57adaf4633d48521073a45867a38cc..0000000000000000000000000000000000000000
--- a/src/share/classes/java/security/interfaces/package.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-
-
-Provides interfaces for generating RSA (Rivest, Shamir and
-Adleman AsymmetricCipher algorithm)
-keys as defined in the RSA Laboratory Technical Note
-PKCS#1, and DSA (Digital Signature
-Algorithm) keys as defined in NIST's FIPS-186.
-Key classes for hardware devices, please refer
-to these cryptographic provider developer guides:
-Package Specification
-
-
-
-
-Related Documentation
-
-For further documentation, please see:
-
-
-@since JDK1.1
-
-
diff --git a/src/share/classes/java/security/package-info.java b/src/share/classes/java/security/package-info.java
new file mode 100644
index 0000000000000000000000000000000000000000..599e95259badf4e4294a4917e9943d00c64f5d73
--- /dev/null
+++ b/src/share/classes/java/security/package-info.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * Provides the classes and interfaces for the security framework.
+ * This includes classes that implement an easily configurable,
+ * fine-grained access control security architecture.
+ * This package also supports
+ * the generation and storage of cryptographic public key pairs,
+ * as well as a number of exportable cryptographic operations
+ * including those for message digest and signature generation. Finally,
+ * this package provides classes that support signed/guarded objects
+ * and secure random number generation.
+ *
+ * Many of the classes provided in this package (the cryptographic
+ * and secure random number generator classes in particular) are
+ * provider-based. The class itself defines a programming interface
+ * to which applications may write. The implementations themselves may
+ * then be written by independent third-party vendors and plugged
+ * in seamlessly as needed. Therefore application developers may
+ * take advantage of any number of provider-based implementations
+ * without having to add or rewrite code.
+ *
+ * Package Specification
+ *
+ *
+ *
+ *
+ * Related Documentation
+ *
+ * For further documentation, please see:
+ *
+ *
+ *
+ * @since 1.1
+ */
+package java.security;
diff --git a/src/share/classes/java/security/package.html b/src/share/classes/java/security/package.html
deleted file mode 100644
index 65eb70c71af7b5e58c69dfed2eef3986420e3094..0000000000000000000000000000000000000000
--- a/src/share/classes/java/security/package.html
+++ /dev/null
@@ -1,117 +0,0 @@
-
-
-
-
-
-
-
-
-Provides the classes and interfaces for the security framework.
-This includes classes that implement an easily configurable,
-fine-grained access control security architecture.
-This package also supports
-the generation and storage of cryptographic public key pairs,
-as well as a number of exportable cryptographic operations
-including those for message digest and signature generation. Finally,
-this package provides classes that support signed/guarded objects
-and secure random number generation.
-
-Many of the classes provided in this package (the cryptographic
-and secure random number generator classes in particular) are
-provider-based. The class itself defines a programming interface
-to which applications may write. The implementations themselves may
-then be written by independent third-party vendors and plugged
-in seamlessly as needed. Therefore application developers may
-take advantage of any number of provider-based implementations
-without having to add or rewrite code.
-
-Package Specification
-
-
-
-
-Related Documentation
-
-For further documentation, please see:
-
-
-
-@since 1.1
-
-
diff --git a/src/share/classes/java/security/spec/package-info.java b/src/share/classes/java/security/spec/package-info.java
new file mode 100644
index 0000000000000000000000000000000000000000..cb393088e5b5727eb4dcfa7244b3cc9c5506d6f7
--- /dev/null
+++ b/src/share/classes/java/security/spec/package-info.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * Provides classes and interfaces for key specifications and algorithm
+ * parameter specifications.
+ *
+ * Package Specification
+ *
+ *
+ *
+ *
+ * Related Documentation
+ *
+ * For documentation that includes information about algorithm parameter
+ * and key specifications, please see:
+ *
+ *
+ *
+ * @since 1.2
+ */
+package java.security.spec;
diff --git a/src/share/classes/java/security/spec/package.html b/src/share/classes/java/security/spec/package.html
deleted file mode 100644
index 54558ae198aadc817bc565bcf277f02def1842c6..0000000000000000000000000000000000000000
--- a/src/share/classes/java/security/spec/package.html
+++ /dev/null
@@ -1,78 +0,0 @@
-
-
-
-
-
-
-
-
-Provides classes and interfaces for key specifications and algorithm
-parameter specifications.
-
-Package Specification
-
-
-
-
-Related Documentation
-
-For documentation that includes information about algorithm parameter
-and key specifications, please see:
-
-
-@since 1.2
-
-