public abstract class KeyFactorySpi extends Object
KeyFactory class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key factory for a particular algorithm. Key factories are used to convert keys (opaque cryptographic keys of type Key) into key specifications (transparent representations of the underlying key material), and vice versa.
Key factories are bidirectional. That is, they allow you to build an opaque key object from a given key specification (key material), or to retrieve the underlying key material of a key object in a suitable format.
Multiple compatible key specifications may exist for the same key. For example, a DSA public key may be specified using DSAPublicKeySpec or X509EncodedKeySpec. A key factory can be used to translate between compatible key specifications.
A provider should document all the key specifications supported by its key factory.
| Constructor | Description |
|---|---|
KeyFactorySpi() |
Constructor for subclasses to call. |
| Modifier and Type | Method | Description |
|---|---|---|
protected abstract PrivateKey |
engineGeneratePrivate |
Generates a private key object from the provided key specification (key material). |
protected abstract PublicKey |
engineGeneratePublic |
Generates a public key object from the provided key specification (key material). |
protected abstract <T extends KeySpec> |
engineGetKeySpec |
Returns a specification (key material) of the given key object. |
protected abstract Key |
engineTranslateKey |
Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this key factory. |
public KeyFactorySpi()
protected abstract PublicKey engineGeneratePublic(KeySpec keySpec) throws InvalidKeySpecException
keySpec - the specification (key material) of the public key.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a public key.protected abstract PrivateKey engineGeneratePrivate(KeySpec keySpec) throws InvalidKeySpecException
keySpec - the specification (key material) of the private key.InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a private key.protected abstract <T extends KeySpec> T engineGetKeySpec(Key key, Class<T> keySpec) throws InvalidKeySpecException
keySpec identifies the specification class in which the key material should be returned. It could, for example, be DSAPublicKeySpec.class, to indicate that the key material should be returned in an instance of the DSAPublicKeySpec class.T - the type of the key specification to be returnedkey - the key.keySpec - the specification class in which the key material should be returned.InvalidKeySpecException - if the requested key specification is inappropriate for the given key, or the given key cannot be dealt with (e.g., the given key has an unrecognized format).protected abstract Key engineTranslateKey(Key key) throws InvalidKeyException
key - the key whose provider is unknown or untrusted.InvalidKeyException - if the given key cannot be processed by this key factory.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/KeyFactorySpi.html