Class SecretKeyFactorySpi

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

Since:

1.4

See Also:

Constructor Summary

Constructor	Description
`SecretKeyFactorySpi()`	Constructor for subclasses to call.

Method Summary

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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

SecretKeyFactorySpi

public SecretKeyFactorySpi()

Constructor for subclasses to call.

Method Details

engineGenerateSecret

protected abstract SecretKey engineGenerateSecret(KeySpec keySpec) throws InvalidKeySpecException

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 - 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 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 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.

© 1993, 2025, 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.