OpenJDK 27 · org.jcp.xml.dsig.internal.dom.DOMReference

Modifier and Type	Field and Description
private List<Transform>	allTransforms
private final Data	appliedTransformData
private byte[]	calcDigestValue
private Data	derefData
private boolean	digested
private final DigestMethod	digestMethod
private byte[]	digestValue
private InputStream	dis
private Attr	here
private final String	id
private static final Logger	LOG
public static final int	MAXIMUM_TRANSFORM_COUNT The maximum number of transforms per reference, if secure validation is enabled.
private MessageDigest	md
private Provider	provider
private Element	refElem
private final List<Transform>	transforms
private final String	type
private final String	uri
private static boolean	useC14N11 Look up useC14N11 system property.
private boolean	validated
private boolean	validationStatus

Access	Constructor and Description
public	DOMReference(String the URI (may be null) uri, String the type (may be null) type, DigestMethod the digest method dm, List<? extends Transform> a list of `Transform`s. The list is defensively copied to protect against subsequent modification. May be `null` or empty. transforms, String the reference ID (may be `null`) id, Provider provider) Creates a `Reference` from the specified parameters.
public	DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, Provider provider)
public	DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, byte[] digestValue, Provider provider)
public	DOMReference(Element a Reference element refElem, XMLCryptoContext context, Provider provider) Creates a `DOMReference` from an element.

Method Summary

Modifier and Type	Method and Description
private static Data	copyDerefData(Data dereferencedData)
private Data	dereference(XMLCryptoContext context)
public void	digest(XMLSignContext signContext)
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public byte[]	getCalculatedDigestValue() Implements javax.xml.crypto.dsig.Reference.getCalculatedDigestValue. Returns the calculated digest value of this `Reference` after a validation operation.
public Data	getDereferencedData() Implements javax.xml.crypto.dsig.Reference.getDereferencedData. Returns the dereferenced data, if reference caching is enabled.
public InputStream	getDigestInputStream() Implements javax.xml.crypto.dsig.Reference.getDigestInputStream. Returns the pre-digested input stream, if reference caching is enabled.
public DigestMethod	getDigestMethod() Implements javax.xml.crypto.dsig.Reference.getDigestMethod. Returns the digest method of this `Reference`.
public byte[]	getDigestValue() Implements javax.xml.crypto.dsig.Reference.getDigestValue. Returns the digest value of this `Reference`.
public Node	getHere() Implements javax.xml.crypto.dom.DOMURIReference.getHere. Returns the here node.
public String	getId() Implements javax.xml.crypto.dsig.Reference.getId. Returns the optional `Id` attribute of this `Reference`, which permits this reference to be referenced from elsewhere.
public List<Transform>	getTransforms() Implements javax.xml.crypto.dsig.Reference.getTransforms. Returns an `unmodifiable list` of `Transform`s that are contained in this `Reference`.
public String	getType() Implements javax.xml.crypto.URIReference.getType. Returns the type of data referenced by this URI.
public String	getURI() Implements javax.xml.crypto.URIReference.getURI. Returns the URI of the referenced data object.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv boolean	isDigested()
public void	marshal(Node parent, String dsPrefix, DOMCryptoContext context) Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.
private byte[]	transform(Data dereferencedData, XMLCryptoContext context)
public boolean	validate(XMLValidateContext validateContext) Implements javax.xml.crypto.dsig.Reference.validate. Validates this reference.

Inherited from org.jcp.xml.dsig.internal.dom.DOMStructure:: equalsContent isFeatureSupported

Field Detail

allTransforms	back to summary
private List<Transform> allTransforms

appliedTransformData	back to summary
private final Data appliedTransformData

calcDigestValue	back to summary
private byte[] calcDigestValue

derefData	back to summary
private Data derefData

digested	back to summary
private boolean digested

digestMethod	back to summary
private final DigestMethod digestMethod

digestValue	back to summary
private byte[] digestValue

dis	back to summary
private InputStream dis

here	back to summary
private Attr here

id	back to summary
private final String id

LOG	back to summary
private static final Logger LOG

MAXIMUM_TRANSFORM_COUNT	back to summary
public static final int MAXIMUM_TRANSFORM_COUNT The maximum number of transforms per reference, if secure validation is enabled.

