Module java.xml.crypto

软件包 javax.xml.crypto.dom

Class DOMCryptoContext

java.lang.Object

javax.xml.crypto.dom.DOMCryptoContext

All Implemented Interfaces:

XMLCryptoContext

已知直接子类：

DOMSignContext ， DOMValidateContext

public class DOMCryptoContext
extends Object
implements XMLCryptoContext

这个类提供了一个DOM特定的XMLCryptoContext接口的实现。 它还包括特定于基于DOM的实现的其他方法，用于注册和检索包含类型ID属性的元素。

从以下版本开始：

1.6

构造方法摘要

构造方法

Modifier	Constructor	描述
protected	DOMCryptoContext()	默认构造函数。

方法摘要

Modifier and Type	方法	描述
Object	get(Object key)	此实现使用内部的HashMap来获取指定的键映射到的对象。
String	getBaseURI()	返回基本URI。
String	getDefaultNamespacePrefix()	返回默认名称空间前缀。
Element	getElementById(String idValue)	返回具有指定ID属性值的 Element 。
KeySelector	getKeySelector()	返回用于查找密钥的密钥选择器。
String	getNamespacePrefix(String namespaceURI, String defaultPrefix)	此实现使用内部HashMap获取指定的URI映射到的前缀。
Object	getProperty(String name)	此实现使用内部HashMap获取指定名称映射的对象。
URIDereferencer	getURIDereferencer()	返回一个URIDereferencer ，用于取消引用URIReference 。
Iterator<Map.Entry<String,Element>>	iterator()	在这个 DOMCryptoContext的Id / Element映射集中返回一个只读迭代器。
Object	put(Object key, Object value)	该实现使用内部的HashMap将键映射到指定的对象。
String	putNamespacePrefix(String namespaceURI, String prefix)	此实现使用内部HashMap将URI映射到指定的前缀。
void	setBaseURI(String baseURI)	设置基本URI。
void	setDefaultNamespacePrefix(String defaultPrefix)	设置默认名称空间前缀。
void	setIdAttributeNS(Element element, String namespaceURI, String localName)	将名称空间URI和本地名称指定的元素的属性注册为类型ID。
void	setKeySelector(KeySelector ks)	设置用于查找键的键选择器。
Object	setProperty(String name, Object value)	此实现使用内部HashMap将名称映射到指定的对象。
void	setURIDereferencer(URIDereferencer dereferencer)	设置一个URIDereferencer ，用于取消引用URIReference s。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

DOMCryptoContext

protected DOMCryptoContext()

默认构造函数。 （用于由子类构造函数调用）。

方法详细信息

getNamespacePrefix

public String getNamespacePrefix(String namespaceURI,
                                 String defaultPrefix)

此实现使用内部HashMap获取指定的URI映射到的前缀。 它返回defaultPrefix如果它映射到null 。

Specified by:

getNamespacePrefix在接口 XMLCryptoContext

参数

namespaceURI - 命名空间URI

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

结果

与指定的命名空间URI相关联的前缀，如果URI未注册， defaultPrefix 。 如果命名空间URI被注册但没有前缀，则返回一个空字符串（ "" ）。

异常

NullPointerException - 如果 namespaceURI是 null

另请参见：

XMLCryptoContext.putNamespacePrefix(String, String)

putNamespacePrefix

public String putNamespacePrefix(String namespaceURI,
                                 String prefix)

此实现使用内部HashMap将URI映射到指定的前缀。

Specified by:

putNamespacePrefix在接口 XMLCryptoContext

参数

namespaceURI - 命名空间URI

prefix - 命名空间前缀（或null删除任何现有映射）。 指定空字符串（ "" ）不绑定到命名空间URI的前缀。

结果

与指定的命名空间URI相关联的前一个前缀，如果没有， null

异常

NullPointerException - 如果 namespaceURI是 null

另请参见：

XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

说明从界面XMLCryptoContext复制

返回默认名称空间前缀。 缺省命名空间前缀是putNamespacePrefix方法未明确设置的所有命名空间URI的前缀。

Specified by:

getDefaultNamespacePrefix在接口 XMLCryptoContext

结果

默认命名空间前缀，如果没有设置， null 。

另请参见：

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

描述从接口XMLCryptoContext复制

设置默认名称空间前缀。 这将为putNamespacePrefix方法未明确设置的所有命名空间URI设置命名空间前缀。

Specified by:

