javax.xml.crypto

クラス KeySelector

java.lang.Object

javax.xml.crypto.KeySelector

public abstract class KeySelector
extends Object

KeyInfo オブジェクトに格納されるデータを使用して、鍵を検索して返すセレクタです。このクラスの実装の例は、KeyInfo に格納される情報に一致する信頼できる鍵で KeyStore を検索する場合です。

返された鍵が信頼できるかどうか、およびその検出にメカニズムが使用されるかどうかは、実装に固有となります。

導入されたバージョン:

1.6

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
static class	KeySelector.Purpose 選択される鍵の目的です。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	KeySelector() デフォルトは引数のないコンストラクタで、サブクラスによる呼び出しのみを想定しています。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract KeySelectorResult	select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) 指定された制約を満たす鍵の検索を試みます。
static KeySelector	singletonKeySelector(Key key) 渡される KeyInfo に関係なく、常に指定した鍵を選択する KeySelector を返します。

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

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

コンストラクタの詳細

KeySelector

protected KeySelector()

デフォルトは引数のないコンストラクタで、サブクラスによる呼び出しのみを想定しています。

メソッドの詳細

select

public abstract KeySelectorResult select(KeyInfo keyInfo,
                       KeySelector.Purpose purpose,
                       AlgorithmMethod method,
                       XMLCryptoContext context)
                                  throws KeySelectorException

指定された制約を満たす鍵の検索を試みます。

パラメータ:

keyInfo - KeyInfo (null も可能)

purpose - 鍵の目的 (KeySelector.Purpose.SIGN、KeySelector.Purpose.VERIFY、KeySelector.Purpose.ENCRYPT、または KeySelector.Purpose.DECRYPT)

method - この鍵が使用される対象のアルゴリズムメソッド。アルゴリズムと互換性があり、指定したアルゴリズムの制約を満たす鍵だけが返される。

context - 適切な鍵の検索に役立つ情報が含まれている場合のある XMLCryptoContext。この鍵セレクタが RetrievalMethod 型の解決をサポートしている場合は、コンテキストの baseURI および dereferencer パラメータ (指定されている場合) を使って URI の解決と間接参照が行われる。

戻り値:

鍵セレクタの結果

例外:

KeySelectorException - 鍵の検索を試みている途中で例外的な状況が発生した場合。鍵を検索できないことが例外であると見なされることはない (その場合は null が返される)。ただし、KeySelector が可能性のある鍵を検索できなくなるエラー状況 (ネットワーク通信障害など) は例外と見なされる。

ClassCastException - method のデータ型がこの鍵セレクタによってサポートされていない場合

singletonKeySelector

public static KeySelector singletonKeySelector(Key key)

渡される KeyInfo に関係なく、常に指定した鍵を選択する KeySelector を返します。

パラメータ:

key - 鍵セレクタに格納される唯一の鍵

戻り値:

常に指定した鍵を選択する鍵セレクタ

例外:

NullPointerException - key が null である場合