javax.crypto

Class SecretKeyFactory

java.lang.Object

javax.crypto.SecretKeyFactory

public class SecretKeyFactory
extends java.lang.Object

A secret key factory translates SecretKey objects to and from KeySpec objects, and can translate between different vendors' representations of SecretKey objects (for security or semantics; whichever applies).

Since:

1.4

See Also:

SecretKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecretKeyFactory(SecretKeyFactorySpi skfSpi, java.security.Provider provider, java.lang.String algorithm) Create a new secret key factory.

Method Summary

Methods

Modifier and Type	Method and Description
SecretKey	generateSecret(java.security.spec.KeySpec keySpec) Generate a secret key from a key specification, if possible.
java.lang.String	getAlgorithm() Get the algorithm name.
static SecretKeyFactory	getInstance(java.lang.String algorithm) Create a new secret key factory from the first appropriate instance.
static SecretKeyFactory	getInstance(java.lang.String algorithm, java.security.Provider provider) Create a new secret key factory from the specified provider.
static SecretKeyFactory	getInstance(java.lang.String algorithm, java.lang.String provider) Create a new secret key factory from the named provider.
java.security.spec.KeySpec	getKeySpec(SecretKey key, java.lang.Class keySpec) Get the key specification from a secret key.
java.security.Provider	getProvider() Get the provider of this implementation.
SecretKey	translateKey(SecretKey key) Translate a secret key into another form.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretKeyFactory

protected SecretKeyFactory(SecretKeyFactorySpi skfSpi,
                java.security.Provider provider,
                java.lang.String algorithm)

Create a new secret key factory.

Parameters:

skfSpi - The underlying factory implementation.

provider - The provider.

algorithm - The algorithm name.

Method Detail

getInstance

public static final SecretKeyFactory getInstance(java.lang.String algorithm)
                                          throws java.security.NoSuchAlgorithmException

Create a new secret key factory from the first appropriate instance.

Parameters:

algorithm - The algorithm name.

Returns:

The appropriate key factory, if found.

Throws:

java.security.NoSuchAlgorithmException - If no provider implements the specified algorithm.

java.lang.IllegalArgumentException - if algorithm is null or is an empty string.

getInstance

public static final SecretKeyFactory getInstance(java.lang.String algorithm,
                           java.lang.String provider)
                                          throws java.security.NoSuchAlgorithmException,
                                                 java.security.NoSuchProviderException

Create a new secret key factory from the named provider.

Parameters:

algorithm - The algorithm name.

provider - The provider name.

Returns:

The appropriate key factory, if found.

Throws:

java.security.NoSuchAlgorithmException - If the named provider does not implement the algorithm.

java.security.NoSuchProviderException - If the named provider does not exist.

java.lang.IllegalArgumentException - if either algorithm or provider is null, or if algorithm is an empty string.

getInstance

public static final SecretKeyFactory getInstance(java.lang.String algorithm,
                           java.security.Provider provider)
                                          throws java.security.NoSuchAlgorithmException

Create a new secret key factory from the specified provider.

Parameters:

algorithm - The algorithm name.

provider - The provider.

Returns:

The appropriate key factory, if found.

Throws:

java.security.NoSuchAlgorithmException - If the provider does not implement the algorithm.

java.lang.IllegalArgumentException - if either algorithm or provider is null, or if algorithm is an empty string.

generateSecret

public final SecretKey generateSecret(java.security.spec.KeySpec keySpec)
                               throws java.security.spec.InvalidKeySpecException

Generate a secret key from a key specification, if possible.

Parameters:

keySpec - The key specification.

Returns:

The secret key.

Throws:

java.security.InvalidKeySpecException - If the key specification cannot be transformed into a secret key.

java.security.spec.InvalidKeySpecException

getAlgorithm

public final java.lang.String getAlgorithm()

Get the algorithm name.

Returns:

The algorithm name.

getKeySpec

public final java.security.spec.KeySpec getKeySpec(SecretKey key,
                                    java.lang.Class keySpec)
                                            throws java.security.spec.InvalidKeySpecException

Get the key specification from a secret key.

Parameters:

key - The secret key.

keySpec - The target key specification class.

Returns:

The key specification.

Throws:

java.security.spec.InvalidKeySpecException - If the secret key cannot be transformed into the specified key specification.

getProvider

public final java.security.Provider getProvider()

Get the provider of this implementation.

Returns:

The provider.

translateKey

public final SecretKey translateKey(SecretKey key)
                             throws java.security.InvalidKeyException

Translate a secret key into another form.

Parameters:

key - The key to translate.

Returns:

The translated key.

Throws:

java.security.InvalidKeyException - If the argument cannot be translated.