org.opensaml.common.binding.encoding
Interface SOAPEncoder<ResponseType extends javax.servlet.ServletResponse>

Type Parameters:
ResponseType - the type of response the message is encoded to
All Superinterfaces:
MessageEncoder<ResponseType>
All Known Subinterfaces:
SOAPHTTPEncoder
All Known Implementing Classes:
AbstractSOAPHTTPEncoder, HTTPSOAP11Encoder, HTTPSOAP11Encoder

public interface SOAPEncoder<ResponseType extends javax.servlet.ServletResponse>
extends MessageEncoder<ResponseType>

Base interface for SOAP specific SAML bindings.


Method Summary
 java.util.List<XMLObject> getSOAPHeaders()
          Gets a mutable list of SOAP headers to add to the message.
 Envelope getSOAPMessage()
          Gets the SOAP message built by the encoder.
 java.lang.String getSOAPVersion()
          Gets the SOAP version to use.
 void setSOAPVersion(java.lang.String version)
          Sets the SOAP version to use.
 
Methods inherited from interface org.opensaml.common.binding.encoding.MessageEncoder
encode, getBindingURI, getIssuer, getMetadataProvider, getRelyingParty, getRelyingPartyEndpoint, getRelyingPartyRole, getResponse, getSamlMessage, getSigningCredential, setIssuer, setMetadataProvider, setRelyingParty, setRelyingPartyEndpoint, setRelyingPartyRole, setResponse, setSamlMessage, setSigningCredential
 

Method Detail

getSOAPVersion

java.lang.String getSOAPVersion()
Gets the SOAP version to use.

Returns:
the SOAP version to use

setSOAPVersion

void setSOAPVersion(java.lang.String version)
Sets the SOAP version to use. If not explicity set version 1.1 is assumed.

Parameters:
version - the SOAP version, may not be null

getSOAPHeaders

java.util.List<XMLObject> getSOAPHeaders()
Gets a mutable list of SOAP headers to add to the message.

Returns:
SOAP headers to add to the message

getSOAPMessage

Envelope getSOAPMessage()
Gets the SOAP message built by the encoder.

Returns:
SOAP message built by the encoder