net.shibboleth.idp.saml.saml2.profile.delegation.messaging.impl

Class LibertyHTTPSOAP11Encoder

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.encoder.AbstractMessageEncoder<MessageType>

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder<MessageType>

org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder<org.opensaml.saml.common.SAMLObject>

net.shibboleth.idp.saml.saml2.profile.delegation.messaging.impl.LibertyHTTPSOAP11Encoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, org.opensaml.messaging.encoder.MessageEncoder<org.opensaml.saml.common.SAMLObject>, org.opensaml.messaging.encoder.servlet.HttpServletResponseMessageEncoder<org.opensaml.saml.common.SAMLObject>, org.opensaml.saml.common.binding.encoding.SAMLMessageEncoder

public class LibertyHTTPSOAP11Encoder
extends org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder<org.opensaml.saml.common.SAMLObject>
implements org.opensaml.saml.common.binding.encoding.SAMLMessageEncoder

Encoder for Liberty ID-WSF 2.0 SOAP 1.1 HTTP binding carrying SAML protocol messages used in SAML delegation.

Field Summary

Fields

Modifier and Type	Field and Description
private org.opensaml.soap.common.SOAPObjectBuilder<org.opensaml.soap.soap11.Body>	bodyBuilder SOAP Body builder.
private org.opensaml.soap.common.SOAPObjectBuilder<org.opensaml.soap.soap11.Envelope>	envBuilder SOAP Envelope builder.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
LibertyHTTPSOAP11Encoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildAndStoreSOAPMessage(org.opensaml.core.xml.XMLObject payload) Builds the SOAP message to be encoded.
protected void	doEncode()
String	getBindingURI()
protected int	getHTTPResponseStatusCode() Get the HTTP response status code to return.
protected org.opensaml.core.xml.XMLObject	getMessageToLog()
protected String	getSOAPAction() Determine the value of the SOAPAction HTTP header to send.
protected org.opensaml.soap.soap11.Envelope	getSOAPEnvelope() Retrieve the previously stored SOAP envelope from the message context.
void	prepareContext()
protected void	prepareHttpServletResponse() This implementation performs the following actions on the context's HttpServletResponse: Adds the HTTP header: "Cache-control: no-cache, no-store" Adds the HTTP header: "Pragma: no-cache" Sets the character encoding to: "UTF-8" Sets the content type to: "text/xml" Sets the SOAPAction HTTP header the value returned by getSOAPAction(), if that returns non-null.
protected void	storeSOAPEnvelope(org.opensaml.soap.soap11.Envelope envelope) Store the constructed SOAP envelope in the message context for later encoding.

Methods inherited from class org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder

encode, logEncodedMessage, marshallMessage

Methods inherited from class org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

doDestroy, doInitialize, getHttpServletResponse, setHttpServletResponse

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

getMessageContext, setMessageContext

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.messaging.encoder.MessageEncoder

encode, setMessageContext

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Field Detail

log

private final org.slf4j.Logger log

Class logger.

envBuilder

private org.opensaml.soap.common.SOAPObjectBuilder<org.opensaml.soap.soap11.Envelope> envBuilder

SOAP Envelope builder.

bodyBuilder

private org.opensaml.soap.common.SOAPObjectBuilder<org.opensaml.soap.soap11.Body> bodyBuilder

SOAP Body builder.

Constructor Detail

LibertyHTTPSOAP11Encoder

public LibertyHTTPSOAP11Encoder()

Constructor.

Method Detail

getBindingURI

public String getBindingURI()

Specified by:

getBindingURI in interface org.opensaml.saml.common.binding.encoding.SAMLMessageEncoder

prepareContext

public void prepareContext()
                    throws org.opensaml.messaging.encoder.MessageEncodingException

Specified by:

prepareContext in interface org.opensaml.messaging.encoder.MessageEncoder<org.opensaml.saml.common.SAMLObject>

Overrides:

prepareContext in class org.opensaml.messaging.encoder.AbstractMessageEncoder<org.opensaml.saml.common.SAMLObject>

Throws:

org.opensaml.messaging.encoder.MessageEncodingException

doEncode

protected void doEncode()
                 throws org.opensaml.messaging.encoder.MessageEncodingException

Specified by:

doEncode in class org.opensaml.messaging.encoder.AbstractMessageEncoder<org.opensaml.saml.common.SAMLObject>

Throws:

org.opensaml.messaging.encoder.MessageEncodingException

storeSOAPEnvelope

protected void storeSOAPEnvelope(org.opensaml.soap.soap11.Envelope envelope)

Store the constructed SOAP envelope in the message context for later encoding.

Parameters:

envelope - the SOAP envelope

getSOAPEnvelope

protected org.opensaml.soap.soap11.Envelope getSOAPEnvelope()

Retrieve the previously stored SOAP envelope from the message context.

Returns:

the previously stored SOAP envelope

buildAndStoreSOAPMessage

protected void buildAndStoreSOAPMessage(@Nonnull
                            org.opensaml.core.xml.XMLObject payload)

Builds the SOAP message to be encoded.

Parameters:

payload - body of the SOAP message

prepareHttpServletResponse

protected void prepareHttpServletResponse()
                                   throws org.opensaml.messaging.encoder.MessageEncodingException

This implementation performs the following actions on the context's HttpServletResponse:

1. Adds the HTTP header: "Cache-control: no-cache, no-store"
2. Adds the HTTP header: "Pragma: no-cache"
3. Sets the character encoding to: "UTF-8"
4. Sets the content type to: "text/xml"
5. Sets the SOAPAction HTTP header the value returned by getSOAPAction(), if that returns non-null.

Subclasses should NOT set the SOAPAction HTTP header in this method. Instead, they should override the method getSOAPAction().

Throws:

org.opensaml.messaging.encoder.MessageEncodingException - thrown if there is a problem preprocessing the transport

getSOAPAction

protected String getSOAPAction()

Determine the value of the SOAPAction HTTP header to send.

The default behavior is to return the value of the SOAP Envelope's WS-Addressing Action header, if present.

Returns:

a SOAPAction HTTP header URI value

getHTTPResponseStatusCode

protected int getHTTPResponseStatusCode()

Get the HTTP response status code to return.

Returns:

the HTTP response status code

getMessageToLog

protected org.opensaml.core.xml.XMLObject getMessageToLog()

Overrides:

getMessageToLog in class org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder<org.opensaml.saml.common.SAMLObject>