Reference (Java Platform SE 8 ) (original) (raw)

All Superinterfaces:
URIReference, XMLStructure

public interface Reference
extends URIReference, XMLStructure
A representation of the Reference element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. The XML schema is defined as:`

AReference` instance may be created by invoking one of thenewReference methods of theXMLSignatureFactory class; for example:
XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
Reference ref = factory.newReference
("http://www.ietf.org/rfc/rfc3275.txt",
factory.newDigestMethod(DigestMethod.SHA1, null));

Method Summary

All Methods Instance Methods Abstract Methods

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](XMLSignContext.html#Supported Properties) is enabled.
InputStream	getDigestInputStream()	Returns the pre-digested input stream, if[reference caching](XMLSignContext.html#Supported Properties) 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 thisReference, which permits this reference to be referenced from elsewhere.
List	getTransforms()	Returns an unmodifiable list of Transforms that are contained in thisReference.
boolean	validate(XMLValidateContext validateContext)	Validates this reference.

   * ### Methods inherited from interface javax.xml.crypto.[URIReference](../../../../javax/xml/crypto/URIReference.html "interface in javax.xml.crypto")  
   `[getType](../../../../javax/xml/crypto/URIReference.html#getType--), [getURI](../../../../javax/xml/crypto/URIReference.html#getURI--)`  
   * ### Methods inherited from interface javax.xml.crypto.[XMLStructure](../../../../javax/xml/crypto/XMLStructure.html "interface in javax.xml.crypto")  
   `[isFeatureSupported](../../../../javax/xml/crypto/XMLStructure.html#isFeatureSupported-java.lang.String-)`

Method Detail

 * #### getTransforms  
 [List](../../../../java/util/List.html "interface in java.util") getTransforms()  
 Returns:  
 an unmodifiable list of `Transform`s (may be empty but never `null`)  
 * #### getDigestMethod  
 [DigestMethod](../../../../javax/xml/crypto/dsig/DigestMethod.html "interface in javax.xml.crypto.dsig") getDigestMethod()  
 Returns the digest method of this `Reference`.  
 Returns:  
 the digest method  
 * #### getId  
 [String](../../../../java/lang/String.html "class in java.lang") getId()  
 Returns the optional `Id` attribute of this`Reference`, which permits this reference to be referenced from elsewhere.  
 Returns:  
 the `Id` attribute (may be `null` if not specified)  
 * #### getDigestValue  
 byte[] getDigestValue()  
 Returns the digest value of this `Reference`.  
 Returns:  
 the raw digest value, or `null` if this reference has not been digested yet. Each invocation of this method returns a new clone to protect against subsequent modification.  
 * #### getCalculatedDigestValue  
 byte[] getCalculatedDigestValue()  
 Returns the calculated digest value of this `Reference` after a validation operation. This method is useful for debugging if the reference fails to validate.  
 Returns:  
 the calculated digest value, or `null` if this reference has not been validated yet. Each invocation of this method returns a new clone to protect against subsequent modification.  
 * #### validate  
 boolean validate([XMLValidateContext](../../../../javax/xml/crypto/dsig/XMLValidateContext.html "interface in javax.xml.crypto.dsig") validateContext)  
           throws [XMLSignatureException](../../../../javax/xml/crypto/dsig/XMLSignatureException.html "class in javax.xml.crypto.dsig")  
 Validates this reference. This method verifies the digest of this reference.  
 This method only validates the reference the first time it is invoked. On subsequent invocations, it returns a cached result.  
 Parameters:  
 `validateContext` \- the validating context  
 Returns:  
 `true` if this reference was validated successfully;`false` otherwise  
 Throws:  
 `[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `validateContext` is`null`  
 `[XMLSignatureException](../../../../javax/xml/crypto/dsig/XMLSignatureException.html "class in javax.xml.crypto.dsig")` \- if an unexpected exception occurs while validating the reference  
 * #### getDereferencedData  
 [Data](../../../../javax/xml/crypto/Data.html "interface in javax.xml.crypto") getDereferencedData()  
 Returns the dereferenced data, if[reference caching](XMLSignContext.html#Supported Properties) is enabled. This is the result of dereferencing the URI of this reference during a validation or generation operation.  
 Returns:  
 the dereferenced data, or `null` if reference caching is not enabled or this reference has not been generated or validated  
 * #### getDigestInputStream  
 [InputStream](../../../../java/io/InputStream.html "class in java.io") getDigestInputStream()  
 Returns the pre-digested input stream, if[reference caching](XMLSignContext.html#Supported Properties) is enabled. This is the input to the digest operation during a validation or signing operation.  
 Returns:  
 an input stream containing the pre-digested input, or`null` if reference caching is not enabled or this reference has not been generated or validated

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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Reference (Java Platform SE 8 ) (original) (raw)

Method Summary

Method Detail