compact3

javax.xml.crypto.dsig

Interface XMLSignature

All Superinterfaces:

XMLStructure

public interface XMLSignature
extends XMLStructure

一个表示的XML Signature元在 W3C Recommendation for XML-Signature Syntax and Processing定义。这类包含签名和验证XML签名和行为由W3C规范定义的方法。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>
 

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

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

注意这个类命名为XMLSignature而不是Signature避免命名冲突与现有的java.security.Signature类。

从以下版本开始：

一点六

另请参见：

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 一个表示的XML SignatureValue元在 W3C Recommendation for XML-Signature Syntax and Processing定义。

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的 XMLObjects一 unmodifiable list。
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

Field Detail

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兼容

如果是 null validateContext NullPointerException

XMLSignatureException -如果验证，防止验证操作完成时发生意外错误

getKeyInfo

KeyInfo getKeyInfo()

返回该 XMLSignature关键信息。

结果

关键信息（可能是 null如果不指定）

getSignedInfo

SignedInfo getSignedInfo()

签署本 XMLSignature返回信息。

结果

签名信息（不 null）

getObjects

List getObjects()

返回包含在这 XMLSignature的 XMLObjects一 unmodifiable list。

结果

XMLObjects的一个不可修改的列表（可能为空而不 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兼容

如果是 null signContext NullPointerException

MarshalException -如果发生异常而编组

XMLSignatureException如果发生意外的异常而产生的签名

getKeySelectorResult

KeySelectorResult getKeySelectorResult()

如果指定返回的 KeySelector，结果，在这 XMLSignature已经签署或确认。

结果

关键的选择结果，或 null如果关键选择器没有指定或本 XMLSignature尚未签署或确认