Interface Reference

    • Method Detail

      • getTransforms

        List<Transform> 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)
      • getDigestMethod

        DigestMethod getDigestMethod()
        Returns the digest method of this Reference.
        Returns:
        the digest method
      • getId

        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)
      • 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 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 - 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
      • getDereferencedData

        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
      • getDigestInputStream

        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