KeyManagerFactory
open class KeyManagerFactory
kotlin.Any | |
↳ | javax.net.ssl.KeyManagerFactory |
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.
Android provides the following KeyManagerFactory
algorithms:
Algorithm | Supported API Levels |
---|---|
PKIX | 1+ |
Summary
Protected constructors | |
---|---|
KeyManagerFactory(factorySpi: KeyManagerFactorySpi!, provider: Provider!, algorithm: String!) Creates a KeyManagerFactory object. |
Public methods | |
---|---|
String! |
Returns the algorithm name of this |
static String! |
Obtains the default KeyManagerFactory algorithm name. |
static KeyManagerFactory! |
getInstance(algorithm: String!) Returns a |
static KeyManagerFactory! |
getInstance(algorithm: String!, provider: String!) Returns a |
static KeyManagerFactory! |
getInstance(algorithm: String!, provider: Provider!) Returns a |
Array<KeyManager!>! |
Returns one key manager for each type of key material. |
Provider! |
Returns the provider of this |
Unit |
Initializes this factory with a source of key material. |
Unit |
init(spec: ManagerFactoryParameters!) Initializes this factory with a source of provider-specific key material. |
Protected constructors
KeyManagerFactory
protected KeyManagerFactory(
factorySpi: KeyManagerFactorySpi!,
provider: Provider!,
algorithm: String!)
Creates a KeyManagerFactory object.
Parameters | |
---|---|
factorySpi |
KeyManagerFactorySpi!: the delegate |
provider |
Provider!: the provider |
algorithm |
String!: the algorithm |
Public methods
getAlgorithm
fun getAlgorithm(): String!
Returns the algorithm name of this KeyManagerFactory
object.
This is the same name that was specified in one of the getInstance
calls that created this KeyManagerFactory
object.
Return | |
---|---|
String! |
the algorithm name of this KeyManagerFactory object. |
getDefaultAlgorithm
static fun getDefaultAlgorithm(): String!
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 to the desired algorithm name.
Return | |
---|---|
String! |
the default algorithm name as specified by the ssl.KeyManagerFactory.algorithm security property, or an implementation-specific default if no such property exists. |
See Also
getInstance
static fun getInstance(algorithm: String!): KeyManagerFactory!
Returns a KeyManagerFactory
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 |
String!: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. |
Return | |
---|---|
KeyManagerFactory! |
the new KeyManagerFactory object. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
if no Provider supports a KeyManagerFactorySpi implementation for the specified algorithm. |
java.lang.NullPointerException |
if algorithm is null. |
See Also
getInstance
static fun getInstance(
algorithm: String!,
provider: String!
): KeyManagerFactory!
Returns a KeyManagerFactory
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 |
String!: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. |
provider |
String!: the name of the provider. |
Return | |
---|---|
KeyManagerFactory! |
the new KeyManagerFactory object. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified provider. |
java.security.NoSuchProviderException |
if the specified provider is not registered in the security provider list. |
java.lang.IllegalArgumentException |
if the provider name is null or empty. |
java.lang.NullPointerException |
if algorithm is null. |
See Also
getInstance
static fun getInstance(
algorithm: String!,
provider: Provider!
): KeyManagerFactory!
Returns a KeyManagerFactory
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 |
String!: the standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about standard algorithm names. |
provider |
Provider!: an instance of the provider. |
Return | |
---|---|
KeyManagerFactory! |
the new KeyManagerFactory object. |
Exceptions | |
---|---|
java.security.NoSuchAlgorithmException |
if a KeyManagerFactorySpi implementation for the specified algorithm is not available from the specified Provider object. |
java.lang.IllegalArgumentException |
if provider is null. |
java.lang.NullPointerException |
if algorithm is null. |
See Also
getKeyManagers
fun getKeyManagers(): Array<KeyManager!>!
Returns one key manager for each type of key material.
Return | |
---|---|
Array<KeyManager!>! |
the key managers |
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the KeyManagerFactory is not initialized |
getProvider
fun getProvider(): Provider!
Returns the provider of this KeyManagerFactory
object.
Return | |
---|---|
Provider! |
the provider of this KeyManagerFactory object |
init
fun init(
ks: KeyStore!,
password: CharArray!
): Unit
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(javax.net.ssl.ManagerFactoryParameters)
.
Parameters | |
---|---|
ks |
KeyStore!: the key store or null |
password |
CharArray!: the password for recovering keys in the KeyStore |
Exceptions | |
---|---|
java.security.KeyStoreException |
if this operation fails |
java.security.NoSuchAlgorithmException |
if the specified algorithm is not available from the specified provider. |
java.security.UnrecoverableKeyException |
if the key cannot be recovered (e.g. the given password is wrong). |
init
fun init(spec: ManagerFactoryParameters!): Unit
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 the ManagerFactoryParameters
implementation to obtain the needed information.
Parameters | |
---|---|
spec |
ManagerFactoryParameters!: an implementation of a provider-specific parameter specification |
Exceptions | |
---|---|
java.security.InvalidAlgorithmParameterException |
if an error is encountered |