java.security

Interface Key

All Superinterfaces:

Serializable

All Known Subinterfaces:

PrivateKey, PublicKey, SecretKey

All Known Implementing Classes:

SecretKeySpec

public interface Key
extends Serializable

Field Summary

Fields

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

Method Summary

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

Method Detail

getAlgorithm

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:

the name of the algorithm associated with this key.

getFormat

@Nullable
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:

the primary encoding format of the key.

getEncoded

@Nullable
byte[] getEncoded()

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

Returns:

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