モジュール java.xml.crypto
パッケージ javax.xml.crypto

インタフェースXMLCryptoContext

  • 既知のすべてのサブインタフェース:
    XMLSignContext, XMLValidateContext
    既知のすべての実装クラス:
    DOMCryptoContext, DOMSignContext, DOMValidateContext
    public interface XMLCryptoContext
    XML暗号化処理についての共通コンテキスト情報を格納します。

    このインタフェースには、XML署名またはXML暗号化された構造の処理に影響するプロパティを、設定または取得するためのメソッドが格納されます。

    XMLCryptoContextインスタンスには、ともに使用されるXML暗号化構造に固有の情報および状態を格納できます。 XMLCryptoContextが複数の構造とともに使用された場合、予想外の結果となります。たとえば、同じXMLValidateContextインスタンスを使用して2つの異なるXMLSignatureオブジェクトを検証しないでください。

    導入されたバージョン:
    1.6

    • メソッドの詳細

      • getBaseURI

        String getBaseURI()
        ベースURIを返します。
        戻り値:
        ベースURI。または指定されない場合はnull
        関連項目:
        setBaseURI(String)

      • setBaseURI

        void setBaseURI​(String baseURI)
        ベースURIを設定します。
        パラメータ:
        baseURI - ベースURI。現在の値を削除する場合はnull
        例外:
        IllegalArgumentException - baseURIがRFC 2396に準拠していない場合
        関連項目:
        getBaseURI()

      • getKeySelector

        KeySelector getKeySelector()
        キーの検索用のキー・セレクタを返します。
        戻り値:
        キー・セレクタ。指定されていない場合はnull
        関連項目:
        setKeySelector(KeySelector)

      • setKeySelector

        void setKeySelector​(KeySelector ks)
        キーの検索用のキー・セレクタを設定します。
        パラメータ:
        ks - キー・セレクタ。現在の設定を削除する場合はnull
        関連項目:
        getKeySelector()

      • setURIDereferencer

        void setURIDereferencer​(URIDereferencer dereferencer)
        URIReferenceの間接参照に使用されるURIDereferencerを設定します。 指定したURIDereferencerは、実装のデフォルトURIDereferencerの代わりに使用されます。
        パラメータ:
        dereferencer - URIDereferencer。現在の設定を削除する場合はnull
        関連項目:
        getURIDereferencer()

      • getNamespacePrefix

        String getNamespacePrefix​(String namespaceURI,
                          String defaultPrefix)
        指定した名前空間URIが関連付けられる名前空間接頭辞を返します。 指定した名前空間URIが接頭辞にバインドされていない場合、指定したデフォルトの接頭辞を返します。 名前空間URIを接頭辞にバインドするには、putNamespacePrefixメソッドを呼び出します。
        パラメータ:
        namespaceURI - 名前空間URI
        defaultPrefix - 指定した名前空間URIが接頭辞にバインドされていない場合に返される接頭辞。
        戻り値:
        指定した名前空間URIに関連付けられた接頭辞。URIが登録されていない場合はdefaultPrefix。 名前空間URIは登録されているが、接頭辞がない場合は、空の文字列("")が返される。
        例外:
        NullPointerException - namespaceURIがnullである場合
        関連項目:
        putNamespacePrefix(String, String)

      • putNamespacePrefix

        String putNamespacePrefix​(String namespaceURI,
                          String prefix)
        指定した名前空間URIを指定した接頭辞にマッピングします。 指定した名前空間URIと関連付けられた接頭辞がすでに存在する場合、古い接頭辞は指定された接頭辞に置き換えられます。
        パラメータ:
        namespaceURI - 名前空間URI
        prefix - 名前空間接頭辞。既存のマッピングを削除する場合はnull。 空の文字列("")を指定すると、接頭辞は名前空間URIにバインドされない。
        戻り値:
        指定した名前空間URIに関連付けられた以前の接頭辞。1つもない場合はnull
        例外:
        NullPointerException - namespaceURIがnullである場合
        関連項目:
        getNamespacePrefix(String, String)

      • getDefaultNamespacePrefix

        String getDefaultNamespacePrefix()
        デフォルトの名前空間接頭辞を返します。 デフォルトの名前空間接頭辞は、putNamespacePrefixメソッドによって明示的に設定されていない、すべての名前空間URI用の接頭辞です。
        戻り値:
        デフォルトの名前空間接頭辞。設定されたものがない場合はnull。
        関連項目:
        setDefaultNamespacePrefix(String)

      • setDefaultNamespacePrefix

        void setDefaultNamespacePrefix​(String defaultPrefix)
        デフォルトの名前空間接頭辞を設定します。 これは、putNamespacePrefixメソッドによって明示的に設定されていない、すべての名前空間URI用の名前空間接頭辞を設定します。
        パラメータ:
        defaultPrefix - デフォルトの名前空間接頭辞。現在の設定を削除する場合はnull。 接頭辞をバインドしない場合は空の文字列("")を指定する。
        関連項目:
        getDefaultNamespacePrefix()

      • setProperty

        Object setProperty​(String name,
                   Object value)
        指定したプロパティを設定します。
        パラメータ:
        name - プロパティの名前
        value - 設定するプロパティの値
        戻り値:
        指定されたプロパティの以前の値。値がなかった場合はnull
        例外:
        NullPointerException - nameがnullである場合
        関連項目:
        getProperty(String)

      • getProperty

        Object getProperty​(String name)
        指定されたプロパティの値を返します。
        パラメータ:
        name - プロパティの名前
        戻り値:
        指定されたプロパティの現在の値。値がない場合はnull
        例外:
        NullPointerException - nameがnullである場合
        関連項目:
        setProperty(String, Object)

      • get

        Object get​(Object key)
        このコンテキストで、指定されたキーがマップされる値を返します。

        つまり、このメソッドは、(key==null ? k==null : key.equals(k))となるキーkから値vへのマッピングがこのコンテキストに含まれている場合はvを返し、それ以外の場合はnullを返します。 (このようなマッピングは1つのみ存在できます。)

        このメソッドは、このコンテキストが使用される暗号化処理に固有である、任意の情報を取得するのに便利です。

        パラメータ:
        key - 関連付けられた値が返されるキー
        戻り値:
        このコンテキストで、指定されたキーがマップされる値。このキーに対するマッピングがない場合はnull
        関連項目:
        put(Object, Object)

      • put

        Object put​(Object key,
           Object value)
        このコンテキストで、指定された値を指定されたキーに関連付けます。 コンテキストにすでにこのキーに対するマッピングがある場合、古い値は指定された値に置き換えられます。

        このメソッドは、このコンテキストが使用される暗号化処理に固有である、任意の情報を格納するのに便利です。

        パラメータ:
        key - 指定される値が関連付けられるキー
        value - 指定されたキーに関連付けられる値
        戻り値:
        キーに関連付けられた以前の値。このキーに対するマッピングがなかった場合はnull
        例外:
        IllegalArgumentException - このキーまたは値のなんらかの特性が原因で、このコンテキストに格納できない場合
        関連項目:
        get(Object)