java.security
クラス AlgorithmParameterGenerator

java.lang.Object
  java.security.AlgorithmParameterGenerator

public class AlgorithmParameterGenerator
extends Object

AlgorithmParameterGenerator クラスは、特定のアルゴリズムで使われるパラメータのセットを生成するために使用されます。パラメータジェネレータは、getInstance ファクトリメソッド (指定したクラスのインスタンスを返す static メソッド) を使って構築されます。

パラメータを生成するオブジェクトは、アルゴリズム独立型、またはアルゴリズム特定型の方法の 2 とおりの方法で初期化できます。

• アルゴリズム独立型の方法では、すべてのパラメータジェネレータが「サイズ」および乱数の発生源という概念を共有するという特性を利用します。サイズの単位は、すべてアルゴリズムパラメータで普遍的に共通していますが、その解釈はアルゴリズムにより異なります。たとえば、DSA アルゴリズムのパラメータの場合、「サイズ」はビットで表したプライムモジュラスのサイズに一致します。この方法を使用すると、アルゴリズム特定型のパラメータ生成値が (ある場合)、それらは指定したサイズから得られた値でない限り、デフォルトで標準値になります。

• もう 1 つの方法では、アルゴリズム特定型のセマンティクスを使って、パラメータジェネレータオブジェクトを初期化します。 これらのセマンティクスは、アルゴリズム特定型のパラメータ生成値のセットで表されます。たとえば、Diffie-Hellman システムパラメータを生成するには、通常、パラメータ生成値は、プライムモジュラスおよびランダム指数のサイズで構成されます。どちらのサイズもビット数で指定します。

クライアントが init メソッドの呼び出しで、明示的に AlgorithmParameterGenerator を初期化しない場合には、各プロバイダはデフォルトによる初期化を提供し、ドキュメント化する必要があります。たとえば Sun のプロバイダは、1,024 ビットのモジュラスプライムサイズをデフォルトとして DSA パラメータを生成します。

導入されたバージョン:

1.2

関連項目:

AlgorithmParameters, AlgorithmParameterSpec

コンストラクタの概要

protected

AlgorithmParameterGenerator(AlgorithmParameterGeneratorSpi paramGenSpi, Provider provider, String algorithm) AlgorithmParameterGenerator オブジェクトを作成します。

メソッドの概要

AlgorithmParameters	generateParameters() パラメータを生成します。
String	getAlgorithm() パラメータジェネレータに関連したアルゴリズムの標準名を返します。
static AlgorithmParameterGenerator	getInstance(String algorithm) 指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。
static AlgorithmParameterGenerator	getInstance(String algorithm, Provider provider) 指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。
static AlgorithmParameterGenerator	getInstance(String algorithm, String provider) 指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。
Provider	getProvider() アルゴリズムパラメータジェネレータオブジェクトのプロバイダを返します。
void	init(AlgorithmParameterSpec genParamSpec) アルゴリズム特定型のパラメータ生成値のセットで、パラメータジェネレータを初期化します。
void	init(AlgorithmParameterSpec genParamSpec, SecureRandom random) アルゴリズム特定型のパラメータ生成値のセットで、パラメータジェネレータを初期化します。
void	init(int size) 特定のサイズに対して、パラメータジェネレータを初期化します。
void	init(int size, SecureRandom random) 特定のサイズと乱数発生の元に対して、パラメータジェネレータを初期化します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AlgorithmParameterGenerator

protected AlgorithmParameterGenerator(AlgorithmParameterGeneratorSpi paramGenSpi,
                                      Provider provider,
                                      String algorithm)

AlgorithmParameterGenerator オブジェクトを作成します。

パラメータ:

paramGenSpi - 委譲先

provider - プロバイダ

algorithm - アルゴリズム

メソッドの詳細

getAlgorithm

public final String getAlgorithm()

パラメータジェネレータに関連したアルゴリズムの標準名を返します。

戻り値:

アルゴリズムの文字列名

getInstance

public static AlgorithmParameterGenerator getInstance(String algorithm)
                                               throws NoSuchAlgorithmException

指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。

このメソッドは、最優先の Provider から順に、登録済みのセキュリティー Provider のリストをトラバースします。指定されたアルゴリズムをサポートする最初の Provider の AlgorithmParameterGeneratorSpi 実装をカプセル化する新しい AlgorithmParameterGenerator オブジェクトが返されます。

