compact3
javax.xml.crypto.dsig
Interface XMLSignature.SignatureValue
-
- All Superinterfaces:
- XMLStructure
- Enclosing interface:
- XMLSignature
public static interface XMLSignature.SignatureValue extends XMLStructure
A representation of the XMLSignatureValueelement 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
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description StringgetId()Returns the optionalIdattribute of thisSignatureValue, which permits this element to be referenced from elsewhere.byte[]getValue()Returns the signature value of thisSignatureValue.booleanvalidate(XMLValidateContext validateContext)Validates the signature value.-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Method Detail
getId
String getId()
Returns the optionalIdattribute of thisSignatureValue, which permits this element to be referenced from elsewhere.- Returns:
-
the
Idattribute (may benullif not specified)
getValue
byte[] getValue()
Returns the signature value of thisSignatureValue.- Returns:
-
the signature value (may be
nullif theXMLSignaturehas 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 theSignedInfoof theXMLSignature.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:
-
trueif the signature was validated successfully;falseotherwise - Throws:
-
NullPointerException- ifvalidateContextisnull -
XMLSignatureException- if an unexpected exception occurs while validating the signature
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
