Class WSSecDKSign


  • public class WSSecDKSign
    extends WSSecDerivedKeyBase
    Builder to sign with derived keys
    Author:
    Ruchith Fernando (ruchith.fernando@gmail.com), Davanum Srinivas (dims@yahoo.com), Werner Dittmann (werner@apache.org)
    • Field Detail

      • sigAlgo

        protected java.lang.String sigAlgo
      • canonAlgo

        protected java.lang.String canonAlgo
      • signatureValue

        protected byte[] signatureValue
    • Constructor Detail

      • WSSecDKSign

        public WSSecDKSign()
    • Method Detail

      • build

        public org.w3c.dom.Document build​(org.w3c.dom.Document doc,
                                          WSSecHeader secHeader)
                                   throws WSSecurityException,
                                          org.apache.ws.security.conversation.ConversationException
        Throws:
        WSSecurityException
        org.apache.ws.security.conversation.ConversationException
      • prepare

        public void prepare​(org.w3c.dom.Document doc,
                            WSSecHeader secHeader)
                     throws WSSecurityException,
                            org.apache.ws.security.conversation.ConversationException
        Throws:
        WSSecurityException
        org.apache.ws.security.conversation.ConversationException
      • getInclusivePrefixes

        protected java.util.Set getInclusivePrefixes​(org.w3c.dom.Element target)
      • getInclusivePrefixes

        protected java.util.Set getInclusivePrefixes​(org.w3c.dom.Element target,
                                                     boolean excludeVisible)
      • addReferencesToSign

        public void addReferencesToSign​(java.util.Vector references,
                                        WSSecHeader secHeader)
                                 throws WSSecurityException
        This method adds references to the Signature. The added references are signed when calling computeSignature(). This method can be called several times to add references as required. addReferencesToSign() can be called anytime after prepare.
        Parameters:
        references - A vector containing WSEncryptionPart objects that define the parts to sign.
        secHeader - Used to compute namespaces to be inserted by InclusiveNamespaces to be WSI compliant.
        Throws:
        WSSecurityException
      • createSTRParameter

        protected org.w3c.dom.Element createSTRParameter​(org.w3c.dom.Document doc)
      • prependSigToHeader

        public void prependSigToHeader​(WSSecHeader secHeader)
        Prepends the Signature element to the elements already in the Security header. The method can be called any time after prepare(). This allows to insert the Signature element at any position in the Security header.
        Parameters:
        securityHeader - The secHeader that holds the Signature element.
      • appendSigToHeader

        public void appendSigToHeader​(WSSecHeader secHeader)
      • getSignatureElement

        public org.w3c.dom.Element getSignatureElement()
        Returns the signature Element. The method can be called any time after prepare().
        Returns:
      • computeSignature

        public void computeSignature()
                              throws WSSecurityException
        Compute the Signature over the references. After references are set this method computes the Signature for them. This method can be called anytime after the references were set. See addReferencesToSign().
        Throws:
        WSSecurityException
      • setSignatureAlgorithm

        public void setSignatureAlgorithm​(java.lang.String algo)
      • getSignatureValue

        public byte[] getSignatureValue()
        Returns:
        Returns the signatureValue.
      • getSigCanonicalization

        public java.lang.String getSigCanonicalization()
        Get the canonicalization method. If the canonicalization method was not set then Exclusive XML Canonicalization is used by default.
        Returns:
        The string describing the canonicalization algorithm.