compact3

javax.xml.crypto.dsig

Interface Reference

All Superinterfaces:

URIReference ， XMLStructure

public interface Reference
extends URIReference, XMLStructure

W3C Recommendation for XML-Signature Syntax and Processing中定义的Reference元素的表示 。 XML模式定义为：

 <element name="Reference" type="ds:ReferenceType"/>
 <complexType name="ReferenceType">
   <sequence>
     <element ref="ds:Transforms" minOccurs="0"/>
     <element ref="ds:DigestMethod"/>
     <element ref="ds:DigestValue"/>
   </sequence>
   <attribute name="Id" type="ID" use="optional"/>
   <attribute name="URI" type="anyURI" use="optional"/>
   <attribute name="Type" type="anyURI" use="optional"/>
 </complexType>

 <element name="DigestValue" type="ds:DigestValueType"/>
 <simpleType name="DigestValueType">
   <restriction base="base64Binary"/>
 </simpleType>
 

可以通过调用XMLSignatureFactory类的newReference方法之一创建Reference实例。 例如：

  XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
   Reference ref = factory.newReference
     ("http://www.ietf.org/rfc/rfc3275.txt",
      factory.newDigestMethod(DigestMethod.SHA1, null)); 

从以下版本开始：

1.6

另请参见：

XMLSignatureFactory.newReference(String, DigestMethod) ， XMLSignatureFactory.newReference(String, DigestMethod, List, String, String)

方法摘要

Modifier and Type	Method and Description
byte[]	getCalculatedDigestValue() 在验证 Reference后返回此Reference的计算摘要值。
Data	getDereferencedData() 返回取消引用的数据，如果 reference caching启用。
InputStream	getDigestInputStream() 如果启用了 reference caching ，则返回预消化的输入流。
DigestMethod	getDigestMethod() 返回此 Reference的摘要方法。
byte[]	getDigestValue() 返回此 Reference的摘要值。
String	getId() 返回此 Reference的可选 Id属性，该 Reference允许从其他地方引用该引用。
List	getTransforms() 返回此Reference中包含的Transform s的Reference 。
boolean	validate(XMLValidateContext validateContext) 验证此引用。

Methods inherited from interface javax.xml.crypto.URIReference

getType, getURI

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

方法详细信息

getTransforms

List getTransforms()

返回此Reference中包含的Transform s的Reference 。

结果

一个可修改列表 Transform S（可能是空的，但从来没有 null ）

getDigestMethod

DigestMethod getDigestMethod()

返回此 Reference的摘要方法。

结果

摘要方法

getId

String getId()

返回此 Reference的可选 Id属性，该 Reference允许从其他地方引用该引用。

结果

所述 Id属性（可以是 null如果未指定）

getDigestValue

byte[] getDigestValue()

返回此 Reference的摘要值。

结果

原始摘要值，或null如果此引用尚未消化。 此方法的每次调用都将返回一个新的克隆以防止后续修改。

getCalculatedDigestValue

byte[] getCalculatedDigestValue()

在验证Reference后返回此Reference的计算摘要值。 如果引用无法验证，此方法对于调试非常有用。

结果

计算的摘要值，或null如果此引用尚未验证）。 此方法的每次调用都将返回一个新的克隆以防止后续修改。

validate

boolean validate(XMLValidateContext validateContext)
          throws XMLSignatureException

验证此引用。 此方法验证此引用的摘要。

此方法仅在第一次调用时验证引用。 在随后的调用中，它返回缓存的结果。

参数

validateContext - 验证上下文

结果

true如果此引用已成功验证; false否则

异常

NullPointerException - 如果 validateContext是 null

XMLSignatureException - 如果在验证引用时发生意外异常

getDereferencedData

Data getDereferencedData()

返回取消引用的数据，如果reference caching启用。 这是在验证或生成操作期间取消引用此引用的URI的结果。

结果

取消引用的数据，或 null如果引用缓存未启用或该引用尚未生成或验证

getDigestInputStream

InputStream getDigestInputStream()

返回预消化的输入流，如果启用了reference caching 。 这是验证或签名操作期间摘要操作的输入。

结果

an input stream containing the pre-digested input, or null if reference caching is not enabled or this reference has not been generated or validated