登録済みプロバイダのリストは、Security.getProviders() メソッド経由で取得できます。

パラメータ:

algorithm - このパラメータジェネレータに関連付けられたアルゴリズムの名前。アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

戻り値:

新しい AlgorithmParameterGenerator オブジェクト

例外:

NoSuchAlgorithmException - 指定されたアルゴリズムの AlgorithmParameterGeneratorSpi 実装をサポートする Provider が存在しない場合

関連項目:

Provider

getInstance

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

指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。

指定されたプロバイダの AlgorithmParameterGeneratorSpi 実装をカプセル化する新しい AlgorithmParameterGenerator オブジェクトが返されます。指定したプロバイダは、セキュリティープロバイダリストに登録する必要があります。

登録済みプロバイダのリストは、Security.getProviders() メソッド経由で取得できます。

パラメータ:

algorithm - このパラメータジェネレータに関連付けられたアルゴリズムの名前。アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

provider - Provider の文字列名

戻り値:

新しい AlgorithmParameterGenerator オブジェクト

例外:

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

NoSuchProviderException - 指定されたプロバイダがセキュリティープロバイダリストに登録されていない場合

IllegalArgumentException - プロバイダの名前が null か空の場合

関連項目:

Provider

getInstance

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

指定されたアルゴリズムで使用されるパラメータのセットを生成する、AlgorithmParameterGenerator オブジェクトを返します。

指定された Provider オブジェクトの AlgorithmParameterGeneratorSpi 実装をカプセル化する新しい AlgorithmParameterGenerator オブジェクトが返されます。指定された Provider オブジェクトは、プロバイダリストに登録する必要はありません。

パラメータ:

algorithm - このパラメータジェネレータに関連付けられたアルゴリズムの文字列名。アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

provider - Provider オブジェクト

戻り値:

新しい AlgorithmParameterGenerator オブジェクト

例外:

NoSuchAlgorithmException - 指定された Provider オブジェクトに指定されたアルゴリズムの AlgorithmParameterGeneratorSpi 実装がない場合

IllegalArgumentException - 指定されたプロバイダが null の場合

導入されたバージョン:

1.4

関連項目:

Provider

getProvider

public final Provider getProvider()

アルゴリズムパラメータジェネレータオブジェクトのプロバイダを返します。

戻り値:

このアルゴリズムパラメータジェネレータオブジェクトのプロバイダ

init

public final void init(int size)

特定のサイズに対して、パラメータジェネレータを初期化します。パラメータを生成する際には、インストールされているプロバイダのうち、もっとも優先順位の高いプロバイダの SecureRandom の実装が、乱数発生の元として使用されます。SecureRandom を提供するプロバイダが 1 つもインストールされていない場合は、システムが提供する乱数発生の元が使用されます。

パラメータ:

size - サイズ (ビット数)

init

public final void init(int size,
                       SecureRandom random)

特定のサイズと乱数発生の元に対して、パラメータジェネレータを初期化します。

パラメータ:

size - サイズ (ビット数)

random - 乱数発生の元

init

public final void init(AlgorithmParameterSpec genParamSpec)
                throws InvalidAlgorithmParameterException

アルゴリズム特定型のパラメータ生成値のセットで、パラメータジェネレータを初期化します。パラメータを生成する際には、インストールされているプロバイダのうち、もっとも優先順位の高いプロバイダの SecureRandom の実装が、乱数発生の元として使用されます。SecureRandom を提供するプロバイダが 1 つもインストールされていない場合は、システムが提供する乱数発生の元が使用されます。

パラメータ:

genParamSpec - アルゴリズム特定型のパラメータ生成値のセット

例外:

InvalidAlgorithmParameterException - 指定されたパラメータ生成値がこのパラメータジェネレータに不適切な場合

init

public final void init(AlgorithmParameterSpec genParamSpec,
                       SecureRandom random)
                throws InvalidAlgorithmParameterException

アルゴリズム特定型のパラメータ生成値のセットで、パラメータジェネレータを初期化します。

パラメータ:

genParamSpec - アルゴリズム特定型のパラメータ生成値のセット

random - 乱数発生の元

例外:

InvalidAlgorithmParameterException - 指定されたパラメータ生成値がこのパラメータジェネレータに不適切な場合

generateParameters

public final AlgorithmParameters generateParameters()

パラメータを生成します。

戻り値:

新しい AlgorithmParameters オブジェクト