Skip to content

Most visited

Recently visited

navigation
Added in API level 1

SecretKeyFactorySpi

public abstract class SecretKeyFactorySpi
extends Object

java.lang.Object
   ↳ javax.crypto.SecretKeyFactorySpi


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 supports DESedeKeySpec as a transparent representation of Triple DES keys.

See also:

Summary

Public constructors

SecretKeyFactorySpi()

Protected methods

abstract SecretKey engineGenerateSecret(KeySpec keySpec)

Generates a SecretKey object from the provided key specification (key material).

abstract KeySpec engineGetKeySpec(SecretKey key, Class keySpec)

Returns a specification (key material) of the given key object in the requested format.

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.

Inherited methods

From class java.lang.Object

Public constructors

SecretKeyFactorySpi

Added in API level 1
SecretKeyFactorySpi ()

Protected methods

engineGenerateSecret

Added in API level 1
SecretKey engineGenerateSecret (KeySpec keySpec)

Generates a SecretKey object from the provided key specification (key material).

Parameters
keySpec KeySpec: the specification (key material) of the secret key
Returns
SecretKey the secret key
Throws
InvalidKeySpecException if the given key specification is inappropriate for this secret-key factory to produce a secret key.

engineGetKeySpec

Added in API level 1
KeySpec engineGetKeySpec (SecretKey key, 
                Class keySpec)

Returns a specification (key material) of the given key object in the requested format.

Parameters
key SecretKey: the key
keySpec Class: the requested format in which the key material shall be returned
Returns
KeySpec 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 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

Added in API level 1
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.

Parameters
key SecretKey: the key whose provider is unknown or untrusted
Returns
SecretKey the translated key
Throws
InvalidKeyException if the given key cannot be processed by this secret-key factory.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.