javax.net.ssl

接口
异常
java.lang.Object
  继承者 javax.net.ssl.KeyManagerFactory

public class KeyManagerFactory
     
extends Object

此类充当基于密钥内容源的密钥管理器的工厂。每个密钥管理器管理特定类型的、由安全套接字所使用的密钥内容。密钥内容是基于 KeyStore 和/或提供者特定的源。

从以下版本开始:
1.4
另请参见:
KeyManager

构造方法摘要
protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
          创建 KeyManagerFactory 对象。
 
方法摘要
 String getAlgorithm()
          返回此 KeyManagerFactory 对象的算法名称。
static String getDefaultAlgorithm()
          获取默认的 KeyManagerFactory 算法名称。
static KeyManagerFactory getInstance(String algorithm)
          返回充当密钥管理器工厂的 KeyManagerFactory 对象。
static KeyManagerFactory getInstance(String algorithm, Provider provider)
          返回充当密钥管理器工厂的 KeyManagerFactory 对象。
static KeyManagerFactory getInstance(String algorithm, String provider)
          返回充当密钥管理器工厂的 KeyManagerFactory 对象。
 KeyManager[] getKeyManagers()
          为每类密钥内容返回一个密钥管理器。
 Provider getProvider()
          返回此 KeyManagerFactory 对象的提供者。
 void init(KeyStore ks, char[] password)
          使用密钥内容源初始化此工厂。
 void init(ManagerFactoryParameters spec)
          使用特定于提供者的密钥内容源初始化此工厂。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

KeyManagerFactory

protected KeyManagerFactory(KeyManagerFactorySpi factorySpi,
                            Provider provider,
                            String algorithm)
创建 KeyManagerFactory 对象。

参数:
factorySpi - 委托
provider - 提供者
algorithm - 算法
方法详细信息

getDefaultAlgorithm

public static final String getDefaultAlgorithm()
获取默认的 KeyManagerFactory 算法名称。

默认的算法可以在运行时改变,方法是通过把 "ssl.KeyManagerFactory.algorithm" 安全属性(在 Java 安全属性文件或通过调用 Security.setProperty(java.lang.String, java.lang.String) 来设置)的值设置为所需的算法名称。

返回:
在 Java 安全属性中指定的默认算法名称;如果不存在这种属性,则返回一个特定于实现的默认值。
另请参见:
Security.setProperty(java.lang.String, java.lang.String)

getAlgorithm

public final String getAlgorithm()
返回此 KeyManagerFactory 对象的算法名称。

这与创建此 KeyManagerFactory 对象的某个 getInstance 调用中所指定的名称相同。

返回:
KeyManagerFactory 对象的算法名称。

getInstance

public static final KeyManagerFactory getInstance(String algorithm)
                                           throws NoSuchAlgorithmException
返回充当密钥管理器工厂的 KeyManagerFactory 对象。

此方法从首选 Provider 开始遍历已注册安全提供者列表。返回一个封装 KeyManagerFactorySpi 实现的新 KeyManagerFactory 对象,该实现取自支持指定算法的第一个 Provider。

注意,可以通过 Security.getProviders() 方法获取已注册提供者列表。

参数:
algorithm - 所请求算法的标准名称。有关标准算法名称的信息,请参阅 Java Secure Socket Extension Reference Guide
返回:
新的 KeyManagerFactory 对象。
抛出:
NoSuchAlgorithmException - 如果没有 Provider 支持指定算法的 KeyManagerFactorySpi 实现。
另请参见:
Provider

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  String provider)
                                           throws NoSuchAlgorithmException,
                                                  NoSuchProviderException
返回充当密钥管理器工厂的 KeyManagerFactory 对象。

返回一个封装 KeyManagerFactorySpi 实现的新 KeyManagerFactory 对象,该实现取自指定的提供者。指定的提供者必须在安全提供者列表中注册。

注意,可以通过 Security.getProviders() 方法获取已注册提供者列表。

参数:
algorithm - 所请求算法的标准名称。有关标准算法名称的信息,请参阅 Java Secure Socket Extension Reference Guide
provider - 提供者的名称。
返回:
新的 KeyManagerFactory 对象。
抛出:
NoSuchAlgorithmException - 如果不能从指定提供者获得指定算法的 KeyManagerFactorySpi 实现。
NoSuchProviderException - 如果指定提供者未在安全提供者列表中注册。
IllegalArgumentException - 如果提供者的名称为 null 或空。
另请参见:
Provider

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  Provider provider)
                                           throws NoSuchAlgorithmException
返回充当密钥管理器工厂的 KeyManagerFactory 对象。

返回一个封装 KeyManagerFactorySpi 实现的新 KeyManagerFactory 对象,该实现取自指定的 Provider 对象。注意,指定的 Provider 对象无需在提供者列表中注册。

参数:
algorithm - 所请求算法的标准名称。有关标准算法名称的信息,请参阅 Java Secure Socket Extension Reference Guide
provider - 提供者的实例。
返回:
新的 KeyManagerFactory 对象。
抛出:
NoSuchAlgorithmException - 不能从指定 Provider 对象获得指定算法的 KeyManagerFactorySpi 实现。
IllegalArgumentException - 如果 provider 为 null。
另请参见:
Provider

getProvider

public final Provider getProvider()
返回此 KeyManagerFactory 对象的提供者。

返回:
KeyManagerFactory 对象的提供者

init

public final void init(KeyStore ks,
                       char[] password)
                throws KeyStoreException,
                       NoSuchAlgorithmException,
                       UnrecoverableKeyException
使用密钥内容源初始化此工厂。

提供者通常使用 KeyStore 来获取在安全套接字协商期间所使用的密钥内容。KeyStore 通常是受密码保护的。

有关更多灵活初始化的信息,请参见 init(ManagerFactoryParameters)

参数:
ks - KeyStore 或 null
password - 用来恢复 KeyStore 中密钥的密码
抛出:
KeyStoreException - 如果此操作失败
NoSuchAlgorithmException - 如果指定的提供者中的指定算法不可用。
UnrecoverableKeyException - 如果不能恢复密钥(例如给定的 password 是错误的)。

init

public final void init(ManagerFactoryParameters spec)
                throws InvalidAlgorithmParameterException
使用特定于提供者的密钥内容源初始化此工厂。

在某些情况下,提供者可能需要除 keystore 和密码以外的其他初始化参数。期望由该特定提供者的用户传递由提供者定义的适当 ManagerFactoryParameters 实现。然后提供者可以调用 ManagerFactoryParameters 实现中指定的方法来获取所需的信息。

参数:
spec - 特定于提供者的参数规范实现
抛出:
InvalidAlgorithmParameterException - 如果遇到了错误

getKeyManagers

public final KeyManager[] getKeyManagers()
为每类密钥内容返回一个密钥管理器。

返回:
密钥管理器
抛出:
IllegalStateException - 如果 KeyManagerFactory 未初始化