javax.net.ssl
クラス KeyManagerFactory

java.lang.Object
  |
  +--javax.net.ssl.KeyManagerFactory

public class KeyManagerFactory

extends Object

このクラスは、鍵データのソースに基づいて、鍵マネージャのファクトリとして機能します。各鍵マネージャは、セキュアソケットが使用する鍵データを管理します。鍵データは、キーストア、またはプロバイダ固有のソース、あるいはその両方に基づきます。

導入されたバージョン:

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() 鍵データの種類ごとに 1 つの鍵マネージャを返します。
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 オブジェクトを生成します。

要求された鍵管理アルゴリズムの実装をデフォルトのプロバイダパッケージが提供している場合は、その実装を含む KeyManagerFactory のインスタンスが返されます。デフォルトのプロバイダパッケージで目的のアルゴリズムが提供されていない場合には、他のプロバイダパッケージが検索されます。

パラメータ:

algorithm - 要求されたアルゴリズムの標準名

戻り値:

新しい KeyManagerFactory オブジェクト

例外:

NoSuchAlgorithmException - 指定されたアルゴリズムが、デフォルトのプロバイダパッケージにも、検索したほかのプロバイダパッケージにもない場合

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  String provider)
                                           throws NoSuchAlgorithmException,
                                                  NoSuchProviderException

指定されたプロバイダから、指定された鍵管理アルゴリズムの KeyManagerFactory オブジェクトを作成します。

パラメータ:

algorithm - 要求されたアルゴリズムの標準名

provider - プロバイダ名

戻り値:

新しい KeyManagerFactory オブジェクト

例外:

NoSuchAlgorithmException - 指定されたプロバイダに指定されたアルゴリズムがない場合

NoSuchProviderException - 指定されたプロバイダが設定されていない場合

IllegalArgumentException - プロバイダが指定されていない場合

getInstance

public static final KeyManagerFactory getInstance(String algorithm,
                                                  Provider provider)
                                           throws NoSuchAlgorithmException

指定されたプロバイダから、指定された鍵管理アルゴリズムの KeyManagerFactory オブジェクトを作成します。

パラメータ:

algorithm - 要求されたアルゴリズムの標準名

provider - プロバイダのインスタンス

戻り値:

新しい KeyManagerFactory オブジェクト

例外:

NoSuchAlgorithmException - 指定されたプロバイダに指定されたアルゴリズムがない場合

IllegalArgumentException - プロバイダが指定されていない場合

getProvider

public final Provider getProvider()

この KeyManagerFactory オブジェクトのプロバイダを返します。

戻り値:

この KeyManagerFactory オブジェクトのプロバイダ

init

public final void init(KeyStore ks,
                       char[] password)
                throws KeyStoreException,
                       NoSuchAlgorithmException,
                       UnrecoverableKeyException

鍵データのソースを使用してこのファクトリを初期化します。

多くの場合、プロバイダはキーストアを使用して、セキュアソケットのネゴシエーション中に使用する鍵データを取得します。キーストアは通常パスワードで保護されています。

より柔軟に初期化を行うには、init(ManagerFactoryParameters) を参照してください。

パラメータ:

ks - キーストアまたは null

password - キーストアの鍵を復元するためのパスワード

例外:

KeyStoreException - この処理が失敗した場合

NoSuchAlgorithmException - 指定されたプロバイダに指定されたアルゴリズムがない場合

UnrecoverableKeyException - 指定されたパスワードが間違っている場合など、鍵を復元できない場合

init

public final void init(ManagerFactoryParameters spec)
                throws InvalidAlgorithmParameterException

プロバイダ固有の鍵データのソースを使用して、このファクトリを初期化します。

一部のプロバイダでは、キーストアとパスワード以外に、初期化パラメータを必要とすることがあります。このようなプロバイダの場合は、プロバイダに定義された ManagerFactoryParameters 実装を渡す必要があります。プロバイダは、ManagerFactoryParameters 実装のメソッドを呼び出して、必要な情報を取得します。

パラメータ:

spec - プロバイダ固有のパラメータ仕様の実装

例外:

InvalidAlgorithmParameterException - エラーが発生した場合

getKeyManagers

public final KeyManager[] getKeyManagers()

鍵データの種類ごとに 1 つの鍵マネージャを返します。

戻り値:

鍵マネージャ