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(privateKey: PrivateKey!, chain: Array<Certificate!>!, attributes: MutableSet<KeyStore.Entry.Attribute!>!)Constructs a |
|
| Public methods | |
|---|---|
| MutableSet<KeyStore.Entry.Attribute!>! |
Retrieves the attributes associated with an entry. |
| Certificate! |
Gets the end entity |
| Array<Certificate!>! |
Gets the |
| PrivateKey! |
Gets the |
| String |
toString()Returns a string representation of this PrivateKeyEntry. |
Public constructors
PrivateKeyEntry
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.NullPointerException |
if privateKey or chain is null |
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) |
PrivateKeyEntry
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.NullPointerException |
if privateKey, chain or attributes is null |
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) |
Public methods
getAttributes
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
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
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
fun getPrivateKey(): PrivateKey!
Gets the PrivateKey from this entry.
| Return | |
|---|---|
PrivateKey! |
the PrivateKey from this entry |
toString
fun toString(): String
Returns a string representation of this PrivateKeyEntry.
| Return | |
|---|---|
String |
a string representation of this PrivateKeyEntry. |