PrivateKey (Java SE 9 & JDK 9 ) (original) (raw)

• All Superinterfaces:
  [Destroyable](../../javax/security/auth/Destroyable.html "interface in javax.security.auth"), [Key](../../java/security/Key.html "interface in java.security"), [Serializable](../../java/io/Serializable.html "interface in java.io")
  All Known Subinterfaces:
  [DHPrivateKey](../../javax/crypto/interfaces/DHPrivateKey.html "interface in javax.crypto.interfaces"), [DSAPrivateKey](../../java/security/interfaces/DSAPrivateKey.html "interface in java.security.interfaces"), [ECPrivateKey](../../java/security/interfaces/ECPrivateKey.html "interface in java.security.interfaces"), [RSAMultiPrimePrivateCrtKey](../../java/security/interfaces/RSAMultiPrimePrivateCrtKey.html "interface in java.security.interfaces"), [RSAPrivateCrtKey](../../java/security/interfaces/RSAPrivateCrtKey.html "interface in java.security.interfaces"), [RSAPrivateKey](../../java/security/interfaces/RSAPrivateKey.html "interface in java.security.interfaces")

public interface PrivateKey
extends Key, Destroyable
A private key. The purpose of this interface is to group (and provide type safety for) all private key interfaces.
Note: The specialized private key interfaces extend this interface. See, for example, the DSAPrivateKey interface injava.security.interfaces.
Implementations should override the default destroy andisDestroyed methods from theDestroyable interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since PrivateKey is Serializable, implementations should also overrideObjectOutputStream.writeObject(java.lang.Object) to prevent keys that have been destroyed from being serialized.
Since:
1.1
See Also:
Key, PublicKey, Certificate, Signature.initVerify(java.security.PublicKey), DSAPrivateKey, RSAPrivateKey, RSAPrivateCrtKey

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static long	serialVersionUID	The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

  • Method Summary

    * ### Methods inherited from interface javax.security.auth.[Destroyable](../../javax/security/auth/Destroyable.html "interface in javax.security.auth")  
    `[destroy](../../javax/security/auth/Destroyable.html#destroy--), [isDestroyed](../../javax/security/auth/Destroyable.html#isDestroyed--)`  
    * ### Methods inherited from interface java.security.[Key](../../java/security/Key.html "interface in java.security")  
    `[getAlgorithm](../../java/security/Key.html#getAlgorithm--), [getEncoded](../../java/security/Key.html#getEncoded--), [getFormat](../../java/security/Key.html#getFormat--)`

• • Field Detail

     * #### serialVersionUID  
     static final long serialVersionUID  
     The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.  
     See Also:  
     [Constant Field Values](../../constant-values.html#java.security.PrivateKey.serialVersionUID)

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.