compact3

javax.xml.crypto.dsig

Interface XMLSignature

All Superinterfaces:

XMLStructure

public interface XMLSignature
extends XMLStructure

W3C Recommendation for XML-Signature Syntax and Processing中定义的XML Signature元素的表示 。 此类包含使用W3C规范定义的行为签名和验证XML签名的方法。 XML模式定义定义为：

   <element name="Signature" type="ds:SignatureType"/> <complexType name="SignatureType"> <sequence> <element ref="ds:SignedInfo"/> <element ref="ds:SignatureValue"/> <element ref="ds:KeyInfo" minOccurs="0"/> <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/> </sequence> <attribute name="Id" type="ID" use="optional"/> </complexType>  

可以通过调用XMLSignatureFactory类的newXMLSignature方法之一来创建一个XMLSignature实例。

如果随后修改包含XMLSignature的基础文档的内容，则行为是未定义的。

请注意，此类名称为XMLSignature而不是Signature ，以避免与现有的java.security.Signature类命名冲突。

从以下版本开始：

1.6

另请参见：

XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo) ， XMLSignatureFactory.newXMLSignature(SignedInfo, KeyInfo, List, String, String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XMLSignature.SignatureValue W3C Recommendation for XML-Signature Syntax and Processing中定义的XML SignatureValue元素的 表示 。

Field Summary

Fields

Modifier and Type	Field and Description
static String	XMLNS 用于XML签名语法和处理的W3C建议书的XML命名空间URI。

方法摘要

Modifier and Type	Method and Description
String	getId() 返回此 XMLSignature的可选ID。
KeyInfo	getKeyInfo() 返回此 XMLSignature的关键信息。
KeySelectorResult	getKeySelectorResult() 返回KeySelector的结果，如果指定，则此XMLSignature已经签名或验证。
List	getObjects() 返回此XMLSignature中包含的XMLObject的XMLSignature 。
XMLSignature.SignatureValue	getSignatureValue() 返回此签名值 XMLSignature 。
SignedInfo	getSignedInfo() 返回此 XMLSignature的签名信息。
void	sign(XMLSignContext signContext) 标志这 XMLSignature 。
boolean	validate(XMLValidateContext validateContext) 根据core validation processing rules验证 签名 。

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

字段详细信息

XMLNS

static final String XMLNS

用于XML签名语法和处理的W3C建议书的XML命名空间URI。

另请参见：

Constant Field Values

方法详细信息

validate

boolean validate(XMLValidateContext validateContext)
          throws XMLSignatureException

根据core validation processing rules验证签名 。 该方法使用现有的状态验证签名，它并没有解组和重新初始化的内容XMLSignature使用在上下文中指定的位置信息。

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

参数

validateContext - 验证上下文

结果

true如果签名通过核心验证，否则 false

异常

ClassCastException -如果类型 validateContext不符合此兼容 XMLSignature

NullPointerException - 如果 validateContext是 null

XMLSignatureException - 如果在验证期间发生意外错误，阻止验证操作完成

getKeyInfo

KeyInfo getKeyInfo()

返回此 XMLSignature的关键信息。

结果

关键信息（可能为 null如果未指定）

getSignedInfo

SignedInfo getSignedInfo()

返回此 XMLSignature的签名信息。

结果

签名信息（从不 null ）

getObjects

List getObjects()

返回此XMLSignature中包含的XMLObject s的XMLSignature 。

结果

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

getId

String getId()

返回此 XMLSignature的可选ID。

结果

的Id（可以是 null如果未指定）

getSignatureValue

XMLSignature.SignatureValue getSignatureValue()

返回此签名值 XMLSignature 。

结果

签名值

sign

void sign(XMLSignContext signContext)
   throws MarshalException,
          XMLSignatureException

标志这XMLSignature 。

如果此方法引发异常，则此XMLSignature和signContext参数将保留在调用之前的状态。

参数

signContext - 签名上下文

异常

ClassCastException -如果类型 signContext不符合此兼容 XMLSignature

NullPointerException - 如果 signContext是 null

MarshalException - 如果编组时发生异常

XMLSignatureException - 如果在生成签名时发生意外异常

getKeySelectorResult

KeySelectorResult getKeySelectorResult()

返回KeySelector的结果，如果指定，则此XMLSignature已签署或验证。

结果

键选择器结果，或 null如果没有指定键选择器或此 XMLSignature尚未签名或验证