Module java.xml.crypto

Package javax.xml.crypto.dom

Class 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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<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)	设置用于解除引用URIReference的URIDereferencer。

Methods declared in class java.lang.Object

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

Constructor Details

DOMCryptoContext

             protected DOMCryptoContext()
            

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

Method Details

getNamespacePrefix

             public String getNamespacePrefix(String namespaceURI, String defaultPrefix)
            

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

指定者:

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

指定者:

putNamespacePrefix 在接口 XMLCryptoContext中

参数:

namespaceURI - 命名空间URI

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

返回:

与指定命名空间URI关联的先前前缀，如果没有则返回null

抛出:

NullPointerException - 如果namespaceURI为null

参见:

• XMLCryptoContext.getNamespacePrefix(String, String)

getDefaultNamespacePrefix

             public String getDefaultNamespacePrefix()
            

从接口复制的描述: XMLCryptoContext

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

指定者:

getDefaultNamespacePrefix 在接口 XMLCryptoContext中

返回:

默认命名空间前缀，如果未设置则返回null。

参见:

• XMLCryptoContext.setDefaultNamespacePrefix(String)

setDefaultNamespacePrefix

             public void setDefaultNamespacePrefix(String defaultPrefix)
            

从接口复制的描述: XMLCryptoContext

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

指定者:

setDefaultNamespacePrefix 在接口 XMLCryptoContext中

参数:

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

参见:

• XMLCryptoContext.getDefaultNamespacePrefix()

getBaseURI

             public String getBaseURI()
            

从接口复制的描述: XMLCryptoContext

返回基本URI。

指定者:

getBaseURI 在接口 XMLCryptoContext中

返回:

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

参见:

• XMLCryptoContext.setBaseURI(String)

setBaseURI

             public void setBaseURI(String baseURI)
            

从接口复制的描述: XMLCryptoContext

设置基本URI。

指定者:

setBaseURI 在接口 XMLCryptoContext中

参数:

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

抛出:

IllegalArgumentException - 如果baseURI不符合RFC 2396规范

参见:

• XMLCryptoContext.getBaseURI()

getURIDereferencer

             public URIDereferencer getURIDereferencer()
            

从接口复制的描述: XMLCryptoContext

返回用于解除引用URIReference的URIDereferencer。

指定者:

getURIDereferencer 在接口 XMLCryptoContext中

返回值:

URIDereferencer，如果未指定则返回null

参见:

• XMLCryptoContext.setURIDereferencer(URIDereferencer)

setURIDereferencer

             public void setURIDereferencer(URIDereferencer dereferencer)
            

从接口复制的描述: XMLCryptoContext

设置用于解除引用URIReference的URIDereferencer。指定的URIDereferencer将替代实现的默认URIDereferencer。

指定者:

setURIDereferencer 在接口 XMLCryptoContext中

参数:

dereferencer - URIDereferencer，如果要移除当前设置则为null

参见:

• XMLCryptoContext.getURIDereferencer()

getProperty

             public Object getProperty(String name)
            

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

指定者:

getProperty 在接口 XMLCryptoContext中

参数:

name - 属性的名称

返回值:

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

抛出:

NullPointerException - 如果name为null

参见:

• XMLCryptoContext.setProperty(String, Object)

setProperty

             public Object setProperty(String name, Object value)
            

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

指定者:

setProperty 在接口 XMLCryptoContext中

参数:

name - 属性的名称

value - 要设置的属性值

返回值:

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

抛出:

NullPointerException - 如果name为null

参见:

• XMLCryptoContext.getProperty(String)

getKeySelector

             public KeySelector getKeySelector()
            

从接口复制的描述: XMLCryptoContext

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

指定者:

getKeySelector 在接口 XMLCryptoContext中

返回值:

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

参见:

• XMLCryptoContext.setKeySelector(KeySelector)

setKeySelector

             public void setKeySelector(KeySelector ks)
            

从接口复制的描述: XMLCryptoContext

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

指定者:

setKeySelector 在接口 XMLCryptoContext中

参数:

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<Map.Entry<String,Element>> iterator()
            

返回此DOMCryptoContext的ID/Element映射集合的只读迭代器。尝试通过Iterator.remove()方法修改集合会抛出UnsupportedOperationException。映射以无特定顺序返回。迭代中的每个元素表示为Map.Entry。如果在迭代进行时修改了DOMCryptoContext，则迭代结果是未定义的。

返回值:

集合映射的只读迭代器

get

             public Object get(Object key)
            

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

指定者:

get 在接口 XMLCryptoContext中

参数:

key - 要返回其关联值的键

返回值:

上下文将指定键映射到的值，如果没有为该键进行映射则返回null

参见:

• XMLCryptoContext.put(Object, Object)

put

             public Object put(Object key, Object value)
            

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

指定者:

put 在接口 XMLCryptoContext中

参数:

key - 要将指定值关联的键

value - 要与指定键关联的值

返回值:

与键关联的先前值，如果该键没有映射则返回null

抛出:

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

参见:

• XMLCryptoContext.get(Object)