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

Modifier and Type	Field and Description
protected TransformService	spi

Access	Constructor and Description
public	DOMTransform(TransformService the TransformService spi) Creates a `DOMTransform`.
public	DOMTransform(Element a Transform element transElem, XMLCryptoContext context, Provider provider) Creates a `DOMTransform` from an element.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final String	getAlgorithm() Implements javax.xml.crypto.AlgorithmMethod.getAlgorithm. Returns the algorithm URI of this `AlgorithmMethod`.
public final AlgorithmParameterSpec	getParameterSpec() Implements javax.xml.crypto.dsig.Transform.getParameterSpec. Returns the algorithm-specific input parameters associated with this `Transform`.
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. This method marshals any algorithm-specific parameters.
public Data	Returns: the transformed data transform(Data the data to be transformed data, XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) xc) Implements javax.xml.crypto.dsig.Transform.transform. Transforms the specified data using the underlying transform algorithm.
public Data	Returns: the transformed data transform(Data the data to be transformed data, XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) xc, OutputStream the `OutputStream` that should be used to write the transformed data to os) Implements javax.xml.crypto.dsig.Transform.transform. Transforms the specified data using the underlying transform algorithm.
pack-priv Data	Returns: the transformed data transform(Data the data to be transformed data, XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) xc, DOMSignContext the marshalling context context) Transforms the specified data using the underlying transform algorithm.

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

spi	back to summary
protected TransformService spi

DOMTransform	back to summary
public DOMTransform(TransformService spi) Creates a `DOMTransform`. Parameters spi:TransformService the TransformService

DOMTransform	back to summary
public DOMTransform(Element transElem, XMLCryptoContext context, Provider provider) throws MarshalException Creates a `DOMTransform` from an element. It unmarshals any algorithm-specific input parameters. Parameters transElem:Element a Transform element

Method Detail

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

getAlgorithm back to summary

getAlgorithm	back to summary
public final String getAlgorithm() Implements javax.xml.crypto.AlgorithmMethod.getAlgorithm. Doc from javax.xml.crypto.AlgorithmMethod.getAlgorithm. Returns the algorithm URI of this `AlgorithmMethod`. Annotations @Override

public final String getAlgorithm()

Implements javax.xml.crypto.AlgorithmMethod.getAlgorithm.

Doc from javax.xml.crypto.AlgorithmMethod.getAlgorithm.

Returns the algorithm URI of this AlgorithmMethod.

Annotations

@Override

getParameterSpec back to summary

getParameterSpec	back to summary
public final AlgorithmParameterSpec getParameterSpec() Implements javax.xml.crypto.dsig.Transform.getParameterSpec. Doc from javax.xml.crypto.dsig.Transform.getParameterSpec. Returns the algorithm-specific input parameters associated with this `Transform`. The returned parameters can be typecast to a `TransformParameterSpec` object. Annotations @Override

public final AlgorithmParameterSpec getParameterSpec()

Implements javax.xml.crypto.dsig.Transform.getParameterSpec.

Doc from javax.xml.crypto.dsig.Transform.getParameterSpec.

Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a TransformParameterSpec 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

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. This method marshals any algorithm-specific parameters. 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.

This method marshals any algorithm-specific parameters.

Annotations

@Override

transform	back to summary
public Data transform(Data data, XMLCryptoContext xc) throws TransformException Implements javax.xml.crypto.dsig.Transform.transform. Transforms the specified data using the underlying transform algorithm. Parameters data:Data the data to be transformed xc:XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) Returns:Data the transformed data Annotations @Override Exceptions TransformException: Doc from javax.xml.crypto.dsig.Transform.transform. if an error occurs while executing the transform NullPointerException: if `data` is `null` XMLSignatureException: if an unexpected error occurs while executing the transform

transform	back to summary
public Data transform(Data data, XMLCryptoContext xc, OutputStream os) throws TransformException Implements javax.xml.crypto.dsig.Transform.transform. Transforms the specified data using the underlying transform algorithm. Parameters data:Data the data to be transformed xc:XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) os:OutputStream the `OutputStream` that should be used to write the transformed data to Returns:Data the transformed data Annotations @Override Exceptions TransformException: Doc from javax.xml.crypto.dsig.Transform.transform. if an error occurs while executing the transform NullPointerException: if `data` is `null` XMLSignatureException: if an unexpected error occurs while executing the transform

transform	back to summary
pack-priv Data transform(Data data, XMLCryptoContext xc, DOMSignContext context) throws MarshalException, TransformException Transforms the specified data using the underlying transform algorithm. This method invokes the `marshal` method and passes it the specified `DOMSignContext` before transforming the data. Parameters data:Data the data to be transformed xc:XMLCryptoContext the `XMLCryptoContext` containing additional context (may be `null` if not applicable) context:DOMSignContext the marshalling context Returns:Data the transformed data Exceptions MarshalException: if an exception occurs while marshalling NullPointerException: if `data` or `context` is `null` XMLSignatureException: if an unexpected error occurs while executing the transform

public Class DOMTransform

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail