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

Class DOMSignedInfo

java.lang.Object

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

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

All Implemented Interfaces:

SignedInfo, XMLStructure

public final class DOMSignedInfo
extends DOMStructure
implements SignedInfo

DOM-based implementation of SignedInfo.

Author:

Sean Mullan

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXIMUM_REFERENCE_COUNT The maximum number of references per Manifest, if secure validation is enabled.

Constructor Summary

Constructors

Constructor and Description
DOMSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references) Creates a DOMSignedInfo from the specified parameters.
DOMSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references, String id) Creates a DOMSignedInfo from the specified parameters.
DOMSignedInfo(Element siElem, XMLCryptoContext context, Provider provider) Creates a DOMSignedInfo from an element.

Method Summary

Modifier and Type	Method and Description
void	canonicalize(XMLCryptoContext context, ByteArrayOutputStream bos)
boolean	equals(Object o)
CanonicalizationMethod	getCanonicalizationMethod() Returns the canonicalization method of this SignedInfo.
InputStream	getCanonicalizedData() Returns the canonicalized signed info bytes after a signing or validation operation.
String	getId() Returns the optional Id attribute of this SignedInfo.
List	getReferences() Returns an unmodifiable list of one or more References.
SignatureMethod	getSignatureMethod() Returns the signature method of this SignedInfo.
int	hashCode()
void	marshal(Node parent, String dsPrefix, DOMCryptoContext context)

Methods inherited from class org.apache.jcp.xml.dsig.internal.dom.DOMStructure

isFeatureSupported

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

MAXIMUM_REFERENCE_COUNT

public static final int MAXIMUM_REFERENCE_COUNT

The maximum number of references per Manifest, if secure validation is enabled.

See Also:

Constant Field Values

Constructor Detail

DOMSignedInfo

public DOMSignedInfo(CanonicalizationMethod cm,
                     SignatureMethod sm,
                     List<? extends Reference> references)

Creates a DOMSignedInfo from the specified parameters. Use this constructor when the Id is not specified.

Parameters:

cm - the canonicalization method

sm - the signature method

references - the list of references. The list is copied.

Throws:

NullPointerException - if cm, sm, or references is null

IllegalArgumentException - if references is empty

ClassCastException - if any of the references are not of type Reference

DOMSignedInfo

public DOMSignedInfo(CanonicalizationMethod cm,
                     SignatureMethod sm,
                     List<? extends Reference> references,
                     String id)

Creates a DOMSignedInfo from the specified parameters.

Parameters:

cm - the canonicalization method

sm - the signature method

references - the list of references. The list is copied.

id - an optional identifer that will allow this SignedInfo to be referenced by other signatures and objects

Throws:

NullPointerException - if cm, sm, or references is null

IllegalArgumentException - if references is empty

ClassCastException - if any of the references are not of type Reference

DOMSignedInfo

public DOMSignedInfo(Element siElem,
                     XMLCryptoContext context,
                     Provider provider)
              throws MarshalException

Creates a DOMSignedInfo from an element.

Parameters:

siElem - a SignedInfo element

Throws:

MarshalException

Method Detail

getCanonicalizationMethod

public CanonicalizationMethod getCanonicalizationMethod()

Description copied from interface: SignedInfo

Returns the canonicalization method of this SignedInfo.

Specified by:

getCanonicalizationMethod in interface SignedInfo

Returns:

the canonicalization method

getSignatureMethod

public SignatureMethod getSignatureMethod()

Description copied from interface: SignedInfo

Returns the signature method of this SignedInfo.

Specified by:

getSignatureMethod in interface SignedInfo

Returns:

the signature method

getId

public String getId()

Description copied from interface: SignedInfo

Returns the optional Id attribute of this SignedInfo.

Specified by:

getId in interface SignedInfo

Returns:

the id (may be null if not specified)

getReferences

public List getReferences()

Description copied from interface: SignedInfo

Returns an unmodifiable list of one or more References.

Specified by:

getReferences in interface SignedInfo

Returns:

an unmodifiable list of one or more References

getCanonicalizedData

public InputStream getCanonicalizedData()

Description copied from interface: SignedInfo

Returns the canonicalized signed info bytes after a signing or validation operation. This method is useful for debugging.

Specified by:

getCanonicalizedData in interface SignedInfo

Returns:

an InputStream containing the canonicalized bytes, or null if this SignedInfo has not been signed or validated yet

canonicalize

public void canonicalize(XMLCryptoContext context,
                         ByteArrayOutputStream bos)
                  throws XMLSignatureException

Throws:

XMLSignatureException

marshal

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

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