モジュール java.xml.crypto
パッケージ 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である場合