OpenJDK 27 · javax.xml.crypto.dsig.Reference · APIdia, the JavaDoc alternative

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));

Method Summary

Modifier and Type	Method and Description
public byte[]	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. getCalculatedDigestValue() Returns the calculated digest value of this `Reference` after a validation operation.
public Data	Returns: the dereferenced data, or `null` if reference caching is not enabled or this reference has not been generated or validated getDereferencedData() Returns the dereferenced data, if reference caching is enabled.
public InputStream	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 getDigestInputStream() Returns the pre-digested input stream, if reference caching is enabled.
public DigestMethod	Returns: the digest method getDigestMethod() Returns the digest method of this `Reference`.
public byte[]	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. getDigestValue() Returns the digest value of this `Reference`.
public String	Returns: the `Id` attribute (may be `null` if not specified) getId() Returns the optional `Id` attribute of this `Reference`, which permits this reference to be referenced from elsewhere.
public List<Transform>	Returns: an unmodifiable list of `Transform`s (may be empty but never `null`) getTransforms() Returns an `unmodifiable list` of `Transform`s that are contained in this `Reference`.
public boolean	Returns: `true` if this reference was validated successfully; `false` otherwise validate(XMLValidateContext the validating context validateContext) Validates this reference.

Inherited from javax.xml.crypto.URIReference:: getType getURI
Inherited from javax.xml.crypto.XMLStructure:: isFeatureSupported

Method Detail

getCalculatedDigestValue back to summary

getCalculatedDigestValue	back to summary
public 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:byte[] 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 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:byte[]: 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.

getDereferencedData back to summary

getDereferencedData	back to summary
public 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:Data the dereferenced data, or `null` if reference caching is not enabled or this reference has not been generated or validated

public 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:Data: the dereferenced data, or null if reference caching is not enabled or this reference has not been generated or validated

getDigestInputStream back to summary

getDigestInputStream	back to summary
public 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:InputStream 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 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:InputStream: 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

getDigestMethod back to summary

getDigestMethod	back to summary
public DigestMethod getDigestMethod() Returns the digest method of this `Reference`. Returns:DigestMethod the digest method

public DigestMethod getDigestMethod()

Returns the digest method of this Reference.

Returns:DigestMethod: the digest method

getDigestValue back to summary

getDigestValue	back to summary
public byte[] getDigestValue() Returns the digest value of this `Reference`. Returns:byte[] 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 byte[] getDigestValue()

Returns the digest value of this Reference.

Returns:byte[]: 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.

getId back to summary

getId	back to summary
public String getId() Returns the optional `Id` attribute of this `Reference`, which permits this reference to be referenced from elsewhere. Returns:String the `Id` attribute (may be `null` if not specified)

public String getId()

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

Returns:String: the Id attribute (may be null if not specified)

getTransforms back to summary

getTransforms	back to summary
public List<Transform> getTransforms() Returns an `unmodifiable list` of `Transform`s that are contained in this `Reference`. Returns:List<Transform> an unmodifiable list of `Transform`s (may be empty but never `null`)

public List<Transform> getTransforms()

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

Returns:List<Transform>: an unmodifiable list of Transforms (may be empty but never null)

validate back to summary

validate	back to summary
public boolean validate(XMLValidateContext validateContext) throws XMLSignatureException 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:XMLValidateContext the validating context Returns:boolean `true` if this reference was validated successfully; `false` otherwise Exceptions XMLSignatureException: if an unexpected exception occurs while validating the reference NullPointerException: if `validateContext` is `null`

public boolean validate(XMLValidateContext validateContext) throws XMLSignatureException

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:XMLValidateContext: the validating context

Returns:boolean

true if this reference was validated successfully; false otherwise

Exceptions

XMLSignatureException:: if an unexpected exception occurs while validating the reference
NullPointerException:: if validateContext is null

public Interface Reference

Method Summary

Method Detail