模块  java.xml.crypto
软件包  javax.xml.crypto

Interface XMLCryptoContext

  • All Known Subinterfaces:
    XMLSignContext ， XMLValidateContext
    所有已知实现类：
    DOMCryptoContext ， DOMSignContext ， DOMValidateContext 
    public interface XMLCryptoContext
    包含XML加密操作的公共上下文信息。

    此接口包含用于设置和检索影响XML签名或XML加密结构处理的属性的方法。

    请注意， XMLCryptoContext实例可以包含特定于其使用的XML加密结构的信息和状态。 如果XMLCryptoContext与多个结构XMLCryptoContext使用，则结果是不可预测的（例如，您不应使用相同的XMLValidateContext实例来验证两个不同的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()

      • setKeySelector

        void setKeySelector​(KeySelector ks)
        设置用于查找键的键选择器。
        参数
        ks - 键选择器，或 null以删除当前设置
        另请参见：
        getKeySelector()

      • setURIDereferencer

        void setURIDereferencer​(URIDereferencer dereferencer)
        设置URIDereferencer ，用于取消引用URIReference 。 指定的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关联的前一个前缀，如果没有， 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)

      • get

        Object get​(Object key)
        返回此上下文映射指定键的值。

        更正式地说，如果此上下文包含从密钥k到值v的映射，使得(key==null ? k==null : key.equals(k)) ，则此方法返回v ; 否则返回null 。 （最多可以有一个这样的映射。）

        此方法对于检索特定于此上下文所用的加密操作的任意信息非常有用。

        参数
        key - 要返回其关联值的密钥
        结果
        此上下文映射指定键的值，如果没有键的映射， null
        另请参见：
        put(Object, Object)

      • put

        Object put​(Object key,
           Object value)
        将指定值与此上下文中的指定键相关联。 如果上下文先前包含此键的映射，则旧值将替换为指定的值。

        此方法对于存储特定于此上下文所用的加密操作的任意信息非常有用。

        参数
        key - 与指定值关联的键
        value - 与指定密钥关联的值
        结果
        与密钥关联的先前值，如果没有密钥映射， null
        异常
        IllegalArgumentException - 如果此键或值的某些方面阻止它存储在此上下文中
        另请参见：
        get(Object)