All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Interface java.security.Key

public interface Key
extends Serializable
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).

See Also:
PublicKey, PrivateKey, KeyPair, KeyPairGenerator, KeyFactory, KeySpec, Identity, IdentityScope, Signer

Method Index

 o getAlgorithm()
Returns the standard algorithm name for this key.
 o getEncoded()
Returns the key in its primary encoding format, or null if this key does not support encoding.
 o getFormat()
Returns the name of the primary encoding format of this key, or null if this key does not support encoding.

Methods

 o getAlgorithm
public abstract 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.
 o getFormat
public abstract 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.
 o getEncoded
public abstract 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Submit a bug or feature