XMLCryptoContext - [ Java参考文档 ] - 在线原生手册

目录搜索

文字

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

javax.xml.crypto
接口 XMLCryptoContext

所有已知子接口：: XMLSignContext, XMLValidateContext

所有已知实现类：: DOMCryptoContext, DOMSignContext, DOMValidateContext

public interface XMLCryptoContext

包含用于 XML 加密操作的通用上下文信息。

此接口包含一些方法可用来设置和检索那些影响 XML 签名或 XML 加密结构处理的属性。

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

从以下版本开始：: 1.6

方法摘要
`Object`	`get(Object key)` 返回此上下文将指定键映射到的值。
`String`	`getBaseURI()` 返回基本 URI。
`String`	`getDefaultNamespacePrefix()` 返回默认名称空间前缀。
`KeySelector`	`getKeySelector()` 返回用于查找某个密钥的密钥选择器。
`String`	`getNamespacePrefix(String namespaceURI, String defaultPrefix)` 返回与指定的名称空间 URI 关联的名称空间前缀。
`Object`	`getProperty(String name)` 返回指定属性的值。
`URIDereferencer`	`getURIDereferencer()` 返回用来取消引用 `URIReference` 的 `URIDereferencer`。
`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)` 设置用来取消引用 `URIReference` 的 `URIDereferencer`。

方法详细信息

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

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

返回：: URIDereferencer；如果未指定，则返回 null
另请参见：: setURIDereferencer(URIDereferencer)

setURIDereferencer

void setURIDereferencer(URIDereferencer dereferencer)

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

参数：: dereferencer - URIDereferencer；或者为 null，表示移除任何当前设置
另请参见：: getURIDereferencer()

getNamespacePrefix

String getNamespacePrefix(String namespaceURI,
                          String defaultPrefix)

返回与指定的名称空间 URI 关联的名称空间前缀。如果没有将指定的名称空间 URI 绑定到某一前缀，则返回指定的默认前缀。要将名称空间 URI 绑定到某一前缀，请调用 putNamespacePrefix 方法。

参数：: namespaceURI - 名称空间 URI; defaultPrefix - 在没有将指定的名称空间 URI 绑定到某一前缀的情况下将被返回的前缀。

返回：

与指定的名称空间 URI 相关联的前缀，如果没有注册 URI，则返回 defaultPrefix。如果已注册名称空间 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()

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

返回：: 默认的名称空间前缀；如果未设置任何前缀，则返回 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)

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

javax.xml.crypto 接口 XMLCryptoContext

getBaseURI

setBaseURI

getKeySelector

setKeySelector

getURIDereferencer

setURIDereferencer

getNamespacePrefix

putNamespacePrefix

getDefaultNamespacePrefix

setDefaultNamespacePrefix

setProperty

getProperty

get

put

javax.xml.crypto
接口 XMLCryptoContext