java.security
クラス AlgorithmParameters

java.lang.Object
  java.security.AlgorithmParameters

public class AlgorithmParameters
extends Object

暗号化パラメータの不透明な表示として使用します。

特定のアルゴリズムのパラメータを管理するための AlgorithmParameters オブジェクトを取得するには、getInstance ファクトリメソッド (指定されたクラスのインスタンスを返す static メソッド) のどれかを呼び出します。

AlgorithmParameters オブジェクトを取得したら、適切なパラメータ仕様またはパラメータの符号化により、init を呼び出すことで初期化する必要があります。

透明なパラメータ仕様を AlgorithmParameters オブジェクトから取得するには、getParameterSpec を呼び出します。パラメータのバイト符号化を行うには、getEncoded を呼び出します。

導入されたバージョン:

1.2

関連項目:

AlgorithmParameterSpec, DSAParameterSpec, KeyPairGenerator

コンストラクタの概要

protected

AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm) AlgorithmParameters オブジェクトを作成します。

メソッドの概要

String	getAlgorithm() このパラメータオブジェクトに関連したアルゴリズムの名前を返します。
byte[]	getEncoded() 一次符号化形式でパラメータを返します。
byte[]	getEncoded(String format) 指定された方式で符号化されたパラメータを返します。
static AlgorithmParameters	getInstance(String algorithm) 指定されたアルゴリズムのパラメータオブジェクトを返します。
static AlgorithmParameters	getInstance(String algorithm, Provider provider) 指定されたアルゴリズムのパラメータオブジェクトを返します。
static AlgorithmParameters	getInstance(String algorithm, String provider) 指定されたアルゴリズムのパラメータオブジェクトを返します。
<T extends AlgorithmParameterSpec> T	getParameterSpec(Class<T> paramSpec) パラメータオブジェクトの透明な仕様を返します。
Provider	getProvider() パラメータオブジェクトのプロバイダを返します。
void	init(AlgorithmParameterSpec paramSpec) paramSpec に指定されたパラメータで、パラメータオブジェクトを初期化します。
void	init(byte[] params) 指定されたパラメータをインポートし、パラメータの一次復号化形式に従って復号化します。
void	init(byte[] params, String format) params からパラメータをインポートし、指定された復号化方式に従って復号化します。
String	toString() パラメータを説明する書式付き文字列を返します。

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

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

コンストラクタの詳細

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

指定されたアルゴリズムのパラメータオブジェクトを返します。

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

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

返されたパラメータオブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、init を呼び出すことで初期化する必要があります。

パラメータ:

algorithm - 要求するアルゴリズムの名前アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

戻り値:

新しいパラメータオブジェクト

例外:

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

関連項目:

Provider

getInstance

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

指定されたアルゴリズムのパラメータオブジェクトを返します。

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

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

返されたパラメータオブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、init を呼び出すことで初期化する必要があります。

パラメータ:

algorithm - 要求するアルゴリズムの名前アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

provider - プロバイダ名

戻り値:

新しいパラメータオブジェクト

例外:

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

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

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

関連項目:

Provider

getInstance

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

指定されたアルゴリズムのパラメータオブジェクトを返します。

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

返されたパラメータオブジェクトは、適切なパラメータ仕様またはパラメータの符号化により、init を呼び出すことで初期化する必要があります。

パラメータ:

algorithm - 要求するアルゴリズムの名前アルゴリズムの標準名については、「Java 暗号化アーキテクチャー API 仕様 & リファレンス」の付録 A を参照

provider - プロバイダ名

戻り値:

新しいパラメータオブジェクト

例外:

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

IllegalArgumentException - プロバイダが null の場合

導入されたバージョン:

1.4

関連項目:

Provider

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 クラスのインスタンスに返されることを示します。

パラメータ:

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()

パラメータを説明する書式付き文字列を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

パラメータを説明する書式付き文字列。このパラメータオブジェクトが初期化されていない場合は null