setDefaultNamespacePrefix在接口 XMLCryptoContext

参数

defaultPrefix - 默认名称空间前缀，或null删除当前设置。 指定空字符串（ "" ），不绑定前缀。

另请参见：

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

描述从接口XMLCryptoContext复制

返回基本URI。

Specified by:

getBaseURI在接口 XMLCryptoContext

结果

基本URI，如果未指定， null

另请参见：

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

描述从界面XMLCryptoContext复制

设置基本URI。

Specified by:

setBaseURI在接口 XMLCryptoContext

参数

baseURI - 基本URI，或 null删除当前值

异常

IllegalArgumentException - 如果 baseURI不符合RFC 2396标准

另请参见：

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

描述从接口XMLCryptoContext复制

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

Specified by:

getURIDereferencer在接口 XMLCryptoContext

结果

URIDereferencer或 null如果没有指定

另请参见：

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

说明从界面XMLCryptoContext复制

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

Specified by:

setURIDereferencer在接口 XMLCryptoContext

参数

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

另请参见：

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

此实现使用内部HashMap获取指定名称映射到的对象。

Specified by:

getProperty在接口 XMLCryptoContext

参数

name - 属性的名称

结果

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

异常

NullPointerException - 如果 name是 null

另请参见：

XMLCryptoContext.setProperty(String, Object)

setProperty

public Object setProperty(String name,
                          Object value)

此实现使用内部的HashMap将名称映射到指定的对象。

Specified by:

setProperty在接口 XMLCryptoContext

参数

name - 财产的名称

value - 要设置的属性的值

结果

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

异常

NullPointerException - 如果 name是 null

另请参见：

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

说明从界面XMLCryptoContext复制

返回用于查找密钥的密钥选择器。

Specified by:

getKeySelector在接口 XMLCryptoContext

结果

键选择器，如果没有指定， null

另请参见：

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

描述从接口XMLCryptoContext复制

设置用于查找键的键选择器。

Specified by:

setKeySelector在接口 XMLCryptoContext

参数

ks - 键选择器，或 null删除当前设置

另请参见：

XMLCryptoContext.getKeySelector()

getElementById

public Element getElementById(String idValue)

返回具有指定ID属性值的Element 。

此实现使用内部HashMap获取指定的属性值映射到的元素。

参数

idValue - ID的值

结果

所述 Element具有指定ID属性值，或 null如果没有。

异常

NullPointerException - 如果 idValue是 null

另请参见：

setIdAttributeNS(org.w3c.dom.Element, java.lang.String, java.lang.String)

setIdAttributeNS

public void setIdAttributeNS(Element element,
                             String namespaceURI,
                             String localName)

将名称空间URI和本地名称指定的元素的属性注册为类型ID。 该属性必须具有非空值。

此实现使用内部的HashMap将属性的值映射到指定的元素。

参数

element - 元素

namespaceURI - 属性的命名空间URI（如果不适用，请指定 null ）

localName - 属性的本地名称

异常

IllegalArgumentException - 如果 localName不是指定元素的属性或不包含特定值

NullPointerException - 如果 element或 localName是 null

另请参见：

getElementById(java.lang.String)

iterator

public Iterator<Map.Entry<String,Element>> iterator()

在这个DOMCryptoContext的Id / Element映射集中返回一个只读迭代器。 尝试通过Iterator.remove()方法修改集合抛出一个UnsupportedOperationException 。 映射没有特定的顺序返回。 迭代中的每个元素都表示为Map.Entry 。 如果DOMCryptoContext在迭代过程中被修改，则迭代的结果是未定义的。

结果

在该映射集上的只读迭代器

get

public Object get(Object key)

此实现使用内部的HashMap来获取指定的键映射到的对象。

Specified by:

get在接口 XMLCryptoContext

参数

key - 要返回其关联值的键

结果

该上下文映射指定键的值，如果没有键的映射， null

另请参见：

XMLCryptoContext.put(Object, Object)

put

public Object put(Object key,
                  Object value)

此实现使用内部的HashMap将键映射到指定的对象。

Specified by:

put在接口 XMLCryptoContext

参数

key - 指定值与之关联的键

value - 与指定键相关联的值

结果

与键相关联的上一个值，如果没有键的映射， null

异常

IllegalArgumentException - 如果此键或值的某些方面阻止其存储在此上下文中

另请参见：

XMLCryptoContext.get(Object)