KeyStore.PrivateKeyEntry (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.security.KeyStore.PrivateKeyEntry

• All Implemented Interfaces:
  [KeyStore.Entry](../../java/security/KeyStore.Entry.html "interface in java.security")
  Enclosing class:
  KeyStore

public static final class KeyStore.PrivateKeyEntry
extends Object
implements KeyStore.Entry
A KeyStore entry that holds a PrivateKey and corresponding certificate chain.
Since:
1.5

• • Nested Class Summary

     * ### Nested classes/interfaces inherited from interface java.security.[KeyStore.Entry](../../java/security/KeyStore.Entry.html "interface in java.security")  
     `[KeyStore.Entry.Attribute](../../java/security/KeyStore.Entry.Attribute.html "interface in java.security")`  

  • Constructor Summary

  Constructors

  Constructor	Description
  PrivateKeyEntry​(PrivateKey privateKey,Certificate[] chain)	Constructs a PrivateKeyEntry with aPrivateKey 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.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### PrivateKeyEntry  
     public PrivateKeyEntry​([PrivateKey](../../java/security/PrivateKey.html "interface in java.security") privateKey,  
                            [Certificate](../../java/security/cert/Certificate.html "class in java.security.cert")[] 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 `Certificate`s representing the certificate chain. The chain must be ordered and contain a`Certificate` at index 0 corresponding to the private key.  
     Throws:  
     `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if`privateKey` or `chain` is `null`  
     `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified chain has a length of 0, if the specified chain does not contain`Certificate`s 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  
     public PrivateKeyEntry​([PrivateKey](../../java/security/PrivateKey.html "interface in java.security") privateKey,  
                            [Certificate](../../java/security/cert/Certificate.html "class in java.security.cert")[] chain,  
                            [Set](../../java/util/Set.html "interface in java.util")<[KeyStore.Entry.Attribute](../../java/security/KeyStore.Entry.Attribute.html "interface in java.security")> 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 `Certificate`s 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](../../java/lang/NullPointerException.html "class in java.lang")` \- if `privateKey`, `chain` or `attributes` is `null`  
     `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified chain has a length of 0, if the specified chain does not contain`Certificate`s 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)  
     Since:  
     1.8  

  • Method Detail

    * #### getPrivateKey  
    public [PrivateKey](../../java/security/PrivateKey.html "interface in java.security") getPrivateKey​()  
    Gets the `PrivateKey` from this entry.  
    Returns:  
    the `PrivateKey` from this entry  
    * #### getCertificateChain  
    public [Certificate](../../java/security/cert/Certificate.html "class in java.security.cert")[] getCertificateChain​()  
    Gets the `Certificate` chain from this entry.  
     The stored chain is cloned before being returned.  
    Returns:  
    an array of `Certificate`s 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[]`.  
    * #### getCertificate  
    public [Certificate](../../java/security/cert/Certificate.html "class in java.security.cert") 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`.  
    * #### getAttributes  
    public [Set](../../java/util/Set.html "interface in java.util")<[KeyStore.Entry.Attribute](../../java/security/KeyStore.Entry.Attribute.html "interface in java.security")> getAttributes​()  
    Retrieves the attributes associated with an entry.  
    Specified by:  
    `[getAttributes](../../java/security/KeyStore.Entry.html#getAttributes--)` in interface `[KeyStore.Entry](../../java/security/KeyStore.Entry.html "interface in java.security")`  
    Returns:  
    an unmodifiable `Set` of attributes, possibly empty  
    Since:  
    1.8  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString​()  
    Returns a string representation of this PrivateKeyEntry.  
    Overrides:  
    `[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a string representation of this PrivateKeyEntry.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.