Skip to content

Most visited

Recently visited

navigation
Added in API level 1

KeyStore.PrivateKeyEntry

public static final class KeyStore.PrivateKeyEntry
extends Object implements KeyStore.Entry

java.lang.Object
   ↳ java.security.KeyStore.PrivateKeyEntry


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

Summary

Public constructors

KeyStore.PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain)

Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain.

Public methods

Certificate getCertificate()

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

Certificate[] getCertificateChain()

Gets the Certificate chain from this entry.

PrivateKey getPrivateKey()

Gets the PrivateKey from this entry.

String toString()

Returns a string representation of this PrivateKeyEntry.

Inherited methods

From class java.lang.Object

Public constructors

KeyStore.PrivateKeyEntry

Added in API level 1
KeyStore.PrivateKeyEntry (PrivateKey privateKey, 
                Certificate[] chain)

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 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.
Throws
NullPointerException if privateKey or chain is null
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)

Public methods

getCertificate

Added in API level 1
Certificate getCertificate ()

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

Returns
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
Certificate[] getCertificateChain ()

Gets the Certificate chain from this entry.

The stored chain is cloned before being returned.

Returns
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
PrivateKey getPrivateKey ()

Gets the PrivateKey from this entry.

Returns
PrivateKey the PrivateKey from this entry

toString

Added in API level 1
String toString ()

Returns a string representation of this PrivateKeyEntry.

Returns
String a string representation of this PrivateKeyEntry.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.