Top Description Fields Methods
java.security

public Interface Key

extends Serializable
Known Direct Subinterfaces
javax.crypto.SecretKey, java.security.AsymmetricKey

The Key interface is the top-level interface for all keys. It defines the functionality shared by all Key objects. All keys have three characteristics: Keys are generally obtained through key generators, certificates, key stores or other classes used to manage keys. Keys may also be obtained from key specifications (transparent representations of the underlying key material) through the use of a key factory (see 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 Java Object Serialization Specification for more information.

Author
Benjamin Renaud
Since
1.1
See Also
PublicKey, PrivateKey, KeyPair, KeyPairGenerator, KeyFactory, KeyRep, java.security.spec.KeySpec

Field Summary

Modifier and TypeField and Description
public static final long
serialVersionUID

Deprecated A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the name of the algorithm associated with this key.
getAlgorithm
()

Returns the standard algorithm name for this key.

public byte[]

Returns:

the encoded key, or null if the key does not support encoding.
getEncoded
()

Returns the key in its primary encoding format, or null if this key does not support encoding.

public String

Returns:

the primary encoding format of the key.
getFormat
()

Returns the name of the primary encoding format of this key, or null if this key does not support encoding.

Field Detail

serialVersionUIDback to summary
public static final long serialVersionUID

Deprecated

A serialVersionUID field in an interface is ineffectual. Do not use; no replacement.

The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Annotations
@Deprecated
@SuppressWarnings:serial
@Serial

Method Detail

getAlgorithmback to summary
public String getAlgorithm()

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String

the name of the algorithm associated with this key.

getEncodedback to summary
public byte[] getEncoded()

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]

the encoded key, or null if the key does not support encoding.

getFormatback to summary
public String getFormat()

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "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:String

the primary encoding format of the key.