Skip to content

Most visited

Recently visited

navigation
Added in API level 1

Key

public interface Key
implements Serializable

java.security.Key
Known Indirect Subclasses


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, or various Identity 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 Serialization Specification for more information.

See also:

Summary

Constants

long serialVersionUID

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

Public methods

abstract String getAlgorithm()

Returns the standard algorithm name for this key.

abstract byte[] getEncoded()

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

abstract String getFormat()

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

Constants

serialVersionUID

Added in API level 1
long serialVersionUID

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

Constant Value: 6603384152749567654 (0x5ba3eee69414eea6)

Public methods

getAlgorithm

Added in API level 1
String getAlgorithm ()

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names.

Returns
String the name of the algorithm associated with this key.

getEncoded

Added in API level 1
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.

getFormat

Added in API level 1
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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.