Added in API level 1

Summary: Ctors | Methods | Inherited Methods

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
PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain) Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain.
PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain, Set<KeyStore.Entry.Attribute> attributes) Constructs a PrivateKeyEntry with a PrivateKey and corresponding certificate chain and associated entry attributes.

Public methods
Set<KeyStore.Entry.Attribute>	getAttributes() Retrieves the attributes associated with an entry.
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 Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface java.security.KeyStore.Entry default Set<KeyStore.Entry.Attribute> getAttributes() Retrieves the attributes associated with an entry.

Public constructors

PrivateKeyEntry

Added in API level 1

public 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)

PrivateKeyEntry

Added in API level 26

public PrivateKeyEntry (PrivateKey privateKey, 
                Certificate[] chain, 
                Set<KeyStore.Entry.Attribute> attributes)

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	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	Set: the attributes

Throws
NullPointerException	if privateKey, chain or attributes 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

getAttributes

Added in API level 26

public Set<KeyStore.Entry.Attribute> getAttributes ()

Retrieves the attributes associated with an entry.

Returns
Set<KeyStore.Entry.Attribute>	an unmodifiable Set of attributes, possibly empty

getCertificate

Added in API level 1

public 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

public 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

public PrivateKey getPrivateKey ()

Gets the PrivateKey from this entry.

Returns
PrivateKey	the PrivateKey from this entry

toString

Added in API level 1

public String toString ()

Returns a string representation of this PrivateKeyEntry.

Returns
String	a string representation of this PrivateKeyEntry.