javax.xml.crypto.dom
类 DOMCryptoContext

java.lang.Object
  javax.xml.crypto.dom.DOMCryptoContext

所有已实现的接口：

XMLCryptoContext

直接已知子类：

DOMSignContext, DOMValidateContext

public class DOMCryptoContext
extends Object
implements XMLCryptoContext

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

从以下版本开始：

1.6

构造方法摘要

protected

DOMCryptoContext() 默认的构造方法。

方法摘要

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() 返回用来取消引用 URIReference 的 URIDereferencer。
Iterator	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) 设置用来取消引用 URIReference 的 URIDereferencer。

从类 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 所映射的前缀。如果指定的 URI 映射到 null，则返回 defaultPrefix。

指定者：

接口 XMLCryptoContext 中的 getNamespacePrefix

参数：

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 映射到指定的前缀。

指定者：

接口 XMLCryptoContext 中的 putNamespacePrefix

参数：

namespaceURI - 名称空间 URI

prefix - 名称空间前缀（或者为 null，表示移除所有现有映射）。指定空字符串 ("") 则表示不将任何前缀绑定到名称空间 URI。

返回：

与指定的名称空间 URI 关联以前使用的前缀，如果没有任何前缀，则返回 null

抛出：

NullPointerException - 如果 namespaceURI 为 null

另请参见：

XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

public String getDefaultNamespacePrefix()

从接口 XMLCryptoContext 复制的描述

返回默认名称空间前缀。默认的名称空间前缀是用于所有名称空间 URI 的前缀，该前缀未通过 putNamespacePrefix 方法显式设置。

指定者：

接口 XMLCryptoContext 中的 getDefaultNamespacePrefix

返回：

默认的名称空间前缀；如果未设置任何前缀，则返回 null。

另请参见：

XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

public void setDefaultNamespacePrefix(String defaultPrefix)

从接口 XMLCryptoContext 复制的描述

设置默认的名称空间前缀。此方法可设置用于所有没有通过 putNamespacePrefix 方法显式设置的名称空间 URI 的名称空间前缀。

指定者：

接口 XMLCryptoContext 中的 setDefaultNamespacePrefix

参数：

defaultPrefix - 默认的名称空间前缀；或者为 null，表示移除当前设置。指定空字符串 ("") 则表示不绑定任何前缀。

另请参见：

XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

public String getBaseURI()

从接口 XMLCryptoContext 复制的描述

返回基本 URI。

指定者：

接口 XMLCryptoContext 中的 getBaseURI

返回：

基本 URI；如果未指定，则返回 null

另请参见：

XMLCryptoContext.setBaseURI(String)

setBaseURI

public void setBaseURI(String baseURI)

从接口 XMLCryptoContext 复制的描述

设置基本 URI。

指定者：

接口 XMLCryptoContext 中的 setBaseURI

参数：

baseURI - 基本 URI；或者为 null，表示移除当前值

抛出：

IllegalArgumentException - 如果 baseURI 与 RFC 2396 不兼容

另请参见：

XMLCryptoContext.getBaseURI()

getURIDereferencer

public URIDereferencer getURIDereferencer()

从接口 XMLCryptoContext 复制的描述

返回用来取消引用 URIReference 的 URIDereferencer。

指定者：

接口 XMLCryptoContext 中的 getURIDereferencer

返回：

URIDereferencer；如果未指定，则返回 null

另请参见：

XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

public void setURIDereferencer(URIDereferencer dereferencer)

从接口 XMLCryptoContext 复制的描述

设置用来取消引用 URIReference 的 URIDereferencer。使用指定的 URIDereferencer 来代替某一实现的默认 URIDereferencer。

指定者：

接口 XMLCryptoContext 中的 setURIDereferencer

参数：

dereferencer - URIDereferencer；或者为 null，表示移除任何当前设置

另请参见：

XMLCryptoContext.getURIDereferencer()

getProperty

public Object getProperty(String name)

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

指定者：

接口 XMLCryptoContext 中的 getProperty

参数：

name - 属性名称

返回：

指定的属性的当前值；如果没有这样的值，则返回 null

抛出：

NullPointerException - 如果 name 为 null

另请参见：

XMLCryptoContext.setProperty(String, Object)

setProperty

public Object setProperty(String name,
                          Object value)

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

指定者：

接口 XMLCryptoContext 中的 setProperty

参数：

name - 属性名称

value - 要设置的属性值

返回：

指定属性的先前值；如果没有这样值，则返回 null

抛出：

NullPointerException - 如果 name 为 null

另请参见：

XMLCryptoContext.getProperty(String)

getKeySelector

public KeySelector getKeySelector()

从接口 XMLCryptoContext 复制的描述

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

指定者：

接口 XMLCryptoContext 中的 getKeySelector

返回：

密钥选择器；如果未指定，则返回 null

另请参见：

XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

public void setKeySelector(KeySelector ks)

从接口 XMLCryptoContext 复制的描述

设置用于查找某个密钥的密钥选择器。

指定者：

接口 XMLCryptoContext 中的 setKeySelector

参数：

ks - 密钥选择器；或者为 null，表示移除当前设置

另请参见：

XMLCryptoContext.getKeySelector()

getElementById

public Element getElementById(String idValue)

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

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

参数：

idValue - ID 值

返回：

具有指定 ID 属性值的 Element；如果没有，则返回 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 iterator()

返回可在此 DOMCryptoContext 的 Id/Element 映射集上进行迭代的只读迭代器。试图通过 Iterator.remove() 方法修改该映射集将导致抛出 UnsupportedOperationException。返回的映射没有特定的顺序。迭代的每个元素都被表示为一个 Map.Entry。如果在进行迭代期间修改了 DOMCryptoContext，则迭代的结果是不确定的。

返回：

可在映射集上进行迭代的只读迭代器

get

public Object get(Object key)

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

指定者：

接口 XMLCryptoContext 中的 get

参数：

key - 关联值将被返回的键

返回：

此上下文将指定键映射到的值；如果没有与该键有关的映射关系，则返回 null

另请参见：

XMLCryptoContext.put(Object, Object)

put

public Object put(Object key,
                  Object value)

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

指定者：

接口 XMLCryptoContext 中的 put

参数：

key - 将与指定值关联的键

value - 将与指定键关联的值

返回：

与指定键关联的以前的值；如果没有与该键有关的映射关系，则返回 null

抛出：

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

另请参见：

XMLCryptoContext.get(Object)