SecretKeyFactorySpi (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • javax.crypto.SecretKeyFactorySpi

• ---

public abstract class SecretKeyFactorySpi
extends Object
This class defines the Service Provider Interface (SPI) for the SecretKeyFactory class. 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 DESKeySpec as a transparent representation of DES keys, and that provider's secret-key factory for Triple DES keys supportsDESedeKeySpec as a transparent representation of Triple DES keys.
Since:
1.4
See Also:
SecretKey, DESKeySpec, DESedeKeySpec

• • Constructor Summary

  Constructors

  Constructor	Description
  SecretKeyFactorySpi()

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  protected abstract SecretKey	engineGenerateSecret​(KeySpec keySpec)	Generates a SecretKey object from the provided key specification (key material).
  protected abstract KeySpec	engineGetKeySpec​(SecretKey key,Class<?> keySpec)	Returns a specification (key material) of the given key object in the requested format.
  protected abstract SecretKey	engineTranslateKey​(SecretKey key)	Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret-key factory.

     * ### Methods declared in class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,int%29)`

• • Constructor Detail

     * #### SecretKeyFactorySpi  
     public SecretKeyFactorySpi()  

  • Method Detail

    * #### engineGenerateSecret  
    protected abstract [SecretKey](SecretKey.html "interface in javax.crypto") engineGenerateSecret​([KeySpec](../../java/security/spec/KeySpec.html "interface in java.security.spec") keySpec)  
                                               throws [InvalidKeySpecException](../../java/security/spec/InvalidKeySpecException.html "class in java.security.spec")  
    Generates a `SecretKey` object from the provided key specification (key material).  
    Parameters:  
    `keySpec` \- the specification (key material) of the secret key  
    Returns:  
    the secret key  
    Throws:  
    `[InvalidKeySpecException](../../java/security/spec/InvalidKeySpecException.html "class in java.security.spec")` \- if the given key specification is inappropriate for this secret-key factory to produce a secret key.  
    * #### engineGetKeySpec  
    protected abstract [KeySpec](../../java/security/spec/KeySpec.html "interface in java.security.spec") engineGetKeySpec​([SecretKey](SecretKey.html "interface in javax.crypto") key,  
                                                [Class](../../java/lang/Class.html "class in java.lang")<?> keySpec)  
                                         throws [InvalidKeySpecException](../../java/security/spec/InvalidKeySpecException.html "class in java.security.spec")  
    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](../../java/security/spec/InvalidKeySpecException.html "class in java.security.spec")` \- if the requested key specification is inappropriate for the given key (e.g., the algorithms associated with`key` and `keySpec` do not match, or`key` references a key on a cryptographic hardware device whereas `keySpec` is 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](SecretKey.html "interface in javax.crypto") engineTranslateKey​([SecretKey](SecretKey.html "interface in javax.crypto") key)  
                                             throws [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security")  
    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](../../java/security/InvalidKeyException.html "class in java.security")` \- if the given key cannot be processed by this secret-key factory.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.