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

Modifier and Type	Class and Description
pack-priv static enum	AbstractDOMSignatureMethod.Type

Access	Constructor and Description
pack-priv	AbstractDOMSignatureMethod()

Method Summary

Modifier and Type	Method and Description
pack-priv void	checkParams(SignatureMethodParameterSpec the algorithm-specific params (may be `null`) params) Checks if the specified parameters are valid for this algorithm.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv abstract AbstractDOMSignatureMethod.Type	getAlgorithmType() Returns the type of signature algorithm.
pack-priv abstract String	getJCAAlgorithm() Returns the java.security.Signature or javax.crypto.Mac standard algorithm name.
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 invokes the `marshalParams` method to marshal any algorithm-specific parameters.
pack-priv void	marshalParams(Element the parent element to append the parameters to parent, String the algorithm parameters prefix to use paramsPrefix) Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element.
pack-priv boolean	paramsEqual(AlgorithmParameterSpec spec) Returns true if parameters are equal; false otherwise.
pack-priv abstract byte[]	Returns: the signature sign(Key the signing key key, SignedInfo the SignedInfo si, XMLSignContext the XMLSignContext context) Signs the bytes with the specified key, using the underlying Signature or Mac algorithm.
pack-priv SignatureMethodParameterSpec	Returns: the algorithm-specific `SignatureMethodParameterSpec` unmarshalParams(Element the `Element` holding the input params paramsElem) Unmarshals `SignatureMethodParameterSpec` from the specified `Element`.
pack-priv abstract boolean	Returns: `true` if the signature verified successfully, `false` if not verify(Key the verification key key, SignedInfo the SignedInfo si, byte[] the signature bytes to be verified sig, XMLValidateContext the XMLValidateContext context) Verifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm.

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

AbstractDOMSignatureMethod	back to summary
pack-priv AbstractDOMSignatureMethod()

Method Detail

checkParams back to summary

checkParams	back to summary
pack-priv void checkParams(SignatureMethodParameterSpec params) throws InvalidAlgorithmParameterException Checks if the specified parameters are valid for this algorithm. By default, this method throws an exception if parameters are specified since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters. Parameters params:SignatureMethodParameterSpec the algorithm-specific params (may be `null`) Exceptions InvalidAlgorithmParameterException: if the parameters are not appropriate for this signature method

pack-priv void checkParams(SignatureMethodParameterSpec params) throws InvalidAlgorithmParameterException

Checks if the specified parameters are valid for this algorithm. By default, this method throws an exception if parameters are specified since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Parameters

params:SignatureMethodParameterSpec: the algorithm-specific params (may be null)

Exceptions

InvalidAlgorithmParameterException:: if the parameters are not appropriate for this signature method

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

getAlgorithmType	back to summary
pack-priv abstract AbstractDOMSignatureMethod.Type getAlgorithmType() Returns the type of signature algorithm.

getJCAAlgorithm	back to summary
pack-priv abstract String getJCAAlgorithm() Returns the java.security.Signature or javax.crypto.Mac standard algorithm name.

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

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 invokes the `marshalParams` method to marshal any algorithm-specific parameters. Annotations @Override

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

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

This method invokes the marshalParams method to marshal any algorithm-specific parameters.

Annotations

@Override

marshalParams	back to summary
pack-priv void marshalParams(Element parent, String paramsPrefix) throws MarshalException Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters. Parameters parent:Element the parent element to append the parameters to paramsPrefix:String the algorithm parameters prefix to use Exceptions MarshalException: if the parameters cannot be marshalled

marshalParams

back to summary

pack-priv void marshalParams(Element parent, String paramsPrefix) throws MarshalException

Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Parameters

parent:Element: the parent element to append the parameters to
paramsPrefix:String: the algorithm parameters prefix to use

Exceptions

MarshalException:: if the parameters cannot be marshalled

paramsEqual	back to summary
pack-priv boolean paramsEqual(AlgorithmParameterSpec spec) Returns true if parameters are equal; false otherwise. Subclasses should override this method to compare algorithm-specific parameters.

sign back to summary

