mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-27 06:45:07 +02:00
8284851: Update javax.crypto files to use proper javadoc for mentioned classes
Reviewed-by: weijun, valeriep
This commit is contained in:
Mark Powers
Valerie Peng
parent
8cdead0c94
commit
f804f2ce8e
92 changed files with 2142 additions and 2010 deletions
|
|
@ -34,7 +34,7 @@ import sun.security.util.DerInputStream;
|
|||
import sun.security.util.DerOutputStream;
|
||||
|
||||
/**
|
||||
* This class implements the <code>EncryptedPrivateKeyInfo</code> type
|
||||
* This class implements the {@code EncryptedPrivateKeyInfo} type
|
||||
* as defined in PKCS #8.
|
||||
* <p>Its ASN.1 definition is as follows:
|
||||
*
|
||||
|
|
@ -70,11 +70,12 @@ public class EncryptedPrivateKeyInfo {
|
|||
private byte[] encoded;
|
||||
|
||||
/**
|
||||
* Constructs (i.e., parses) an <code>EncryptedPrivateKeyInfo</code> from
|
||||
* Constructs (i.e., parses) an {@code EncryptedPrivateKeyInfo} from
|
||||
* its ASN.1 encoding.
|
||||
* @param encoded the ASN.1 encoding of this object. The contents of
|
||||
* the array are copied to protect against subsequent modification.
|
||||
* @exception NullPointerException if the <code>encoded</code> is null.
|
||||
* @exception NullPointerException if the {@code encoded} is
|
||||
* {@code null}.
|
||||
* @exception IOException if error occurs when parsing the ASN.1 encoding.
|
||||
*/
|
||||
public EncryptedPrivateKeyInfo(byte[] encoded) throws IOException {
|
||||
|
|
@ -110,12 +111,12 @@ public class EncryptedPrivateKeyInfo {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructs an <code>EncryptedPrivateKeyInfo</code> from the
|
||||
* Constructs an {@code EncryptedPrivateKeyInfo} from the
|
||||
* encryption algorithm name and the encrypted data.
|
||||
*
|
||||
* <p>Note: This constructor will use null as the value of the
|
||||
* <p>Note: This constructor will use {@code null} as the value of the
|
||||
* algorithm parameters. If the encryption algorithm has
|
||||
* parameters whose value is not null, a different constructor,
|
||||
* parameters whose value is not {@code null}, a different constructor,
|
||||
* e.g. EncryptedPrivateKeyInfo(AlgorithmParameters, byte[]),
|
||||
* should be used.
|
||||
*
|
||||
|
|
@ -124,11 +125,11 @@ public class EncryptedPrivateKeyInfo {
|
|||
* Java Security Standard Algorithm Names</a> document
|
||||
* for information about standard Cipher algorithm names.
|
||||
* @param encryptedData encrypted data. The contents of
|
||||
* <code>encryptedData</code> are copied to protect against subsequent
|
||||
* {@code encryptedData} are copied to protect against subsequent
|
||||
* modification when constructing this object.
|
||||
* @exception NullPointerException if <code>algName</code> or
|
||||
* <code>encryptedData</code> is null.
|
||||
* @exception IllegalArgumentException if <code>encryptedData</code>
|
||||
* @exception NullPointerException if {@code algName} or
|
||||
* {@code encryptedData} is {@code null}.
|
||||
* @exception IllegalArgumentException if {@code encryptedData}
|
||||
* is empty, i.e. 0-length.
|
||||
* @exception NoSuchAlgorithmException if the specified algName is
|
||||
* not supported.
|
||||
|
|
@ -156,23 +157,23 @@ public class EncryptedPrivateKeyInfo {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructs an <code>EncryptedPrivateKeyInfo</code> from the
|
||||
* Constructs an {@code EncryptedPrivateKeyInfo} from the
|
||||
* encryption algorithm parameters and the encrypted data.
|
||||
*
|
||||
* @param algParams the algorithm parameters for the encryption
|
||||
* algorithm. <code>algParams.getEncoded()</code> should return
|
||||
* the ASN.1 encoded bytes of the <code>parameters</code> field
|
||||
* of the <code>AlgorithmIdentifier</code> component of the
|
||||
* <code>EncryptedPrivateKeyInfo</code> type.
|
||||
* algorithm. {@code algParams.getEncoded()} should return
|
||||
* the ASN.1 encoded bytes of the {@code parameters} field
|
||||
* of the {@code AlgorithmIdentifier} component of the
|
||||
* {@code EncryptedPrivateKeyInfo} type.
|
||||
* @param encryptedData encrypted data. The contents of
|
||||
* <code>encryptedData</code> are copied to protect against
|
||||
* {@code encryptedData} are copied to protect against
|
||||
* subsequent modification when constructing this object.
|
||||
* @exception NullPointerException if <code>algParams</code> or
|
||||
* <code>encryptedData</code> is null.
|
||||
* @exception IllegalArgumentException if <code>encryptedData</code>
|
||||
* @exception NullPointerException if {@code algParams} or
|
||||
* {@code encryptedData} is {@code null}.
|
||||
* @exception IllegalArgumentException if {@code encryptedData}
|
||||
* is empty, i.e. 0-length.
|
||||
* @exception NoSuchAlgorithmException if the specified algName of
|
||||
* the specified <code>algParams</code> parameter is not supported.
|
||||
* the specified {@code algParams} parameter is not supported.
|
||||
*/
|
||||
public EncryptedPrivateKeyInfo(AlgorithmParameters algParams,
|
||||
byte[] encryptedData) throws NoSuchAlgorithmException {
|
||||
|
|
@ -232,16 +233,16 @@ public class EncryptedPrivateKeyInfo {
|
|||
* Extract the enclosed PKCS8EncodedKeySpec object from the
|
||||
* encrypted data and return it.
|
||||
* <br>Note: In order to successfully retrieve the enclosed
|
||||
* PKCS8EncodedKeySpec object, <code>cipher</code> needs
|
||||
* PKCS8EncodedKeySpec object, {@code cipher} needs
|
||||
* to be initialized to either Cipher.DECRYPT_MODE or
|
||||
* Cipher.UNWRAP_MODE, with the same key and parameters used
|
||||
* for generating the encrypted data.
|
||||
*
|
||||
* @param cipher the initialized cipher object which will be
|
||||
* @param cipher the initialized {@code Cipher} object which will be
|
||||
* used for decrypting the encrypted data.
|
||||
* @return the PKCS8EncodedKeySpec object.
|
||||
* @exception NullPointerException if <code>cipher</code>
|
||||
* is null.
|
||||
* @exception NullPointerException if {@code cipher}
|
||||
* is {@code null}.
|
||||
* @exception InvalidKeySpecException if the given cipher is
|
||||
* inappropriate for the encrypted data or the encrypted
|
||||
* data is corrupted and cannot be decrypted.
|
||||
|
|
@ -291,11 +292,11 @@ public class EncryptedPrivateKeyInfo {
|
|||
* encrypted data and return it.
|
||||
* @param decryptKey key used for decrypting the encrypted data.
|
||||
* @return the PKCS8EncodedKeySpec object.
|
||||
* @exception NullPointerException if <code>decryptKey</code>
|
||||
* is null.
|
||||
* @exception NullPointerException if {@code decryptKey}
|
||||
* is {@code null}.
|
||||
* @exception NoSuchAlgorithmException if cannot find appropriate
|
||||
* cipher to decrypt the encrypted data.
|
||||
* @exception InvalidKeyException if <code>decryptKey</code>
|
||||
* @exception InvalidKeyException if {@code decryptKey}
|
||||
* cannot be used to decrypt the encrypted data or the decryption
|
||||
* result is not a valid PKCS8KeySpec.
|
||||
*
|
||||
|
|
@ -313,16 +314,16 @@ public class EncryptedPrivateKeyInfo {
|
|||
* Extract the enclosed PKCS8EncodedKeySpec object from the
|
||||
* encrypted data and return it.
|
||||
* @param decryptKey key used for decrypting the encrypted data.
|
||||
* @param providerName the name of provider whose Cipher
|
||||
* @param providerName the name of provider whose cipher
|
||||
* implementation will be used.
|
||||
* @return the PKCS8EncodedKeySpec object.
|
||||
* @exception NullPointerException if <code>decryptKey</code>
|
||||
* or <code>providerName</code> is null.
|
||||
* @exception NullPointerException if {@code decryptKey}
|
||||
* or {@code providerName} is {@code null}.
|
||||
* @exception NoSuchProviderException if no provider
|
||||
* <code>providerName</code> is registered.
|
||||
* {@code providerName} is registered.
|
||||
* @exception NoSuchAlgorithmException if cannot find appropriate
|
||||
* cipher to decrypt the encrypted data.
|
||||
* @exception InvalidKeyException if <code>decryptKey</code>
|
||||
* @exception InvalidKeyException if {@code decryptKey}
|
||||
* cannot be used to decrypt the encrypted data or the decryption
|
||||
* result is not a valid PKCS8KeySpec.
|
||||
*
|
||||
|
|
@ -349,14 +350,14 @@ public class EncryptedPrivateKeyInfo {
|
|||
* Extract the enclosed PKCS8EncodedKeySpec object from the
|
||||
* encrypted data and return it.
|
||||
* @param decryptKey key used for decrypting the encrypted data.
|
||||
* @param provider the name of provider whose Cipher implementation
|
||||
* @param provider the name of provider whose cipher implementation
|
||||
* will be used.
|
||||
* @return the PKCS8EncodedKeySpec object.
|
||||
* @exception NullPointerException if <code>decryptKey</code>
|
||||
* or <code>provider</code> is null.
|
||||
* @exception NullPointerException if {@code decryptKey}
|
||||
* or {@code provider} is {@code null}.
|
||||
* @exception NoSuchAlgorithmException if cannot find appropriate
|
||||
* cipher to decrypt the encrypted data in <code>provider</code>.
|
||||
* @exception InvalidKeyException if <code>decryptKey</code>
|
||||
* cipher to decrypt the encrypted data in {@code provider}.
|
||||
* @exception InvalidKeyException if {@code decryptKey}
|
||||
* cannot be used to decrypt the encrypted data or the decryption
|
||||
* result is not a valid PKCS8KeySpec.
|
||||
*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue