URIReference
, XMLStructure
public interface Reference extends URIReference, XMLStructure
Reference
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. The XML schema is defined as: <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>
A Reference
instance may be created by invoking one of the newReference
methods of the XMLSignatureFactory
class; for example:
XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM"); Reference ref = factory.newReference ("http://www.ietf.org/rfc/rfc3275.txt", factory.newDigestMethod(DigestMethod.SHA1, null));
Modifier and Type | Method | Description |
---|---|---|
byte[] |
getCalculatedDigestValue() |
Returns the calculated digest value of this Reference after a validation operation. |
Data |
getDereferencedData() |
Returns the dereferenced data, if reference caching is enabled. |
InputStream |
getDigestInputStream() |
Returns the pre-digested input stream, if reference caching is enabled. |
DigestMethod |
getDigestMethod() |
Returns the digest method of this Reference . |
byte[] |
getDigestValue() |
Returns the digest value of this Reference . |
String |
getId() |
Returns the optional Id attribute of this Reference , which permits this reference to be referenced from elsewhere. |
List |
getTransforms() |
|
boolean |
validate |
Validates this reference. |
getType, getURI
isFeatureSupported
List<Transform> getTransforms()
Transform
s (may be empty but never null
)DigestMethod getDigestMethod()
Reference
.String getId()
Id
attribute of this Reference
, which permits this reference to be referenced from elsewhere.Id
attribute (may be null
if not specified)byte[] getDigestValue()
Reference
.null
if this reference has not been digested yet. Each invocation of this method returns a new clone to protect against subsequent modification.byte[] getCalculatedDigestValue()
Reference
after a validation operation. This method is useful for debugging if the reference fails to validate.null
if this reference has not been validated yet. Each invocation of this method returns a new clone to protect against subsequent modification.boolean validate(XMLValidateContext validateContext) throws XMLSignatureException
This method only validates the reference the first time it is invoked. On subsequent invocations, it returns a cached result.
validateContext
- the validating contexttrue
if this reference was validated successfully; false
otherwiseNullPointerException
- if validateContext
is null
XMLSignatureException
- if an unexpected exception occurs while validating the referenceData getDereferencedData()
null
if reference caching is not enabled or this reference has not been generated or validatedInputStream getDigestInputStream()
null
if reference caching is not enabled or this reference has not been generated or validated
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml.crypto/javax/xml/crypto/dsig/Reference.html