org.opensaml.soap.soap11.encoder.http.impl

Class HTTPSOAP11Encoder<MessageType extends XMLObject>

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<MessageType>

org.opensaml.soap.soap11.encoder.http.impl.HTTPSOAP11Encoder<MessageType>

Type Parameters:

MessageType - the message type of the message context on which to operate

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, MessageEncoder<MessageType>, HttpServletResponseMessageEncoder<MessageType>

Direct Known Subclasses:

HTTPSOAP11Encoder, HTTPSOAP11Encoder

public class HTTPSOAP11Encoder<MessageType extends XMLObject>
extends BaseHttpServletResponseXMLMessageEncoder<MessageType>

Basic SOAP 1.1 encoder for HTTP transport.

Constructor Summary

Constructors

Constructor and Description
HTTPSOAP11Encoder() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	buildAndStoreSOAPMessage(XMLObject payload) Builds the SOAP message to be encoded.
protected void	doEncode() Performs the encoding logic.
protected int	getHTTPResponseStatusCode() Get the HTTP response status code to return.
protected XMLObject	getMessageToLog() Get the XMLObject which will be logged as the protocol message.
protected String	getSOAPAction() Determine the value of the SOAPAction HTTP header to send.
protected Envelope	getSOAPEnvelope() Retrieve the previously stored SOAP envelope from the message context.
void	prepareContext() This method should prepare the message context by creating and populating any binding-specific data structures required in the MessageContext, prior to actually encoding.
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(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

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

Constructor Detail

HTTPSOAP11Encoder

public HTTPSOAP11Encoder()

Constructor.

Method Detail

prepareContext

public void prepareContext()
                    throws MessageEncodingException

This method should prepare the message context by creating and populating any binding-specific data structures required in the MessageContext, prior to actually encoding.

This method should be called after the MessageContext has been set, and before any binding-specific Handler or HandlerChains are invoked.

Example: For a SOAP encoder, this method would create and store the basic SOAP Envelope structure in the message context, so that Handlers that are invoked have a place to which to add headers.

This method may be a no-op if not required by the binding, or if the message type of the context implies that the binding-specific structures have already been created elsewhere (e.g. message-oriented code where the calling code already knows its SOAP, and is operating on the raw SOAP envelope anyway).

. Default implementation is a no-op.

Specified by:

prepareContext in interface MessageEncoder<MessageType extends XMLObject>

Overrides:

prepareContext in class AbstractMessageEncoder<MessageType extends XMLObject>

Throws:

MessageEncodingException - if there is a problem preparing the message context for encoding

doEncode

protected void doEncode()
                 throws MessageEncodingException

Performs the encoding logic. By the time this is called, this encoder has already been initialized and checked to ensure that it has not been destroyed.

Specified by:

doEncode in class AbstractMessageEncoder<MessageType extends XMLObject>

Throws:

MessageEncodingException - thrown if there is a problem encoding the message

storeSOAPEnvelope

protected void storeSOAPEnvelope(Envelope envelope)

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

Parameters:

envelope - the SOAP envelope

getSOAPEnvelope

protected Envelope getSOAPEnvelope()

Retrieve the previously stored SOAP envelope from the message context.

Returns:

the previously stored SOAP envelope

buildAndStoreSOAPMessage

protected void buildAndStoreSOAPMessage(@Nonnull
                                        XMLObject payload)

Builds the SOAP message to be encoded.

Parameters:

payload - body of the SOAP message

prepareHttpServletResponse

protected void prepareHttpServletResponse()
                                   throws 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:

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 XMLObject getMessageToLog()

Get the XMLObject which will be logged as the protocol message.

Overrides:

getMessageToLog in class BaseHttpServletResponseXMLMessageEncoder<MessageType extends XMLObject>

Returns:

the XMLObject message considered to be the protocol message for logging purposes