org.apache.ws.security.saml
Class WSSignSAMLEnvelope

java.lang.Object
  org.apache.ws.security.message.WSBaseMessage
      org.apache.ws.security.message.WSSignEnvelope
          org.apache.ws.security.saml.WSSignSAMLEnvelope

public class WSSignSAMLEnvelope

extends WSSignEnvelope

Field Summary

Fields inherited from class org.apache.ws.security.message.WSSignEnvelope

canonAlgo, sigAlgo, signatureValue, usernameToken, useSingleCert

Fields inherited from class org.apache.ws.security.message.WSBaseMessage

actor, doDebug, keyIdentifierType, mustunderstand, parts, password, timeToLive, user, wssConfig

Constructor Summary

WSSignSAMLEnvelope()
Constructor.

WSSignSAMLEnvelope(java.lang.String actor, boolean mu)
Constructor.

Method Summary

org.w3c.dom.Document

build(org.w3c.dom.Document doc, Crypto userCrypto, org.opensaml.SAMLAssertion assertion, Crypto issuerCrypto, java.lang.String issuerKeyName, java.lang.String issuerKeyPW) Builds a signed soap envelope with SAML token.

Methods inherited from class org.apache.ws.security.message.WSSignEnvelope

build, createSTRParameter, getInclusivePrefixes, getInclusivePrefixes, getSigCanonicalization, getSignatureAlgorithm, getSignatureValue, isUseSingleCertificate, setSigCanonicalization, setSignatureAlgorithm, setUsernameToken, setUseSingleCertificate

Methods inherited from class org.apache.ws.security.message.WSBaseMessage

getKeyIdentifierType, insertSecurityHeader, setActor, setBodyID, setKeyIdentifierType, setMustUnderstand, setParts, setTimeToLive, setUserInfo, setWsConfig, setWsuId

Methods inherited from class java.lang.Object

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

Constructor Detail

WSSignSAMLEnvelope

public WSSignSAMLEnvelope()

Constructor.

WSSignSAMLEnvelope

public WSSignSAMLEnvelope(java.lang.String actor,
                          boolean mu)

Constructor.

Parameters:

actor - The actor name of the wsse:Security header

mu - Set mustUnderstand to true or false

Method Detail

build

public org.w3c.dom.Document build(org.w3c.dom.Document doc,
                                  Crypto userCrypto,
                                  org.opensaml.SAMLAssertion assertion,
                                  Crypto issuerCrypto,
                                  java.lang.String issuerKeyName,
                                  java.lang.String issuerKeyPW)
                           throws WSSecurityException

Builds a signed soap envelope with SAML token.

The method first gets an appropriate security header. According to the defined parameters for certificate handling the signature elements are constructed and inserted into the wsse:Signature

Parameters:

doc - The unsigned SOAP envelope as Document

assertion - the complete SAML assertion

issuerCrypto - An instance of the Crypto API to handle keystore SAML token issuer and to generate certificates

issuerKeyName - Private key to use in case of "sender-Vouches"

issuerKeyPW - Password for issuer private key

Returns:

A signed SOAP envelope as Document

Throws:

WSSecurityException