Class SecretKeyFactorySpi
- java.lang.Object
-
- javax.crypto.SecretKeyFactorySpi
-
public abstract class SecretKeyFactorySpi extends Object
This class defines the Service Provider Interface (SPI) for theSecretKeyFactoryclass. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a secret-key factory for a particular algorithm.A provider should document all the key specifications supported by its secret key factory. For example, the DES secret-key factory supplied by the "SunJCE" provider supports
DESKeySpecas a transparent representation of DES keys, and that provider's secret-key factory for Triple DES keys supportsDESedeKeySpecas a transparent representation of Triple DES keys.- Since:
- 1.4
- See Also:
-
SecretKey,DESKeySpec,DESedeKeySpec
-
-
Constructor Summary
Constructors Constructor and Description SecretKeyFactorySpi()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description protected abstract SecretKeyengineGenerateSecret(KeySpec keySpec)Generates aSecretKeyobject from the provided key specification (key material).protected abstract KeySpecengineGetKeySpec(SecretKey key, Class<?> keySpec)Returns a specification (key material) of the given key object in the requested format.protected abstract SecretKeyengineTranslateKey(SecretKey key)Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.
-
-
-
Method Detail
engineGenerateSecret
protected abstract SecretKey engineGenerateSecret(KeySpec keySpec) throws InvalidKeySpecException
Generates aSecretKeyobject from the provided key specification (key material).- Parameters:
-
keySpec- the specification (key material) of the secret key - Returns:
- the secret key
- Throws:
-
InvalidKeySpecException- if the given key specification is inappropriate for this secret-key factory to produce a secret key.
engineGetKeySpec
protected abstract KeySpec engineGetKeySpec(SecretKey key, Class<?> keySpec) throws InvalidKeySpecException
Returns a specification (key material) of the given key object in the requested format.- Parameters:
-
key- the key -
keySpec- the requested format in which the key material shall be returned - Returns:
- the underlying key specification (key material) in the requested format
- Throws:
-
InvalidKeySpecException- if the requested key specification is inappropriate for the given key (e.g., the algorithms associated withkeyandkeySpecdo not match, orkeyreferences a key on a cryptographic hardware device whereaskeySpecis the specification of a software-based key), or the given key cannot be dealt with (e.g., the given key has an algorithm or format not supported by this secret-key factory).
engineTranslateKey
protected abstract SecretKey engineTranslateKey(SecretKey key) throws InvalidKeyException
Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.- Parameters:
-
key- the key whose provider is unknown or untrusted - Returns:
- the translated key
- Throws:
-
InvalidKeyException- if the given key cannot be processed by this secret-key factory.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