sign	back to summary
pack-priv abstract byte[] sign(Key key, SignedInfo si, XMLSignContext context) throws InvalidKeyException, XMLSignatureException Signs the bytes with the specified key, using the underlying Signature or Mac algorithm. Parameters key:Key the signing key si:SignedInfo the SignedInfo context:XMLSignContext the XMLSignContext Returns:byte[] the signature Exceptions InvalidKeyException: if the key is improperly encoded, of the wrong type, or parameters are missing, etc XMLSignatureException: if an unexpected error occurs NullPointerException: if `key` or `si` are `null`

pack-priv abstract byte[] sign(Key key, SignedInfo si, XMLSignContext context) throws InvalidKeyException, XMLSignatureException

Signs the bytes with the specified key, using the underlying Signature or Mac algorithm.

Parameters

key:Key: the signing key
si:SignedInfo: the SignedInfo
context:XMLSignContext: the XMLSignContext

Returns:byte[]

the signature

Exceptions

InvalidKeyException:: if the key is improperly encoded, of the wrong type, or parameters are missing, etc
XMLSignatureException:: if an unexpected error occurs
NullPointerException:: if key or si are null

unmarshalParams back to summary

unmarshalParams	back to summary
pack-priv SignatureMethodParameterSpec unmarshalParams(Element paramsElem) throws MarshalException Unmarshals `SignatureMethodParameterSpec` from the specified `Element`. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters. Parameters paramsElem:Element the `Element` holding the input params Returns:SignatureMethodParameterSpec the algorithm-specific `SignatureMethodParameterSpec` Exceptions MarshalException: if the parameters cannot be unmarshalled

pack-priv SignatureMethodParameterSpec unmarshalParams(Element paramsElem) throws MarshalException

Unmarshals SignatureMethodParameterSpec from the specified Element. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Parameters

paramsElem:Element: the Element holding the input params

Returns:SignatureMethodParameterSpec

the algorithm-specific SignatureMethodParameterSpec

Exceptions

MarshalException:: if the parameters cannot be unmarshalled

verify back to summary

verify	back to summary
pack-priv abstract boolean verify(Key key, SignedInfo si, byte[] sig, XMLValidateContext context) throws InvalidKeyException, SignatureException, XMLSignatureException Verifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm. Parameters key:Key the verification key si:SignedInfo the SignedInfo sig:byte[] the signature bytes to be verified context:XMLValidateContext the XMLValidateContext Returns:boolean `true` if the signature verified successfully, `false` if not Exceptions InvalidKeyException: if the key is improperly encoded, of the wrong type, or parameters are missing, etc SignatureException: if an unexpected error occurs, such as the passed in signature is improperly encoded XMLSignatureException: if an unexpected error occurs NullPointerException: if `key`, `si` or `sig` are `null`

pack-priv abstract boolean verify(Key key, SignedInfo si, byte[] sig, XMLValidateContext context) throws InvalidKeyException, SignatureException, XMLSignatureException

Verifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm.

Parameters

key:Key: the verification key
si:SignedInfo: the SignedInfo
sig:byte[]: the signature bytes to be verified
context:XMLValidateContext: the XMLValidateContext

Returns:boolean

true if the signature verified successfully, false if not

Exceptions

InvalidKeyException:: if the key is improperly encoded, of the wrong type, or parameters are missing, etc
SignatureException:: if an unexpected error occurs, such as the passed in signature is improperly encoded
XMLSignatureException:: if an unexpected error occurs
NullPointerException:: if key, si or sig are null

Modifier and Type	Field and Description
public static final AbstractDOMSignatureMethod.Type	DSA
public static final AbstractDOMSignatureMethod.Type	ECDSA
public static final AbstractDOMSignatureMethod.Type	EDDSA
public static final AbstractDOMSignatureMethod.Type	HMAC
public static final AbstractDOMSignatureMethod.Type	RSA

Modifier and Type	Method and Description
public static AbstractDOMSignatureMethod.Type	valueOf(String name)
public static AbstractDOMSignatureMethod.Type[]	values()

pack-priv abstract Class AbstractDOMSignatureMethod

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Enum AbstractDOMSignatureMethod.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail