特定のアルゴリズムのパラメータを管理するためのAlgorithmParameters
オブジェクトを取得するには、getInstance
ファクトリ・メソッド(指定されたクラスのインスタンスを返すstaticメソッド)のどれかを呼び出します。
AlgorithmParameters
オブジェクトを取得したら、適切なパラメータ仕様またはパラメータの符号化により、init
を呼び出すことで初期化する必要があります。
透明なパラメータ仕様をAlgorithmParameters
オブジェクトから取得するには、getParameterSpec
を呼び出します。パラメータのバイト符号化を行うには、getEncoded
を呼び出します。
Javaプラットフォームの実装は、すべて次の標準のAlgorithmParameters
アルゴリズムをサポートする必要があります。
AES
DESede
DiffieHellman
DSA
- 導入されたバージョン:
- 1.2
- 関連項目:
-
コンストラクタのサマリー
修飾子コンストラクタ説明protected
AlgorithmParameters
(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm) AlgorithmParameters
オブジェクトを作成します。 -
メソッドのサマリー
修飾子と型メソッド説明final String
このパラメータ・オブジェクトに関連したアルゴリズムの名前を返します。final byte[]
一次符号化形式でパラメータを返します。final byte[]
getEncoded
(String format) 指定された方式で符号化されたパラメータを返します。static AlgorithmParameters
getInstance
(String algorithm) 指定されたアルゴリズムのパラメータ・オブジェクトを返します。static AlgorithmParameters
getInstance
(String algorithm, String provider) 指定されたアルゴリズムのパラメータ・オブジェクトを返します。static AlgorithmParameters
getInstance
(String algorithm, Provider provider) 指定されたアルゴリズムのパラメータ・オブジェクトを返します。final <T extends AlgorithmParameterSpec>
TgetParameterSpec
(Class<T> paramSpec) パラメータ・オブジェクトの透明な仕様を返します。final Provider
パラメータ・オブジェクトのプロバイダを返します。final void
init
(byte[] params) 指定されたパラメータをインポートし、パラメータの一次復号化形式に従って復号化します。final void
params
からパラメータをインポートし、指定された復号化方式に従って復号化します。final void
init
(AlgorithmParameterSpec paramSpec) paramSpec
に指定されたパラメータで、このパラメータ・オブジェクトを初期化します。final String
toString()
パラメータを説明する書式付き文字列を返します。
-
コンストラクタの詳細
-
AlgorithmParameters
protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm) AlgorithmParameters
オブジェクトを作成します。- パラメータ:
paramSpi
- 委譲先provider
- プロバイダalgorithm
- アルゴリズム
-
-
メソッドの詳細
-
getAlgorithm
public final String getAlgorithm()このパラメータ・オブジェクトに関連したアルゴリズムの名前を返します。- 戻り値:
- アルゴリズム名
-
getInstance
public static AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException 指定されたアルゴリズムのパラメータ・オブジェクトを返します。このメソッドは、最も優先されるプロバイダから始まる登録済セキュリティ・プロバイダのリストを横断します。 指定されたアルゴリズムをサポートする最初のプロバイダから
AlgorithmParametersSpi
実装をカプセル化する新しいAlgorithmParameters
オブジェクトが返されます。登録済みプロバイダのリストは、
Security.getProviders()
メソッド経由で取得できます。返されたパラメータ・オブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、
init
を呼び出すことで初期化する必要があります。- 実装上のノート:
- JDKリファレンス実装では、
jdk.security.provider.preferred
Security
プロパティを使用して、指定されたアルゴリズムの優先プロバイダの順序を決定します。 これは、Security.getProviders()
によって返されるプロバイダの順序とは異なる場合があります。 - パラメータ:
algorithm
- 要求するアルゴリズムの名前。 標準アルゴリズム名については、「Javaセキュリティ標準アルゴリズム名指定」のAlgorithmParametersセクションを参照してください。- 戻り値:
- 新しいパラメータ・オブジェクト
- 例外:
NoSuchAlgorithmException
-Provider
が、指定されたアルゴリズムのAlgorithmParametersSpi
実装をサポートしていない場合NullPointerException
-algorithm
がnull
である場合- 関連項目:
-
getInstance
public static AlgorithmParameters getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException 指定されたアルゴリズムのパラメータ・オブジェクトを返します。指定したプロバイダから
AlgorithmParametersSpi
実装をカプセル化する新しいAlgorithmParameters
オブジェクトが返されます。 指定したプロバイダは、セキュリティ・プロバイダ・リストに登録する必要があります。登録済みプロバイダのリストは、
Security.getProviders()
メソッド経由で取得できます。返されたパラメータ・オブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、
init
を呼び出すことで初期化する必要があります。- パラメータ:
algorithm
- 要求するアルゴリズムの名前。 標準アルゴリズム名については、「Javaセキュリティ標準アルゴリズム名指定」のAlgorithmParametersセクションを参照してください。provider
- プロバイダ名。- 戻り値:
- 新しいパラメータ・オブジェクト
- 例外:
IllegalArgumentException
- プロバイダ名がnull
または空の場合NoSuchAlgorithmException
- 指定されたアルゴリズムのAlgorithmParametersSpi
実装が、指定されたプロバイダから利用可能でない場合NoSuchProviderException
- 指定されたプロバイダがセキュリティ・プロバイダ・リストに登録されていない場合NullPointerException
-algorithm
がnull
である場合- 関連項目:
-
getInstance
public static AlgorithmParameters getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException 指定されたアルゴリズムのパラメータ・オブジェクトを返します。指定したプロバイダから
AlgorithmParametersSpi
実装をカプセル化する新しいAlgorithmParameters
オブジェクトが返されます。 指定されたプロバイダをプロバイダ・リストに登録する必要はありません。返されたパラメータ・オブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、
init
を呼び出すことで初期化する必要があります。- パラメータ:
algorithm
- 要求するアルゴリズムの名前。 標準アルゴリズム名については、「Javaセキュリティ標準アルゴリズム名指定」のAlgorithmParametersセクションを参照してください。provider
- プロバイダ名。- 戻り値:
- 新しいパラメータ・オブジェクト
- 例外:
IllegalArgumentException
- プロバイダがnull
の場合NoSuchAlgorithmException
- 指定されたアルゴリズムのAlgorithmParameterGeneratorSpi
実装が、指定されたProvider
オブジェクトから使用できない場合NullPointerException
-algorithm
がnull
である場合- 導入されたバージョン:
- 1.4
- 関連項目:
-
getProvider
public final Provider getProvider()パラメータ・オブジェクトのプロバイダを返します。- 戻り値:
- このパラメータ・オブジェクトのプロバイダ。
-
init
public final void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException paramSpec
に指定されたパラメータで、このパラメータ・オブジェクトを初期化します。- パラメータ:
paramSpec
- パラメータ仕様。- 例外:
InvalidParameterSpecException
- 指定されたパラメータ仕様がこのパラメータ・オブジェクトの初期化に不適切な場合、またはこのパラメータ・オブジェクトがすでに初期化されている場合。
-
init
public final void init(byte[] params) throws IOException 指定されたパラメータをインポートし、パラメータの一次復号化形式に従って復号化します。 これらのパラメータのASN.1仕様がある場合には、パラメータの一次復号化形式はASN.1です。- パラメータ:
params
- 符号化されたパラメータ。- 例外:
IOException
- 復号化エラーが発生した場合、またはこのパラメータ・オブジェクトがすでに初期化されている場合。
-
init
public final void init(byte[] params, String format) throws IOException params
からパラメータをインポートし、指定された復号化方式に従って復号化します。format
がnull
の場合、パラメータのプライマリ・デコード形式が使用されます。 これらのパラメータのASN.1仕様がある場合には、一次復号化形式はASN.1です。- パラメータ:
params
- 符号化されたパラメータ。format
- 復号化方式の名前。- 例外:
IOException
- 復号化エラーが発生した場合、またはこのパラメータ・オブジェクトがすでに初期化されている場合。
-
getParameterSpec
public final <T extends AlgorithmParameterSpec> T getParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException パラメータ・オブジェクトの透明な仕様を返します。paramSpec
は、パラメータが返されるべき仕様クラスを識別します。 たとえば、DSAParameterSpec.class
の場合には、パラメータがDSAParameterSpec
クラスのインスタンスに返されることを示します。- 型パラメータ:
T
- 返されるパラメータ仕様の型- パラメータ:
paramSpec
- パラメータが返される仕様クラス。- 戻り値:
- パラメータ仕様。
- 例外:
InvalidParameterSpecException
- 要求されたパラメータ仕様がこのパラメータ・オブジェクトに不適切な場合、またはこのパラメータ・オブジェクトが初期化されていない場合。
-
getEncoded
public final byte[] getEncoded() throws IOException一次符号化形式でパラメータを返します。 この種のパラメータのASN.1仕様が存在する場合は、プライマリ復号化形式は、ASN.1です。- 戻り値:
- パラメータの一次符号化方式で符号化されたパラメータ。
- 例外:
IOException
- 符号化エラーが発生した場合、またはこのパラメータ・オブジェクトが初期化されていない場合。
-
getEncoded
public final byte[] getEncoded(String format) throws IOException 指定された方式で符号化されたパラメータを返します。format
がnull
の場合、パラメータのプライマリ・エンコーディング形式が使用されます。 これらのパラメータのASN.1仕様がある場合には、一次符号化形式はASN.1です。- パラメータ:
format
- 符号化形式の名前。- 戻り値:
- 指定された符号化方式で符号化されたパラメータ。
- 例外:
IOException
- 符号化エラーが発生した場合、またはこのパラメータ・オブジェクトが初期化されていない場合。
-
toString
public final String toString()パラメータを説明する書式付き文字列を返します。
-