Interface Key
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
-
DHPrivateKey
,DHPublicKey
,DSAPrivateKey
,DSAPublicKey
,ECPrivateKey
,ECPublicKey
,EdECPrivateKey
,EdECPublicKey
,PBEKey
,PrivateKey
,PublicKey
,RSAMultiPrimePrivateCrtKey
,RSAPrivateCrtKey
,RSAPrivateKey
,RSAPublicKey
,SecretKey
,XECPrivateKey
,XECPublicKey
- All Known Implementing Classes:
-
EncryptionKey
,KerberosKey
,SecretKeySpec
public interface Key extends Serializable
- An Algorithm
This is the key algorithm for that key. The key algorithm is usually an encryption or asymmetric operation algorithm (such as DSA or RSA), which will work with those algorithms and with related algorithms (such as MD5 with RSA, SHA-1 with RSA, Raw DSA, etc.) The name of the algorithm of a key is obtained using the
getAlgorithm
method. - An Encoded Form
This is an external encoded form for the key used when a standard representation of the key is needed outside the Java Virtual Machine, as when transmitting the key to some other party. The key is encoded according to a standard format (such as X.509
SubjectPublicKeyInfo
or PKCS#8), and is returned using thegetEncoded
method. Note: The syntax of the ASN.1 typeSubjectPublicKeyInfo
is defined as follows:SubjectPublicKeyInfo ::= SEQUENCE { algorithm AlgorithmIdentifier, subjectPublicKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }
For more information, see RFC 5280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile. - A Format
This is the name of the format of the encoded key. It is returned by the
getFormat
method.
KeyFactory
). A Key should use KeyRep as its serialized representation. Note that a serialized Key may contain sensitive information which should not be exposed in untrusted environments. See the Security Appendix of the Serialization Specification for more information.
- Since:
- 1.1
- See Also:
Field Summary
Modifier and Type | Field | Description |
---|---|---|
static final long |
serialVersionUID |
Deprecated. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
String |
getAlgorithm() |
Returns the standard algorithm name for this key. |
byte[] |
getEncoded() |
Returns the key in its primary encoding format, or null if this key does not support encoding. |
String |
getFormat() |
Returns the name of the primary encoding format of this key, or null if this key does not support encoding. |
Field Details
serialVersionUID
@Deprecated static final long serialVersionUID
serialVersionUID
field in an interface is ineffectual. Do not use; no replacement.- See Also:
Method Details
getAlgorithm
String getAlgorithm()
- Returns:
- the name of the algorithm associated with this key.
getFormat
String getFormat()
"X.509"
. Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8"
.- Returns:
- the primary encoding format of the key.
getEncoded
byte[] getEncoded()
- Returns:
- the encoded key, or null if the key does not support encoding.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/Key.html
serialVersionUID
field in an interface is ineffectual.