Overview | Package | Class | Tree | Deprecated | Index | Help | |||
PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.crypto.SecretKeyFactory
Key factories are used to convert keys (opaque
cryptographic keys of type Key
) into key specifications
(transparent representations of the underlying key material), and vice
versa.
Secret key factories operate only on secret (symmetric) keys.
Key factories are bi-directional, i.e., they allow to build an opaque key object from a given key specification (key material), or to retrieve the underlying key material of a key object in a suitable format.
Application developers should refer to their provider's documentation
to find out which key specifications are supported by the
generateSecret and
getKeySpec methods.
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.
Constructor Summary | |
SecretKeyFactory(SecretKeyFactorySpi keyFacSpi,
java.security.Provider provider,
java.lang.String algorithm)
Creates a SecretKeyFactory object. |
Method Summary | |
SecretKey | generateSecret(java.security.spec.KeySpec keySpec)
Generates a SecretKey object from the provided key
specification (key material). |
java.lang.String | getAlgorithm()
Returns the algorithm name of this SecretKeyFactory object.
|
static SecretKeyFactory | getInstance(java.lang.String algorithm)
Generates a SecretKeyFactory object for the
specified secret-key algorithm.
|
static SecretKeyFactory | getInstance(java.lang.String algorithm,
java.lang.String provider)
Generates a SecretKeyFactory object for the specified
secret-key algorithm from the specified provider. |
java.security.spec.KeySpec | getKeySpec(SecretKey key,
java.lang.Class keySpec)
Returns a specification (key material) of the given key object in the requested format. |
java.security.Provider | getProvider()
Returns the provider of this SecretKeyFactory object. |
SecretKey | translateKey(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 inherited from class java.lang.Object | |
clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait |
Constructor Detail |
protected SecretKeyFactory(SecretKeyFactorySpi keyFacSpi, java.security.Provider provider, java.lang.String algorithm)
keyFacSpi
- the delegate
provider
- the provider
algorithm
- the secret-key algorithmMethod Detail |
public static final SecretKeyFactory getInstance(java.lang.String algorithm) throws java.security.NoSuchAlgorithmException
SecretKeyFactory
object for the
specified secret-key algorithm.
If the default provider package provides an implementation of the
requested factory, an instance of SecretKeyFactory
containing that implementation is returned.
If the requested factory is not available in the default provider
package, other provider packages are searched.
algorithm
- the standard name of the requested secret-key
algorithm.
See Appendix A in the
Java Cryptography Extension API Specification & Reference
for information about standard algorithm names.SecretKeyFactory
object for the specified
secret-key algorithm.public static final SecretKeyFactory getInstance(java.lang.String algorithm, java.lang.String provider) throws java.security.NoSuchAlgorithmException, java.security.NoSuchProviderException
SecretKeyFactory
object for the specified
secret-key algorithm from the specified provider.
algorithm
- the standard name of the requested secret-key
algorithm.
See Appendix A in the
Java Cryptography Extension API Specification & Reference
for information about standard algorithm names.
provider
- the name of the provider.SecretKeyFactory
object for the specified
secret-key algorithm.public final java.security.Provider getProvider()
SecretKeyFactory
object.SecretKeyFactory
objectpublic final java.lang.String getAlgorithm()
SecretKeyFactory
object.
This is the same name that was specified in one of the
getInstance
calls that created this
SecretKeyFactory
object.
SecretKeyFactory
object.public final SecretKey generateSecret(java.security.spec.KeySpec keySpec) throws java.security.spec.InvalidKeySpecException
SecretKey
object from the provided key
specification (key material).
keySpec
- the specification (key material) of the secret keypublic final java.security.spec.KeySpec getKeySpec(SecretKey key, java.lang.Class keySpec) throws java.security.spec.InvalidKeySpecException
key
- the key
keySpec
- the requested format in which the key material shall be
returnedkey
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).public final SecretKey translateKey(SecretKey key) throws java.security.InvalidKeyException
key
- the key whose provider is unknown or untrustedOverview | Package | Class | Tree | Deprecated | Index | Help | |||
PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |