- java.lang.Object
-
- javax.net.ssl.KeyManagerFactory
-
public class KeyManagerFactory extends Object
This class acts as a factory for key managers based on a source of key material. Each key manager manages a specific type of key material for use by secure sockets. The key material is based on a KeyStore and/or provider specific sources.- Since:
- 1.4
- See Also:
KeyManager
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object.
-
Method Summary
Methods Modifier and Type Method and Description String
getAlgorithm()
Returns the algorithm name of thisKeyManagerFactory
object.static String
getDefaultAlgorithm()
Obtains the default KeyManagerFactory algorithm name.static KeyManagerFactory
getInstance(String algorithm)
Returns aKeyManagerFactory
object that acts as a factory for key managers.static KeyManagerFactory
getInstance(String algorithm, Provider provider)
Returns aKeyManagerFactory
object that acts as a factory for key managers.static KeyManagerFactory
getInstance(String algorithm, String provider)
Returns aKeyManagerFactory
object that acts as a factory for key managers.KeyManager[]
getKeyManagers()
Returns one key manager for each type of key material.Provider
getProvider()
Returns the provider of thisKeyManagerFactory
object.void
init(KeyStore ks, char[] password)
Initializes this factory with a source of key material.void
init(ManagerFactoryParameters spec)
Initializes this factory with a source of provider-specific key material.
-
-
-
Constructor Detail
-
KeyManagerFactory
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Creates a KeyManagerFactory object.- Parameters:
factorySpi
- the delegateprovider
- the provideralgorithm
- the algorithm
-
-
Method Detail
-
getDefaultAlgorithm
public static final String getDefaultAlgorithm()
Obtains the default KeyManagerFactory algorithm name.The default algorithm can be changed at runtime by setting the value of the "ssl.KeyManagerFactory.algorithm" security property (set in the Java security properties file or by calling
Security.setProperty(java.lang.String, java.lang.String)
) to the desired algorithm name.- Returns:
- the default algorithm name as specified in the Java security properties, or an implementation-specific default if no such property exists.
- See Also:
Security.setProperty(java.lang.String, java.lang.String)
-
getAlgorithm
public final String getAlgorithm()
Returns the algorithm name of thisKeyManagerFactory
object.This is the same name that was specified in one of the
getInstance
calls that created thisKeyManagerFactory
object.- Returns:
- the algorithm name of this
KeyManagerFactory
object.
-
getInstance
public static final KeyManagerFactory getInstance(String algorithm) throws NoSuchAlgorithmException
Returns aKeyManagerFactory
object that acts as a factory for key managers.This method traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.- Returns:
- the new
KeyManagerFactory
object. - Throws:
NoSuchAlgorithmException
- if no Provider supports a KeyManagerFactorySpi implementation for the specified algorithm.NullPointerException
- ifalgorithm
is null.- See Also:
Provider
-
getInstance
public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Returns aKeyManagerFactory
object that acts as a factory for key managers.A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the
Security.getProviders()
method.- Parameters:
algorithm
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.provider
- the name of the provider.- Returns:
- the new
KeyManagerFactory
object. - Throws:
NoSuchAlgorithmException
- if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified provider.NoSuchProviderException
- if the specified provider is not registered in the security provider list.IllegalArgumentException
- if the provider name is null or empty.NullPointerException
- ifalgorithm
is null.- See Also:
Provider
-
getInstance
public static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Returns aKeyManagerFactory
object that acts as a factory for key managers.A new KeyManagerFactory object encapsulating the KeyManagerFactorySpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
- Parameters:
algorithm
- the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names.provider
- an instance of the provider.- Returns:
- the new
KeyManagerFactory
object. - Throws:
NoSuchAlgorithmException
- if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object.IllegalArgumentException
- if provider is null.NullPointerException
- ifalgorithm
is null.- See Also:
Provider
-
getProvider
public final Provider getProvider()
Returns the provider of thisKeyManagerFactory
object.- Returns:
- the provider of this
KeyManagerFactory
object
-
init
public final void init(KeyStore ks, char[] password) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException
Initializes this factory with a source of key material.The provider typically uses a KeyStore for obtaining key material for use during secure socket negotiations. The KeyStore is generally password-protected.
For more flexible initialization, please see
init(ManagerFactoryParameters)
.- Parameters:
ks
- the key store or nullpassword
- the password for recovering keys in the KeyStore- Throws:
KeyStoreException
- if this operation failsNoSuchAlgorithmException
- if the specified algorithm is not available from the specified provider.UnrecoverableKeyException
- if the key cannot be recovered (e.g. the given password is wrong).
-
init
public final void init(ManagerFactoryParameters spec) throws InvalidAlgorithmParameterException
Initializes this factory with a source of provider-specific key material.In some cases, initialization parameters other than a keystore and password may be needed by a provider. Users of that particular provider are expected to pass an implementation of the appropriate
ManagerFactoryParameters
as defined by the provider. The provider can then call the specified methods in theManagerFactoryParameters
implementation to obtain the needed information.- Parameters:
spec
- an implementation of a provider-specific parameter specification- Throws:
InvalidAlgorithmParameterException
- if an error is encountered
-
getKeyManagers
public final KeyManager[] getKeyManagers()
Returns one key manager for each type of key material.- Returns:
- the key managers
- Throws:
IllegalStateException
- if the KeyManagerFactory is not initialized
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
24/11/2024 14:14:56 Cette version de la page est en cache (à la date du 24/11/2024 14:14:56) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/net/ssl/KeyManagerFactory.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.