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

Modifier and Type	Field and Description
private Attr	here
private final List<Transform>	transforms
private String	type
private String	uri

Access	Constructor and Description
public	DOMRetrievalMethod(String the URI uri, String the type type, List<? extends Transform> a list of `Transform`s. The list is defensively copied to prevent subsequent modification. May be `null` or empty. transforms) Creates a `DOMRetrievalMethod` containing the specified URIReference and List of Transforms.
public	DOMRetrievalMethod(Element a RetrievalMethod element rmElem, XMLCryptoContext context, Provider provider) Creates a `DOMRetrievalMethod` from an element.

Method Summary

Modifier and Type	Method and Description
public Data	dereference(XMLCryptoContext context) Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.dereference. Dereferences the `KeyInfo` information referenced by this `RetrievalMethod` and applies the specified `Transform`s.
public XMLStructure	dereferenceAsXMLStructure(XMLCryptoContext context)
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Node	getHere() Implements javax.xml.crypto.dom.DOMURIReference.getHere. Returns the here node.
public List<Transform>	getTransforms() Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getTransforms. Returns an `unmodifiable list` of `Transform`s of this `RetrievalMethod`.
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.dsig.keyinfo.RetrievalMethod.getURI, javax.xml.crypto.URIReference.getURI. Returns the URI of the referenced `KeyInfo` information.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	marshal(Node parent, String dsPrefix, DOMCryptoContext context) Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.

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

Field Detail

here	back to summary
private Attr here

transforms	back to summary
private final List<Transform> transforms

type	back to summary
private String type

uri	back to summary
private String uri

Constructor Detail

DOMRetrievalMethod back to summary

DOMRetrievalMethod	back to summary
public DOMRetrievalMethod(String uri, String type, List<? extends Transform> transforms) Creates a `DOMRetrievalMethod` containing the specified URIReference and List of Transforms. Parameters uri:String the URI type:String the type transforms:List<? extends Transform> a list of `Transform`s. The list is defensively copied to prevent subsequent modification. May be `null` or empty. Exceptions IllegalArgumentException: if the format of `uri` is invalid, as specified by Reference's URI attribute in the W3C specification for XML-Signature Syntax and Processing NullPointerException: if `uriReference` is `null` ClassCastException: if `transforms` contains any entries that are not of type `Transform`

public DOMRetrievalMethod(String uri, String type, List<? extends Transform> transforms)

Creates a DOMRetrievalMethod containing the specified URIReference and List of Transforms.

Parameters

uri:String: the URI
type:String: the type
transforms:List<? extends Transform>: a list of Transforms. The list is defensively copied to prevent subsequent modification. May be null or empty.

Exceptions

IllegalArgumentException:: if the format of uri is invalid, as specified by Reference's URI attribute in the W3C specification for XML-Signature Syntax and Processing
NullPointerException:: if uriReference is null
ClassCastException:: if transforms contains any entries that are not of type Transform

DOMRetrievalMethod back to summary

DOMRetrievalMethod	back to summary
public DOMRetrievalMethod(Element rmElem, XMLCryptoContext context, Provider provider) throws MarshalException Creates a `DOMRetrievalMethod` from an element. Parameters rmElem:Element a RetrievalMethod element

public DOMRetrievalMethod(Element rmElem, XMLCryptoContext context, Provider provider) throws MarshalException

Creates a DOMRetrievalMethod from an element.

Parameters

rmElem:Element: a RetrievalMethod element

Method Detail

dereference back to summary

dereference	back to summary
public Data dereference(XMLCryptoContext context) throws URIReferenceException Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.dereference. Doc from javax.xml.crypto.dsig.keyinfo.RetrievalMethod.dereference. Dereferences the `KeyInfo` information referenced by this `RetrievalMethod` and applies the specified `Transform`s. Annotations @Override Exceptions URIReferenceException: if there is an error while dereferencing

public Data dereference(XMLCryptoContext context) throws URIReferenceException

Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.dereference.

Doc from javax.xml.crypto.dsig.keyinfo.RetrievalMethod.dereference.

Dereferences the KeyInfo information referenced by this RetrievalMethod and applies the specified Transforms.

Annotations

@Override

Exceptions

URIReferenceException:: if there is an error while dereferencing

dereferenceAsXMLStructure	back to summary
public XMLStructure dereferenceAsXMLStructure(XMLCryptoContext context) throws URIReferenceException

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 obj)

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

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

getTransforms back to summary

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

public List<Transform> getTransforms()

Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getTransforms.

Doc from javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getTransforms.

Returns an unmodifiable list of Transforms of this RetrievalMethod.

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

getURI	back to summary
public String getURI() Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getURI, javax.xml.crypto.URIReference.getURI. Doc from javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getURI. Returns the URI of the referenced `KeyInfo` information. Annotations @Override

public String getURI()

Implements javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getURI, javax.xml.crypto.URIReference.getURI.

Doc from javax.xml.crypto.dsig.keyinfo.RetrievalMethod.getURI.

Returns the URI of the referenced KeyInfo information.

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

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

public final Class DOMRetrievalMethod

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail