Android APIs
public static final class

KeyStore.PrivateKeyEntry

extends Object
implements KeyStore.Entry
java.lang.Object
   ↳ java.security.KeyStore.PrivateKeyEntry

Class Overview

PrivateKeyEntry represents a KeyStore entry that holds a private key.

Summary

Public Constructors
KeyStore.PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain)
Constructs a new instance of PrivateKeyEntry with the given PrivateKey and the provided certificate chain.
Public Methods
Certificate getCertificate()
Returns the certificate corresponding to the private key.
Certificate[] getCertificateChain()
Returns the certificate chain.
PrivateKey getPrivateKey()
Returns the private key.
String toString()
Returns a string containing a concise, human-readable description of this PrivateKeyEntry.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Added in API level 1

Constructs a new instance of PrivateKeyEntry with the given PrivateKey and the provided certificate chain.

Parameters
privateKey PrivateKey: the private key.
chain Certificate: the ordered certificate chain with the certificate corresponding to the private key at index 0.
Throws
NullPointerException if privateKey or chain is null.
IllegalArgumentException if chain.length == 0, the algorithm of the private key does not match the algorithm of the public key of the first certificate or the certificates are not all of the same type.

Public Methods

public Certificate getCertificate ()

Added in API level 1

Returns the certificate corresponding to the private key.

Returns
Certificate the certificate corresponding to the private key.

public Certificate[] getCertificateChain ()

Added in API level 1

Returns the certificate chain.

Returns
Certificate[] the certificate chain.

public PrivateKey getPrivateKey ()

Added in API level 1

Returns the private key.

Returns
PrivateKey the private key.

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this PrivateKeyEntry.

Returns
String a printable representation for this PrivateKeyEntry.