APIdia Launch Partner
Top Description Constructors Methods
javax.crypto

public abstract Class SecretKeyFactorySpi

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.crypto.provider.DESedeKeyFactory, com.sun.crypto.provider.DESKeyFactory, com.sun.crypto.provider.PBEKeyFactory, com.sun.crypto.provider.PBKDF2Core
Imports
java.security.*, java.security.spec.*
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.

Author
Jan Luehe
Since
1.4
See Also
SecretKey, javax.crypto.spec.DESKeySpec, javax.crypto.spec.DESedeKeySpec

Constructor Summary

AccessConstructor and Description
public
SecretKeyFactorySpi()

Constructor for subclasses to call.

Method Summary

Modifier and TypeMethod and Description
protected abstract SecretKey

Returns:

the secret key
engineGenerateSecret(KeySpec
the specification (key material) of the secret key
keySpec)

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

protected abstract KeySpec

Returns:

the underlying key specification (key material) in the requested format
engineGetKeySpec(SecretKey
the key
key, Class<?>
the requested format in which the key material shall be returned
keySpec)

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

protected abstract SecretKey

Returns:

the translated key
engineTranslateKey(SecretKey
the key whose provider is unknown or untrusted
key)

Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this secret key factory.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SecretKeyFactorySpiback to summary
public SecretKeyFactorySpi()

Constructor for subclasses to call.

Method Detail

engineGenerateSecretback to summary
protected abstract SecretKey engineGenerateSecret(KeySpec keySpec) throws InvalidKeySpecException

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

Exceptions
InvalidKeySpecException:
if the given key specification is inappropriate for this secret key factory to produce a secret key.
engineGetKeySpecback to summary
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: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

Exceptions
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).
engineTranslateKeyback to summary
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:SecretKey

the key whose provider is unknown or untrusted

Returns:SecretKey

the translated key

Exceptions
InvalidKeyException:
if the given key cannot be processed by this secret key factory.