Stay organized with collections
Save and categorize content based on your preferences.
PrivateKey
interface PrivateKey : Destroyable, Key
Known Indirect Subclasses
| RSAMultiPrimePrivateCrtKey |
The interface to an RSA multi-prime private key, as defined in the PKCS#1 v2.2 standard, using the Chinese Remainder Theorem (CRT) information values.
|
| RSAPrivateCrtKey |
The interface to an RSA private key, as defined in the PKCS#1 v2.2 standard, using the Chinese Remainder Theorem (CRT) information values.
|
|
A private key. The purpose of this interface is to group (and provide type safety for) all private key interfaces.
Note: The specialized private key interfaces extend this interface. See, for example, the DSAPrivateKey interface in java.security.interfaces.
Implementations should override the default destroy and isDestroyed methods from the javax.security.auth.Destroyable interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since PrivateKey is Serializable, implementations should also override java.io.ObjectOutputStream#writeObject(java.lang.Object) to prevent keys that have been destroyed from being serialized.
Summary
| Constants |
| static Long |
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.
|
| Inherited functions |
From class Destroyable
Unit |
destroy()
Destroy this Object.
Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.
The default implementation throws DestroyFailedException.
Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.
|
Boolean |
isDestroyed()
Determine if this Object has been destroyed.
The default implementation returns false.
Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.
|
|
From class Key
String! |
getAlgorithm()
Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.
|
ByteArray! |
getEncoded()
Returns the key in its primary encoding format, or null if this key does not support encoding.
|
String! |
getFormat()
Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".
|
|
Constants
serialVersionUID
static val serialVersionUID: Long
Deprecated: A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.
Value: 6034044314589513430L
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]
