org.apache.wss4j.dom.message

Class WSSecSignatureBase

java.lang.Object

org.apache.wss4j.dom.message.WSSecBase

org.apache.wss4j.dom.message.WSSecSignatureBase

Direct Known Subclasses:

WSSecDerivedKeyBase, WSSecSignature

public class WSSecSignatureBase
extends WSSecBase

This is the base class for WS Security messages that are used for signature generation or verification.

Field Summary

Fields inherited from class org.apache.wss4j.dom.message.WSSecBase

attachmentCallbackHandler, callbackLookup, expandXopInclude, keyIdentifierType, password, storeBytesInAttachment, user

Constructor Summary

Constructors

Constructor and Description
WSSecSignatureBase(Document doc)
WSSecSignatureBase(WSSecHeader securityHeader)

Method Summary

Modifier and Type	Method and Description
List<Reference>	addReferencesToSign(Document doc, List<WSEncryptionPart> references, WSDocInfo wsDocInfo, XMLSignatureFactory signatureFactory, boolean addInclusivePrefixes, String digestAlgo) This method adds references to the Signature.
protected void	cleanup()
Element	createSTRParameter(Document doc) Create an STRTransformationParameters element
List<String>	getInclusivePrefixes(Element target) Get the List of inclusive prefixes from the DOM Element argument
List<String>	getInclusivePrefixes(Element target, boolean excludeVisible) Get the List of inclusive prefixes from the DOM Element argument

Methods inherited from class org.apache.wss4j.dom.message.WSSecBase

getDocument, getIdAllocator, getKeyIdentifierType, getParts, getSecurityHeader, getWsDocInfo, isExpandXopInclude, setAttachmentCallbackHandler, setBodyID, setCallbackLookup, setExpandXopInclude, setIdAllocator, setKeyIdentifierType, setStoreBytesInAttachment, setUserInfo, setWsDocInfo, setWsuId

Methods inherited from class java.lang.Object

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

Constructor Detail

WSSecSignatureBase

public WSSecSignatureBase(WSSecHeader securityHeader)

WSSecSignatureBase

public WSSecSignatureBase(Document doc)

Method Detail

addReferencesToSign

public List<Reference> addReferencesToSign(Document doc,
                                           List<WSEncryptionPart> references,
                                           WSDocInfo wsDocInfo,
                                           XMLSignatureFactory signatureFactory,
                                           boolean addInclusivePrefixes,
                                           String digestAlgo)
                                    throws WSSecurityException

This method adds references to the Signature.

Parameters:

doc - The parent document

references - The list of references to sign

wsDocInfo - The WSDocInfo object to store protection elements in

signatureFactory - The XMLSignature object

addInclusivePrefixes - Whether to add inclusive prefixes or not

digestAlgo - The digest algorithm to use

Throws:

WSSecurityException

getInclusivePrefixes

public List<String> getInclusivePrefixes(Element target)

Get the List of inclusive prefixes from the DOM Element argument

getInclusivePrefixes

public List<String> getInclusivePrefixes(Element target,
                                         boolean excludeVisible)

Get the List of inclusive prefixes from the DOM Element argument

createSTRParameter

public Element createSTRParameter(Document doc)

Create an STRTransformationParameters element

cleanup

protected void cleanup()