md	back to summary
private MessageDigest md

provider	back to summary
private Provider provider

refElem	back to summary
private Element refElem

transforms	back to summary
private final List<Transform> transforms

type	back to summary
private final String type

uri	back to summary
private final String uri

useC14N11	back to summary
private static boolean useC14N11 Look up useC14N11 system property. If true, an explicit C14N11 transform will be added if necessary when generating the signature. See section 3.1.1 of http://www.w3.org/2007/xmlsec/Drafts/xmldsig-core/ for more info. If true, overrides the same property if set in the XMLSignContext. Annotations @SuppressWarnings:removal

validated	back to summary
private boolean validated

validationStatus	back to summary
private boolean validationStatus

Constructor Detail

DOMReference back to summary

DOMReference	back to summary
public DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> transforms, String id, Provider provider) Creates a `Reference` from the specified parameters. Parameters uri:String the URI (may be null) type:String the type (may be null) dm:DigestMethod the digest method transforms:List<? extends Transform> a list of `Transform`s. The list is defensively copied to protect against subsequent modification. May be `null` or empty. id:String the reference ID (may be `null`) Exceptions NullPointerException: if `dm` is `null` ClassCastException: if any of the `transforms` are not of type `Transform`

public DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> transforms, String id, Provider provider)

Creates a Reference from the specified parameters.

Parameters

uri:String: the URI (may be null)
type:String: the type (may be null)
dm:DigestMethod: the digest method
transforms:List<? extends Transform>: a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null or empty.
id:String: the reference ID (may be null)

Exceptions

NullPointerException:: if dm is null
ClassCastException:: if any of the transforms are not of type Transform

DOMReference	back to summary
public DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, Provider provider)

DOMReference	back to summary
public DOMReference(String uri, String type, DigestMethod dm, List<? extends Transform> appliedTransforms, Data result, List<? extends Transform> transforms, String id, byte[] digestValue, Provider provider)

DOMReference back to summary

DOMReference	back to summary
public DOMReference(Element refElem, XMLCryptoContext context, Provider provider) throws MarshalException Creates a `DOMReference` from an element. Parameters refElem:Element a Reference element

public DOMReference(Element refElem, XMLCryptoContext context, Provider provider) throws MarshalException

Creates a DOMReference from an element.

Parameters

refElem:Element: a Reference element

Method Detail

copyDerefData	back to summary
private static Data copyDerefData(Data dereferencedData)

dereference	back to summary
private Data dereference(XMLCryptoContext context) throws XMLSignatureException

digest	back to summary
public void digest(XMLSignContext signContext) throws XMLSignatureException

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getCalculatedDigestValue back to summary

getCalculatedDigestValue	back to summary
public byte[] getCalculatedDigestValue() Implements javax.xml.crypto.dsig.Reference.getCalculatedDigestValue. Doc from javax.xml.crypto.dsig.Reference.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. Annotations @Override

public byte[] getCalculatedDigestValue()

Implements javax.xml.crypto.dsig.Reference.getCalculatedDigestValue.

Doc from javax.xml.crypto.dsig.Reference.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.

Annotations

@Override

getDereferencedData	back to summary
public Data getDereferencedData() Implements javax.xml.crypto.dsig.Reference.getDereferencedData. Doc from javax.xml.crypto.dsig.Reference.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. Annotations @Override

getDereferencedData

back to summary

public Data getDereferencedData()

Implements javax.xml.crypto.dsig.Reference.getDereferencedData.

Doc from javax.xml.crypto.dsig.Reference.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.

Annotations

@Override

getDigestInputStream	back to summary
public InputStream getDigestInputStream() Implements javax.xml.crypto.dsig.Reference.getDigestInputStream. Doc from javax.xml.crypto.dsig.Reference.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. Annotations @Override

getDigestInputStream

back to summary

public InputStream getDigestInputStream()

Implements javax.xml.crypto.dsig.Reference.getDigestInputStream.

Doc from javax.xml.crypto.dsig.Reference.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.

Annotations

@Override

getDigestMethod back to summary

getDigestMethod	back to summary
public DigestMethod getDigestMethod() Implements javax.xml.crypto.dsig.Reference.getDigestMethod. Doc from javax.xml.crypto.dsig.Reference.getDigestMethod. Returns the digest method of this `Reference`. Annotations @Override

