Liking cljdoc? Tell your friends :D

jdk.security.KeyStore$PasswordProtection

A password-based implementation of ProtectionParameter.

A password-based implementation of ProtectionParameter.
raw docstring

->password-protectionclj

(->password-protection password)
(->password-protection password protection-algorithm protection-parameters)

Constructor.

Creates a password parameter and specifies the protection algorithm and associated parameters to use when encrypting a keystore entry.

The specified password is cloned before it is stored in the new PasswordProtection object.

password - the password, which may be null - char[] protection-algorithm - the encryption algorithm name, for example, PBEWithHmacSHA256AndAES_256. See the Cipher section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard encryption algorithm names. - java.lang.String protection-parameters - the encryption algorithm parameter specification, which may be null - java.security.spec.AlgorithmParameterSpec

throws: java.lang.NullPointerException - if protectionAlgorithm is null

Constructor.

Creates a password parameter and specifies the protection algorithm
 and associated parameters to use when encrypting a keystore entry.

 The specified password is cloned before it is stored in the
 new PasswordProtection object.

password - the password, which may be null - `char[]`
protection-algorithm - the encryption algorithm name, for example, PBEWithHmacSHA256AndAES_256. See the Cipher section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard encryption algorithm names. - `java.lang.String`
protection-parameters - the encryption algorithm parameter specification, which may be null - `java.security.spec.AlgorithmParameterSpec`

throws: java.lang.NullPointerException - if protectionAlgorithm is null
raw docstring

destroyclj

(destroy this)

Clears the password.

throws: javax.security.auth.DestroyFailedException - if this method was unable to clear the password

Clears the password.

throws: javax.security.auth.DestroyFailedException - if this method was unable to clear the password
raw docstring

destroyed?clj

(destroyed? this)

Determines if password has been cleared.

returns: true if the password has been cleared, false otherwise - boolean

Determines if password has been cleared.

returns: true if the password has been cleared, false otherwise - `boolean`
raw docstring

get-passwordclj

(get-password this)

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 - char[]

throws: java.lang.IllegalStateException - if the password has been cleared (destroyed)

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 - `char[]`

throws: java.lang.IllegalStateException - if the password has been cleared (destroyed)
raw docstring

get-protection-algorithmclj

(get-protection-algorithm this)

Gets the name of the protection algorithm. If none was set then the keystore provider will use its default protection algorithm. The name of the default protection algorithm for a given keystore type is set using the 'keystore.<type>.keyProtectionAlgorithm' security property. For example, the keystore.PKCS12.keyProtectionAlgorithm property stores the name of the default key protection algorithm used for PKCS12 keystores. If the security property is not set, an implementation-specific algorithm will be used.

returns: the algorithm name, or null if none was set - java.lang.String

Gets the name of the protection algorithm.
 If none was set then the keystore provider will use its default
 protection algorithm. The name of the default protection algorithm
 for a given keystore type is set using the
 'keystore.<type>.keyProtectionAlgorithm' security property.
 For example, the
 keystore.PKCS12.keyProtectionAlgorithm property stores the
 name of the default key protection algorithm used for PKCS12
 keystores. If the security property is not set, an
 implementation-specific algorithm will be used.

returns: the algorithm name, or null if none was set - `java.lang.String`
raw docstring

get-protection-parametersclj

(get-protection-parameters this)

Gets the parameters supplied for the protection algorithm.

returns: the algorithm parameter specification, or null, if none was set - java.security.spec.AlgorithmParameterSpec

Gets the parameters supplied for the protection algorithm.

returns: the algorithm parameter specification, or null,
     if none was set - `java.security.spec.AlgorithmParameterSpec`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close