KeyStore.PrivateKeyEntry

AI-generated Key Takeaways

• KeyStore.PrivateKeyEntry securely stores a private key and its corresponding certificate chain within a Java KeyStore.

• It provides methods to retrieve the private key, certificate chain, end-entity certificate, and associated attributes.

• Two constructors allow creating entries with or without custom attributes.

• The certificate chain must be ordered, starting with the end-entity certificate that matches the private key's algorithm.

• PrivateKeyEntry implements KeyStore.Entry and inherits methods from java.lang.Object.

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

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

Public Constructor Summary

	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 Method Summary

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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.security.KeyStore.Entry

Set<KeyStore.Entry.Attribute>

getAttributes() Retrieves the attributes associated with an entry.

Public Constructors

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	the PrivateKey
chain	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 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	the PrivateKey
chain	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	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

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

Retrieves the attributes associated with an entry.

Returns

• an unmodifiable Set of attributes, possibly empty

public Certificate getCertificate ()

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

Returns

• 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.

public Certificate[] getCertificateChain ()

Gets the Certificate chain from this entry.

The stored chain is cloned before being returned.

Returns

• 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[].

public PrivateKey getPrivateKey ()

Gets the PrivateKey from this entry.

Returns

• the PrivateKey from this entry

public String toString ()

Returns a string representation of this PrivateKeyEntry.

Returns

• a string representation of this PrivateKeyEntry.