public DigestMethod getDigestMethod()

Implements javax.xml.crypto.dsig.Reference.getDigestMethod.

Doc from javax.xml.crypto.dsig.Reference.getDigestMethod.

Returns the digest method of this Reference.

Annotations

@Override

getDigestValue back to summary

getDigestValue	back to summary
public byte[] getDigestValue() Implements javax.xml.crypto.dsig.Reference.getDigestValue. Doc from javax.xml.crypto.dsig.Reference.getDigestValue. Returns the digest value of this `Reference`. Annotations @Override

public byte[] getDigestValue()

Implements javax.xml.crypto.dsig.Reference.getDigestValue.

Doc from javax.xml.crypto.dsig.Reference.getDigestValue.

Returns the digest value of this Reference.

Annotations

@Override

getHere	back to summary
public Node getHere() Implements javax.xml.crypto.dom.DOMURIReference.getHere. Doc from javax.xml.crypto.dom.DOMURIReference.getHere. Returns the here node. Annotations @Override

getHere

back to summary

public Node getHere()

Implements javax.xml.crypto.dom.DOMURIReference.getHere.

Doc from javax.xml.crypto.dom.DOMURIReference.getHere.

Returns the here node.

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Implements javax.xml.crypto.dsig.Reference.getId. Doc from javax.xml.crypto.dsig.Reference.getId. Returns the optional `Id` attribute of this `Reference`, which permits this reference to be referenced from elsewhere. Annotations @Override

public String getId()

Implements javax.xml.crypto.dsig.Reference.getId.

Doc from javax.xml.crypto.dsig.Reference.getId.

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

Annotations

@Override

getTransforms back to summary

getTransforms	back to summary
public List<Transform> getTransforms() Implements javax.xml.crypto.dsig.Reference.getTransforms. Doc from javax.xml.crypto.dsig.Reference.getTransforms. Returns an `unmodifiable list` of `Transform`s that are contained in this `Reference`. Annotations @Override

public List<Transform> getTransforms()

Implements javax.xml.crypto.dsig.Reference.getTransforms.

Doc from javax.xml.crypto.dsig.Reference.getTransforms.

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

Annotations

@Override

getType	back to summary
public String getType() Implements javax.xml.crypto.URIReference.getType. Doc from javax.xml.crypto.URIReference.getType. Returns the type of data referenced by this URI. Annotations @Override

getType

back to summary

public String getType()

Implements javax.xml.crypto.URIReference.getType.

Doc from javax.xml.crypto.URIReference.getType.

Returns the type of data referenced by this URI.

Annotations

@Override

getURI	back to summary
public String getURI() Implements javax.xml.crypto.URIReference.getURI. Doc from javax.xml.crypto.URIReference.getURI. Returns the URI of the referenced data object. Annotations @Override

getURI

back to summary

public String getURI()

Implements javax.xml.crypto.URIReference.getURI.

Doc from javax.xml.crypto.URIReference.getURI.

Returns the URI of the referenced data object.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

isDigested	back to summary
pack-priv boolean isDigested()

marshal	back to summary
public void marshal(Node parent, String dsPrefix, DOMCryptoContext context) throws MarshalException Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal. Annotations @Override

marshal

back to summary

public void marshal(Node parent, String dsPrefix, DOMCryptoContext context) throws MarshalException

Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.

Annotations

@Override

transform	back to summary
private byte[] transform(Data dereferencedData, XMLCryptoContext context) throws XMLSignatureException

validate	back to summary
public boolean validate(XMLValidateContext validateContext) throws XMLSignatureException Implements javax.xml.crypto.dsig.Reference.validate. Doc from javax.xml.crypto.dsig.Reference.validate. 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. Annotations @Override Exceptions XMLSignatureException: if an unexpected exception occurs while validating the reference

validate

back to summary

public boolean validate(XMLValidateContext validateContext) throws XMLSignatureException

Implements javax.xml.crypto.dsig.Reference.validate.

Doc from javax.xml.crypto.dsig.Reference.validate.

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.

Annotations

@Override

Exceptions

XMLSignatureException:: if an unexpected exception occurs while validating the reference

public final Class DOMReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail