Package org.certificateservices.messages.utils

Interface XMLSigner.SignatureLocationFinder

All Known Implementing Classes:

BaseSAMLMessageParser.AssertionSignatureLocationFinder, BaseSAMLMessageParser.SAMLPSignatureLocationFinder, CSExportDataParser.CSExportDataSignatureLocationFinder, DefaultCSMessageParser.CSMessageSignatureLocationFinder, DSS1CoreMessageParser.DSS1CoreSignatureLocationFinder, SAMLMetaDataMessageParser.SAML2MetaDataSignatureLocationFinder

Enclosing class:

XMLSigner

public static interface XMLSigner.SignatureLocationFinder

Interface used to find the location and ID of a signed object.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getIDAttribute()
java.lang.String	getIDValue(org.w3c.dom.Element signedElement)
java.util.List<javax.xml.namespace.QName>	getSiblingsBeforeSignature(org.w3c.dom.Element element)	Method that should return the possible siblings that should be placed before the signature element in the specified element.
org.w3c.dom.Element[]	getSignatureLocations(org.w3c.dom.Document doc)	Return the element inside a document that should be signed.

Method Detail

getSignatureLocations

org.w3c.dom.Element[] getSignatureLocations(org.w3c.dom.Document doc)
                                     throws MessageContentException

Return the element inside a document that should be signed.

Throws:

MessageContentException

getIDAttribute

java.lang.String getIDAttribute()

Returns:

the name of the ID attribute referenced by the envelope signature.

getIDValue

java.lang.String getIDValue(org.w3c.dom.Element signedElement)
                     throws MessageContentException

Parameters:

signedElement - the element that should be signed, and ID value for should be fetched.

Returns:

the signature reference ID value

Throws:

MessageContentException

getSiblingsBeforeSignature

java.util.List<javax.xml.namespace.QName> getSiblingsBeforeSignature(org.w3c.dom.Element element)
                                                              throws MessageContentException

Method that should return the possible siblings that should be placed before the signature element in the specified element. If a specified sibling isn't found should the next be used.

Parameters:

element - the element about to be signed and those siblings should be found.

Returns:

a list of siblings that should be before signature, if the first doesn't exist due to optional is the next in list use. return null to place signature last in element.

Throws:

MessageContentException - if problems was found with the supplied element