attributes;
/**
- * Constructs a TrustedCertificateEntry
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 @@
}
/**
- * 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 @@
/**
* 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 @@
/**
* 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 @@
* Returns the certificate associated with the given alias.
*
* If the given alias name identifies an entry
- * created by a call to 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.
*
*
If the given alias name identifies an entry
- * created by a call to 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 @@
* Assigns the given key to the given alias, protecting it with the given
* password.
*
- *
If the given key is of type java.security.PrivateKey
,
+ *
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 @@
* @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
- * 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 @@
* alias.
*
*
If the protected key is of type
- * 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.
*
*
If the given alias already exists, the keystore information
* associated with it is overridden by the given key (and possibly
@@ -1292,7 +1292,7 @@
* @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 the keystore has not been initialized
* (loaded), or if this operation fails for some other reason.
@@ -1311,9 +1311,9 @@
* Assigns the given trusted certificate to the given alias.
*
*
If the given alias identifies an existing entry
- * created by a call to 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 @@
/**
* 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 @@
/**
* 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 @@
*
*
This method attempts to match the given certificate with each
* keystore entry. If the entry being considered was
- * created by a call to 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.
*
*
If the entry being considered was
- * created by a call to 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 @@
}
/**
- * 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 @@
* then integrity checking is not performed.
*
*
In order to create an empty keystore, or if the keystore cannot
- * be initialized from a stream, pass null
- * as the stream
argument.
+ * be initialized from a stream, pass {@code null}
+ * as the {@code stream} argument.
*
*
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 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 @@
}
/**
- * Loads this keystore using the given LoadStoreParameter
.
+ * Loads this keystore using the given {@code LoadStoreParameter}.
*
*
Note that if this KeyStore has already been loaded, it is
* reinitialized and loaded again from the given parameter.
*
- * @param param the 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 @@
}
/**
- * 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 @@
}
/**
- * 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}.
*
*
If an entry already exists for the specified alias,
* it is overridden.
*
- * @param alias save the 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 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 @@
}
/**
- * 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 @@
/**
* 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 @@
/**
* 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}.
*
*
This is useful if an existing KeyStore object needs to be
* used with Builder-based APIs.
@@ -1832,15 +1832,15 @@
* Returns a new Builder object.
*
*
The first call to the {@link #getKeyStore} method on the returned
- * builder will create a KeyStore of type 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.
*
*
Subsequent calls to {@link #getKeyStore} return the same object
@@ -1848,13 +1848,13 @@
* KeyStoreException, subsequent calls also throw a
* KeyStoreException.
*
- *
The KeyStore is instantiated from provider
if
+ *
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
- * load
method.
+ * {@code load} method.
*
*
Note that the {@link #getKeyStore} method is executed
* within the {@link AccessControlContext} of the code invoking this
@@ -2013,17 +2013,17 @@
* Returns a new Builder object.
*
*
Each call to the {@link #getKeyStore} method on the returned
- * builder will return a new KeyStore object of type 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}.
*
- *
The KeyStore is instantiated from provider
if
+ *
The KeyStore is instantiated from {@code provider} if
* non-null. Otherwise, all installed providers are searched.
*
*
Calls to {@link #getProtectionParameter getProtectionParameter()}
- * will return protection
.
+ * will return {@code protection}.
*
*
Note that the {@link #getKeyStore} method is executed
* within the {@link AccessControlContext} of the code invoking this