Reference JDK 1.6)

Description

public interface Reference

A representation of the Reference element as defined in the W3C Recommendation for XML-Signature Syntax and Processing.

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: XMLSignatureFactory.newReference(String, DigestMethod) XMLSignatureFactory.newReference(String, DigestMethod, List, String, String)

Methods

Hide/Show inherited methods

public byte getCalculatedDigestValue ()

Returns the calculated digest value of this Reference after a validation operation.

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 Data getDereferencedData ()

Returns the dereferenced data, if reference caching is enabled.

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 InputStream getDigestInputStream ()

Returns the pre-digested input stream, if reference caching is enabled.

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 DigestMethod getDigestMethod ()

Returns the digest method of this Reference.

Returns the digest method of this Reference.
Returns: the digest method

public byte getDigestValue ()

Returns the digest value of this Reference.

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 String getId ()

Returns the optional Id attribute of this Reference, which permits this reference to be referenced from elsewhere.

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 List getTransforms ()

Returns an

unmodifiable 
 list

of Transforms that are contained in this Reference.

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 boolean validate (XMLValidateContext validateContext) throws XMLSignatureException

Validates this reference.