public interface

Reference

implements URIReference XMLStructure
javax.xml.crypto.dsig.Reference

Class Overview

A representation of the 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));

See Also

Summary

Public Methods
abstract byte[] getCalculatedDigestValue()
Returns the calculated digest value of this Reference after a validation operation.
abstract Data getDereferencedData()
Returns the dereferenced data, if reference caching is enabled.
abstract InputStream getDigestInputStream()
Returns the pre-digested input stream, if reference caching is enabled.
abstract DigestMethod getDigestMethod()
Returns the digest method of this Reference.
abstract byte[] getDigestValue()
Returns the digest value of this Reference.
abstract String getId()
Returns the optional Id attribute of this Reference, which permits this reference to be referenced from elsewhere.
abstract List getTransforms()
Returns an unmodifiable list of Transforms that are contained in this Reference.
abstract boolean validate(XMLValidateContext validateContext)
Validates this reference.
[Expand]
Inherited Methods
From interface javax.xml.crypto.URIReference
From interface javax.xml.crypto.XMLStructure

Public Methods

public abstract 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.

public abstract Data getDereferencedData ()

Returns the dereferenced data, if reference caching 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

public abstract InputStream getDigestInputStream ()

Returns the pre-digested input stream, if reference caching 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

public abstract DigestMethod getDigestMethod ()

Returns the digest method of this Reference.

Returns
  • the digest method

public abstract 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.

public abstract String 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)

public abstract List getTransforms ()

Returns an unmodifiable list of Transforms that are contained in this Reference.

Returns
  • an unmodifiable list of Transforms (may be empty but never null)

public abstract boolean validate (XMLValidateContext validateContext)

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 if validateContext is null
XMLSignatureException if an unexpected exception occurs while validating the reference