[ Web Proxy ]
URL:
Viewing: https://developer.android.com/reference/kotlin/java/security/KeyStore.PrivateKeyEntry [Back]  [Original]
KeyStore.PrivateKeyEntry  |  API reference  |  Android Developers Skip to main content
Android Developers [Android Developers]
Essentials Design & Plan Develop Google Play Blog
Search:
Android Studio
Android Developers [Android Developers]
Stay organized with collections Save and categorize content based on your preferences.
Added in API level 1

PrivateKeyEntry

class PrivateKeyEntry : KeyStore.Entry
kotlin.Any
java.security.KeyStore.PrivateKeyEntry

A KeyStore entry that holds a PrivateKey and corresponding certificate chain.

Summary

Public constructors
PrivateKeyEntry(privateKey: PrivateKey!, chain: Array<Certificate!>!)

Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain.

Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain and associated entry attributes.
Public methods
MutableSet<KeyStore.Entry.Attribute!>!

Retrieves the attributes associated with an entry.
Certificate!

Gets the end entity Certificate from the certificate chain in this entry.
Array<Certificate!>!

Gets the Certificate chain from this entry.
PrivateKey!

Gets the PrivateKey from this entry.
String

Returns a string representation of this PrivateKeyEntry.

Public constructors

PrivateKeyEntry

Added in API level 1
PrivateKeyEntry(
    privateKey: PrivateKey!, 
    chain: Array<Certificate!>!)

Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain.

The specified chain is cloned before it is stored in the new PrivateKeyEntry object.

Parameters
privateKey PrivateKey!: the PrivateKey
chain Array<Certificate!>!: an array of Certificates representing the certificate chain. The chain must be ordered and contain a Certificate at index 0 corresponding to the private key.
Exceptions
java.lang.IllegalArgumentException if the specified chain has a length of 0, if the specified chain does not contain Certificates of the same type, or if the PrivateKey algorithm does not match the algorithm of the PublicKey in the end entity Certificate (at index 0)
java.lang.NullPointerException if privateKey or chain is null

PrivateKeyEntry

Added in API level 26
PrivateKeyEntry(
    privateKey: PrivateKey!, 
    chain: Array<Certificate!>!, 
    attributes: MutableSet<KeyStore.Entry.Attribute!>!)

Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain and associated entry attributes.

The specified chain and attributes are cloned before they are stored in the new PrivateKeyEntry object.

Parameters
privateKey PrivateKey!: the PrivateKey
chain Array<Certificate!>!: an array of Certificates representing the certificate chain. The chain must be ordered and contain a Certificate at index 0 corresponding to the private key.
attributes MutableSet<KeyStore.Entry.Attribute!>!: the attributes
Exceptions
java.lang.IllegalArgumentException if the specified chain has a length of 0, if the specified chain does not contain Certificates of the same type, or if the PrivateKey algorithm does not match the algorithm of the PublicKey in the end entity Certificate (at index 0)
java.lang.NullPointerException if privateKey, chain or attributes is null

Public methods

getAttributes

Added in API level 26
fun getAttributes(): MutableSet<KeyStore.Entry.Attribute!>!

Retrieves the attributes associated with an entry.

Return
MutableSet<KeyStore.Entry.Attribute!>! an unmodifiable Set of attributes, possibly empty

getCertificate

Added in API level 1
fun getCertificate(): Certificate!

Gets the end entity Certificate from the certificate chain in this entry.

Return
Certificate! the end entity Certificate (at index 0) from the certificate chain in this entry. If the certificate is of type X.509, the runtime type of the returned certificate is X509Certificate.

getCertificateChain

Added in API level 1
fun getCertificateChain(): Array<Certificate!>!

Gets the Certificate chain from this entry.

The stored chain is cloned before being returned.

Return
Array<Certificate!>! an array of Certificates corresponding to the certificate chain for the public key. If the certificates are of type X.509, the runtime type of the returned array is X509Certificate[].

getPrivateKey

Added in API level 1
fun getPrivateKey(): PrivateKey!

Gets the PrivateKey from this entry.

Return
PrivateKey! the PrivateKey from this entry

toString

Added in API level 1
fun toString(): String

Returns a string representation of this PrivateKeyEntry.

Return
String a string representation of this PrivateKeyEntry.

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 2026-02-13 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 2026-02-13 UTC."],[],[]]
Web Proxy Viewer  |  New URL  |  Original Page