All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Interface java.security.Key

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 or PKCS#8), and is returned using the getEncoded method.

• A Format

  This is the name of the format of the encoded key. It is returned by the getFormat method.

See Also:

PublicKey, PrivateKey, KeyPair, KeyPairGenerator, KeyFactory, KeySpec, Identity, IdentityScope, Signer

getAlgorithm()

Returns the standard algorithm name for this key.

getEncoded()

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

getFormat()

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

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.

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.

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