java.lang.Object
java.security.KeyStore.PasswordProtection
- All Implemented Interfaces:
- KeyStore.ProtectionParameter,- Destroyable
- Enclosing class:
- KeyStore
public static class KeyStore.PasswordProtection
extends Object
implements KeyStore.ProtectionParameter, Destroyable
A password-based implementation of 
ProtectionParameter.- Since:
- 1.5
- 
Constructor SummaryConstructorsConstructorDescriptionPasswordProtection(char[] password) Creates a password parameter.PasswordProtection(char[] password, String protectionAlgorithm, AlgorithmParameterSpec protectionParameters) Creates a password parameter and specifies the protection algorithm and associated parameters to use when encrypting a keystore entry.
- 
Method SummaryModifier and TypeMethodDescriptionvoiddestroy()Clears the password.char[]Gets the password.Gets the name of the protection algorithm.Gets the parameters supplied for the protection algorithm.booleanDetermines if password has been cleared.
- 
Constructor Details- 
PasswordProtectionpublic PasswordProtection(char[] password) Creates a password parameter.The specified passwordis cloned before it is stored in the newPasswordProtectionobject.- Parameters:
- password- the password, which may be- null
 
- 
PasswordProtectionpublic PasswordProtection(char[] password, String protectionAlgorithm, AlgorithmParameterSpec protectionParameters) Creates a password parameter and specifies the protection algorithm and associated parameters to use when encrypting a keystore entry.The specified passwordis cloned before it is stored in the newPasswordProtectionobject.- Parameters:
- 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
- Throws:
- NullPointerException- if- protectionAlgorithmis- null
- Since:
- 1.8
 
 
- 
- 
Method Details- 
getProtectionAlgorithmGets the name of the protection algorithm. If none was set then the keystore provider will use its default protection algorithm.- Returns:
- the algorithm name, or nullif none was set
- Since:
- 1.8
 
- 
getProtectionParametersGets the parameters supplied for the protection algorithm.- Returns:
- the algorithm parameter specification, or null, if none was set
- Since:
- 1.8
 
- 
getPasswordpublic char[] getPassword()Gets the password.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. - Returns:
- the password, which may be null
- Throws:
- IllegalStateException- if the password has been cleared (destroyed)
- See Also:
 
- 
destroyClears the password.- Specified by:
- destroyin interface- Destroyable
- Throws:
- DestroyFailedException- if this method was unable to clear the password
 
- 
isDestroyedpublic boolean isDestroyed()Determines if password has been cleared.- Specified by:
- isDestroyedin interface- Destroyable
- Returns:
- trueif the password has been cleared,- falseotherwise
 
 
-