Module java.xml.crypto
Package javax.xml.crypto

Interface XMLCryptoContext

所有已知的子接口:
XMLSignContext, XMLValidateContext
所有已知的实现类:
DOMCryptoContext, DOMSignContext, DOMValidateContext
public interface XMLCryptoContext
包含XML加密操作的常见上下文信息。

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

请注意，XMLCryptoContext实例可能包含特定于其使用的XML加密结构的信息和状态。如果一个XMLCryptoContext与多个结构一起使用（例如，不应该使用相同的XMLValidateContext实例来验证两个不同的XMLSignature对象），则结果是不可预测的。

自1.6版本起:
1.6

  • Method Details

    • getBaseURI

      String getBaseURI()
      返回基本URI。
      返回:
      基本URI，如果未指定则返回null
      另请参阅:

    • setBaseURI

      void setBaseURI(String baseURI)
      设置基本URI。
      参数:
      baseURI - 基本URI，或null以删除当前值
      抛出:
      IllegalArgumentException - 如果baseURI不符合RFC 2396
      另请参阅:

    • getKeySelector

      KeySelector getKeySelector()
      返回用于查找密钥的密钥选择器。
      返回:
      密钥选择器，如果未指定则返回null
      另请参阅:

    • setKeySelector

      void setKeySelector(KeySelector ks)
      设置用于查找密钥的密钥选择器。
      参数:
      ks - 密钥选择器，或null以删除当前设置
      另请参阅:

    • getURIDereferencer

      URIDereferencer getURIDereferencer()
      返回用于解除引用URIReference的URIDereferencer。
      返回:
      URIDereferencer，如果未指定则返回null
      另请参阅:

    • setURIDereferencer

      void setURIDereferencer(URIDereferencer dereferencer)
      设置用于解除引用URIReference的URIDereferencer。指定的URIDereferencer将替代实现的默认URIDereferencer。
      参数:
      dereferencer - URIDereferencer，或null以删除任何当前设置
      另请参阅:

    • getNamespacePrefix

      String getNamespacePrefix(String namespaceURI, String defaultPrefix)
      返回指定命名空间URI关联的命名空间前缀。如果指定的命名空间URI尚未绑定到前缀，则返回指定的默认前缀。要将命名空间URI绑定到前缀，请调用putNamespacePrefix方法。
      参数:
      namespaceURI - 命名空间URI
      defaultPrefix - 在指定的命名空间URI尚未绑定到前缀时返回的前缀。
      返回:
      与指定命名空间URI关联的前缀，如果URI未注册则返回defaultPrefix。如果命名空间URI已注册但没有前缀，则返回空字符串（""）。
      抛出:
      NullPointerException - 如果namespaceURI为null
      另请参阅:

    • putNamespacePrefix

      String putNamespacePrefix(String namespaceURI, String prefix)
      将指定的命名空间URI映射到指定的前缀。如果已经有与指定的命名空间URI关联的前缀，则旧前缀将被指定的前缀替换。
      参数:
      namespaceURI - 命名空间URI
      prefix - 命名空间前缀（或null以删除任何现有映射）。指定空字符串（""）将不绑定前缀到命名空间URI。
      返回:
      与指定命名空间URI关联的先前前缀，如果没有则返回null
      抛出:
      NullPointerException - 如果namespaceURI为null
      另请参阅:

    • getDefaultNamespacePrefix

      String getDefaultNamespacePrefix()
      返回默认命名空间前缀。默认命名空间前缀是由putNamespacePrefix方法未明确设置的所有命名空间URI的前缀。
      返回:
      默认命名空间前缀，如果未设置则返回null。
      另请参阅:

    • setDefaultNamespacePrefix

      void setDefaultNamespacePrefix(String defaultPrefix)
      设置默认命名空间前缀。这将为由putNamespacePrefix方法未明确设置的所有命名空间URI设置命名空间前缀。
      参数:
      defaultPrefix - 默认命名空间前缀，或null以删除当前设置。指定空字符串（""）将不绑定前缀。
      另请参阅:

    • setProperty

      Object setProperty(String name, Object value)
      设置指定的属性。
      参数:
      name - 属性的名称
      value - 要设置的属性值
      返回:
      指定属性的先前值，如果没有值则返回null
      抛出:
      NullPointerException - 如果name为null
      另请参阅:

    • getProperty

      Object getProperty(String name)
      返回指定属性的值。
      参数:
      name - 属性的名称
      返回:
      指定属性的当前值，如果没有值则返回null
      抛出:
      NullPointerException - 如果name为null
      另请参阅:

    • get

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

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

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

      参数:
      key - 要返回其关联值的键
      返回:
      此上下文将指定键映射到的值，如果没有为该键映射则返回null
      另请参阅:

    • put

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

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

      参数:
      key - 要关联指定值的键
      value - 要与指定键关联的值
      返回值:
      与该键关联的先前值，如果该键没有映射，则返回null
      抛出:
      IllegalArgumentException - 如果键或值的某个方面阻止将其存储在此上下文中
      参见: