Class DOMDigestMethod

java.lang.Object

org.apache.jcp.xml.dsig.internal.dom.DOMStructure

org.apache.jcp.xml.dsig.internal.dom.DOMDigestMethod

All Implemented Interfaces:

AlgorithmMethod, DigestMethod, XMLStructure

Direct Known Subclasses:

DOMDigestMethod.RIPEMD160, DOMDigestMethod.SHA1, DOMDigestMethod.SHA224, DOMDigestMethod.SHA256, DOMDigestMethod.SHA3_224, DOMDigestMethod.SHA3_256, DOMDigestMethod.SHA3_384, DOMDigestMethod.SHA3_512, DOMDigestMethod.SHA384, DOMDigestMethod.SHA512, DOMDigestMethod.WHIRLPOOL

public abstract class DOMDigestMethod
extends DOMStructure
implements DigestMethod

DOM-based abstract implementation of DigestMethod.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	DOMDigestMethod.RIPEMD160
(package private) static final class	DOMDigestMethod.SHA1
(package private) static final class	DOMDigestMethod.SHA224
(package private) static final class	DOMDigestMethod.SHA256
(package private) static final class	DOMDigestMethod.SHA3_224
(package private) static final class	DOMDigestMethod.SHA3_256
(package private) static final class	DOMDigestMethod.SHA3_384
(package private) static final class	DOMDigestMethod.SHA3_512
(package private) static final class	DOMDigestMethod.SHA384
(package private) static final class	DOMDigestMethod.SHA512
(package private) static final class	DOMDigestMethod.WHIRLPOOL

Field Summary

Fields

Modifier and Type	Field	Description
private DigestMethodParameterSpec	params
(package private) static final String	SHA224
(package private) static final String	SHA3_224
(package private) static final String	SHA3_256
(package private) static final String	SHA3_384
(package private) static final String	SHA3_512
(package private) static final String	SHA384
(package private) static final String	WHIRLPOOL

Fields inherited from interface DigestMethod

RIPEMD160, SHA1, SHA256, SHA512

Constructor Summary

Constructors

Constructor	Description
DOMDigestMethod(AlgorithmParameterSpec params)	Creates a DOMDigestMethod.
DOMDigestMethod(Element dmElem)	Creates a DOMDigestMethod from an element.

Method Summary

Modifier and Type	Method	Description
(package private) void	checkParams(DigestMethodParameterSpec params)	Checks if the specified parameters are valid for this algorithm.
boolean	equals(Object o)
(package private) abstract String	getMessageDigestAlgorithm()	Returns the MessageDigest standard algorithm name.
final AlgorithmParameterSpec	getParameterSpec()
int	hashCode()
void	marshal(Node parent, String prefix, DOMCryptoContext context)	This method invokes the abstract marshalParams method to marshal any algorithm-specific parameters.
(package private) void	marshalParams(Element parent, String prefix)	Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element.
(package private) static DigestMethod	unmarshal(Element dmElem)
(package private) DigestMethodParameterSpec	unmarshalParams(Element paramsElem)	Unmarshals DigestMethodParameterSpec from the specified Element.

Methods inherited from class DOMStructure

isFeatureSupported

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AlgorithmMethod

getAlgorithm

Methods inherited from interface XMLStructure

isFeatureSupported

Field Details

SHA224

static final String SHA224

See Also:

• Constant Field Values

SHA384

static final String SHA384

See Also:

• Constant Field Values

WHIRLPOOL

static final String WHIRLPOOL

See Also:

• Constant Field Values

SHA3_224

static final String SHA3_224

See Also:

• Constant Field Values

SHA3_256

static final String SHA3_256

See Also:

• Constant Field Values

SHA3_384

static final String SHA3_384

See Also:

• Constant Field Values

SHA3_512

static final String SHA3_512

See Also:

• Constant Field Values

params

private DigestMethodParameterSpec params

Constructor Details

DOMDigestMethod

DOMDigestMethod(AlgorithmParameterSpec params)
         throws InvalidAlgorithmParameterException

Creates a DOMDigestMethod.

Parameters:

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

Throws:

InvalidAlgorithmParameterException - if the parameters are not appropriate for this digest method

DOMDigestMethod

DOMDigestMethod(Element dmElem)
         throws MarshalException

Creates a DOMDigestMethod from an element. This constructor invokes the abstract unmarshalParams method to unmarshal any algorithm-specific input parameters.

Parameters:

dmElem - a DigestMethod element

Throws:

MarshalException

Method Details

unmarshal

static DigestMethod unmarshal(Element dmElem)
                       throws MarshalException

Throws:

MarshalException

checkParams

void checkParams(DigestMethodParameterSpec 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 DigestMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Parameters:

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

Throws:

InvalidAlgorithmParameterException - if the parameters are not appropriate for this digest method

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()

Specified by:

getParameterSpec in interface AlgorithmMethod

Specified by:

getParameterSpec in interface DigestMethod

unmarshalParams

DigestMethodParameterSpec unmarshalParams(Element paramsElem)
                                   throws MarshalException

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

Parameters:

paramsElem - the Element holding the input params

Returns:

the algorithm-specific DigestMethodParameterSpec

Throws:

MarshalException - if the parameters cannot be unmarshalled

marshal

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

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

Specified by:

marshal in class DOMStructure

Throws:

MarshalException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

marshalParams

void marshalParams(Element parent,
 String prefix)
            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 DigestMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Parameters:

parent - the parent element to append the parameters to

prefix - the namespace prefix to use

Throws:

MarshalException - if the parameters cannot be marshalled

getMessageDigestAlgorithm

abstract String getMessageDigestAlgorithm()

Returns the MessageDigest standard algorithm name.