- 所有已知的子接口:
XMLSignContext,XMLValidateContext
- 所有已知的实现类:
DOMCryptoContext,DOMSignContext,DOMValidateContext
public interface XMLCryptoContext
包含 XML 加密操作的公共上下文信息。
此接口包含设置和检索影响 XML 签名或 XML 加密结构处理的属性的方法。
请注意,XMLCryptoContext 实例可以包含特定于它所使用的 XML 加密结构的信息和状态。如果 XMLCryptoContext 与多个结构一起使用,则结果不可预测(例如,您不应使用相同的 XMLValidateContext 实例来验证两个不同的 XMLSignature 对象)。
- 自从:
- 1.6
-
方法总结
修饰符和类型方法描述返回此上下文将指定键映射到的值。返回基本 URI。返回默认的命名空间前缀。返回用于查找键的键选择器。getNamespacePrefix(String namespaceURI, String defaultPrefix) 返回与指定命名空间 URI 关联的命名空间前缀。getProperty(String name) 返回指定属性的值。返回用于取消引用URIReference的URIDereferencer。在此上下文中将指定值与指定键相关联。putNamespacePrefix(String namespaceURI, String prefix) 将指定的命名空间 URI 映射到指定的前缀。voidsetBaseURI(String baseURI) 设置基本 URI。voidsetDefaultNamespacePrefix(String defaultPrefix) 设置默认命名空间前缀。void设置用于查找键的键选择器。setProperty(String name, Object value) 设置指定的属性。voidsetURIDereferencer(URIDereferencer dereferencer) 设置用于取消引用URIReference的URIDereferencer。
-
方法详情
-
getBaseURI
String getBaseURI()返回基本 URI。- 返回:
-
基本 URI,如果未指定,则为
null - 参见:
-
setBaseURI
设置基本 URI。- 参数:
baseURI- 基本 URI,或null以删除当前值- 抛出:
IllegalArgumentException- 如果baseURI不符合 RFC 2396- 参见:
-
getKeySelector
KeySelector getKeySelector()返回用于查找键的键选择器。- 返回:
-
键选择器,如果未指定则为
null - 参见:
-
setKeySelector
设置用于查找键的键选择器。- 参数:
ks- 键选择器,或null删除当前设置- 参见:
-
getURIDereferencer
URIDereferencer getURIDereferencer()返回用于取消引用URIReference的URIDereferencer。- 返回:
URIDereferencer或null如果未指定- 参见:
-
setURIDereferencer
- 参数:
dereferencer-URIDereferencer或null删除任何当前设置- 参见:
-
getNamespacePrefix
返回与指定命名空间 URI 关联的命名空间前缀。如果指定的命名空间 URI 尚未绑定到前缀,则返回指定的默认前缀。要将命名空间 URI 绑定到前缀,请调用putNamespacePrefix方法。- 参数:
namespaceURI- 命名空间 URIdefaultPrefix- 在指定的命名空间 URI 未绑定到前缀的情况下要返回的前缀。- 返回:
-
与指定命名空间 URI 相关联的前缀,如果 URI 未注册,则为
defaultPrefix。如果名称空间 URI 已注册但没有前缀,则返回一个空字符串 ("")。 - 抛出:
NullPointerException- 如果namespaceURI是null- 参见:
-
putNamespacePrefix
将指定的命名空间 URI 映射到指定的前缀。如果已经有与指定名称空间 URI 关联的前缀,则旧前缀将替换为指定前缀。- 参数:
namespaceURI- 命名空间 URIprefix- 命名空间前缀(或null以删除任何现有映射)。指定空字符串 ("") 不会将前缀绑定到名称空间 URI。- 返回:
-
与指定命名空间 URI 关联的先前前缀,如果没有则为
null - 抛出:
NullPointerException- 如果namespaceURI是null- 参见:
-
getDefaultNamespacePrefix
String getDefaultNamespacePrefix()返回默认的命名空间前缀。默认命名空间前缀是所有未由putNamespacePrefix方法显式设置的命名空间 URI 的前缀。- 返回:
-
默认命名空间前缀,如果未设置则为
null。 - 参见:
-
setDefaultNamespacePrefix
设置默认命名空间前缀。这会为putNamespacePrefix方法未明确设置的所有命名空间 URI 设置命名空间前缀。- 参数:
defaultPrefix- 默认命名空间前缀,或null删除当前设置。指定空字符串 ("") 以不绑定任何前缀。- 参见:
-
setProperty
设置指定的属性。- 参数:
name- 属性的名称value- 要设置的属性值- 返回:
-
指定属性的先前值,或者
null如果它没有值 - 抛出:
NullPointerException- 如果name是null- 参见:
-
getProperty
返回指定属性的值。- 参数:
name- 属性的名称- 返回:
-
指定属性的当前值,如果没有值则为
null - 抛出:
NullPointerException- 如果name是null- 参见:
-
get
返回此上下文将指定键映射到的值。更正式地说,如果此上下文包含从键
k到值v的映射,使得(key==null ? k==null : key.equals(k)),则此方法返回v;否则返回null。 (最多可以有一个这样的映射。)此方法可用于检索特定于此上下文所用的加密操作的任意信息。
- 参数:
key- 要返回其关联值的键- 返回:
-
此上下文将指定键映射到的值,如果键没有映射,则返回
null - 参见:
-
put
在此上下文中将指定值与指定键相关联。如果上下文先前包含此键的映射,则旧值将替换为指定值。此方法可用于存储特定于此上下文所用的加密操作的任意信息。
- 参数:
key- 与指定值关联的键value- 与指定键关联的值- 返回:
-
与该键相关联的先前值,或者
null如果没有该键的映射 - 抛出:
IllegalArgumentException- 如果此键或值的某些方面阻止它存储在此上下文中- 参见:
-