Interface XMLSignature.SignatureValue
- All Superinterfaces:
XMLStructure
- Enclosing interface:
- XMLSignature
public static interface XMLSignature.SignatureValue extends XMLStructure
A representation of the XML SignatureValue
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. The XML Schema Definition is defined as:
<element name="SignatureValue" type="ds:SignatureValueType"/> <complexType name="SignatureValueType"> <simpleContent> <extension base="base64Binary"> <attribute name="Id" type="ID" use="optional"/> </extension> </simpleContent> </complexType>
Method Summary
Modifier and Type | Method | Description |
---|---|---|
String | getId() | Returns the optional |
byte[] | getValue() | Returns the signature value of this |
boolean | validate(XMLValidateContext validateContext) | Validates the signature value. |
Methods declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
Method Detail
getId
String getId()
Returns the optional Id
attribute of this SignatureValue
, which permits this element to be referenced from elsewhere.
- Returns:
- the
Id
attribute (may benull
if not specified)
getValue
byte[] getValue()
Returns the signature value of this SignatureValue
.
- Returns:
- the signature value (may be
null
if theXMLSignature
has not been signed yet). Each invocation of this method returns a new clone of the array to prevent subsequent modification.
validate
boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
Validates the signature value. This method performs a cryptographic validation of the signature calculated over the SignedInfo
of the XMLSignature
.
This method only validates the signature the first time it is invoked. On subsequent invocations, it returns a cached result.
- Parameters:
-
validateContext
- the validating context - Returns:
-
true
if the signature was validated successfully;false
otherwise - Throws:
-
NullPointerException
- ifvalidateContext
isnull
-
XMLSignatureException
- if an unexpected exception occurs while validating the signature