KeyStore.ProtectionParameter
, Destroyable
KeyStore
public static class KeyStore.PasswordProtection extends Object implements KeyStore.ProtectionParameter, Destroyable
ProtectionParameter
.Constructor | Description |
---|---|
PasswordProtection |
Creates a password parameter. |
PasswordProtection |
Creates a password parameter and specifies the protection algorithm and associated parameters to use when encrypting a keystore entry. |
Modifier and Type | Method | Description |
---|---|---|
void |
destroy() |
Clears the password. |
char[] |
getPassword() |
Gets the password. |
String |
getProtectionAlgorithm() |
Gets the name of the protection algorithm. |
AlgorithmParameterSpec |
getProtectionParameters() |
Gets the parameters supplied for the protection algorithm. |
boolean |
isDestroyed() |
Determines if password has been cleared. |
public PasswordProtection(char[] password)
The specified password
is cloned before it is stored in the new PasswordProtection
object.
password
- the password, which may be null
public PasswordProtection(char[] password, String protectionAlgorithm, AlgorithmParameterSpec protectionParameters)
The specified password
is cloned before it is stored in the new PasswordProtection
object.
password
- the password, which may be null
protectionAlgorithm
- the encryption algorithm name, for example, PBEWithHmacSHA256AndAES_256
. See the Cipher section in the Java Security Standard Algorithm Names Specification for information about standard encryption algorithm names.protectionParameters
- the encryption algorithm parameter specification, which may be null
NullPointerException
- if protectionAlgorithm
is null
public String getProtectionAlgorithm()
null
if none was setpublic AlgorithmParameterSpec getProtectionParameters()
null
, if none was setpublic char[] getPassword()
Note that this method returns a reference to the password. If a clone of the array is created it is the caller's responsibility to zero out the password information after it is no longer needed.
null
IllegalStateException
- if the password has been cleared (destroyed)public void destroy() throws DestroyFailedException
destroy
in interface Destroyable
DestroyFailedException
- if this method was unable to clear the passwordpublic boolean isDestroyed()
isDestroyed
in interface Destroyable
true
if the password has been cleared, false
otherwise
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/KeyStore.PasswordProtection.html