compact3

javax.xml.crypto

Interface XMLCryptoContext

All Known Subinterfaces:

XMLSignContext ， XMLValidateContext

所有已知实现类：

DOMCryptoContext ， DOMSignContext ， DOMValidateContext

public interface XMLCryptoContext

包含XML加密操作的常见上下文信息。

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

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

从以下版本开始：

1.6

方法摘要

Modifier and Type	Method and Description
Object	get(Object key) 返回此上下文映射指定键的值。
String	getBaseURI() 返回基本URI。
String	getDefaultNamespacePrefix() 返回默认名称空间前缀。
KeySelector	getKeySelector() 返回用于查找密钥的密钥选择器。
String	getNamespacePrefix(String namespaceURI, String defaultPrefix) 返回指定的命名空间URI与之关联的命名空间前缀。
Object	getProperty(String name) 返回指定属性的值。
URIDereferencer	getURIDereferencer() 返回一个URIDereferencer ，用于取消引用URIReference s。
Object	put(Object key, Object value) 将指定的值与此上下文中的指定关键字相关联。
String	putNamespacePrefix(String namespaceURI, String prefix) 将指定的命名空间URI映射到指定的前缀。
void	setBaseURI(String baseURI) 设置基本URI。
void	setDefaultNamespacePrefix(String defaultPrefix) 设置默认名称空间前缀。
void	setKeySelector(KeySelector ks) 设置用于查找键的键选择器。
Object	setProperty(String name, Object value) 设置指定的属性。
void	setURIDereferencer(URIDereferencer dereferencer) 设置一个URIDereferencer ，用于取消引用URIReference s。

方法详细信息

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()

getURIDereferencer

URIDereferencer getURIDereferencer()

返回一个URIDereferencer用于取消引用URIReference s。

结果

URIDereferencer或 null如果没有指定

另请参见：

setURIDereferencer(URIDereferencer)

setURIDereferencer

void setURIDereferencer(URIDereferencer dereferencer)

设置一个URIDereferencer用于取消引用URIReference s。 使用指定的URIDereferencer代替实现的默认值URIDereferencer 。

参数

dereferencer - URIDereferencer或 null删除任何当前设置

另请参见：

getURIDereferencer()

getNamespacePrefix

String getNamespacePrefix(String namespaceURI,
                          String defaultPrefix)

返回指定的命名空间URI与之关联的命名空间前缀。 如果指定的命名空间URI未绑定到前缀，则返回指定的默认前缀。 要将命名空间URI绑定到前缀，请调用putNamespacePrefix方法。

参数

namespaceURI - 命名空间URI

defaultPrefix - 在指定的命名空间URI未绑定到前缀的情况下返回的前缀。

结果

与该指定的命名空间URI，或者相关联的前缀defaultPrefix如果URI未注册。 如果命名空间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)

getProperty

Object getProperty(String name)

返回指定属性的值。

参数

name - 财产的名称

结果

指定属性的当前值，如果没有值， null

异常

NullPointerException - 如果 name是 null

另请参见：

setProperty(String, Object)

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)