HTTPSOAP11Encoder (OpenSAML :: SOAP Provider Implementations 3.4.2 API)

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:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, org.opensaml.messaging.encoder.MessageEncoder<MessageType>, org.opensaml.messaging.encoder.servlet.HttpServletResponseMessageEncoder<MessageType>
```
public class HTTPSOAP11Encoder<MessageType extends org.opensaml.core.xml.XMLObject>
extends org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder<MessageType>
```
Basic SOAP 1.1 encoder for HTTP transport.

Field Summary

Fields
Modifier and Type	Field and Description
`private SOAPObjectBuilder<Body>`	`bodyBuilder` SOAP Body builder.
`private SOAPObjectBuilder<Envelope>`	`envBuilder` SOAP Envelope builder.
`private org.slf4j.Logger`	`log` Class logger.

Constructor Summary

Constructors
Constructor and Description

HTTPSOAP11Encoder()
Constructor.

Constructors
Constructor and Description
`HTTPSOAP11Encoder()` Constructor.

Method Summary

All Methods Instance Methods Concrete 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()`
`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 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(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

- Field Detail
  - log
```
private final org.slf4j.Logger log
```
    Class logger.
  - envBuilder
```
private SOAPObjectBuilder<Envelope> envBuilder
```
    SOAP Envelope builder.
  - bodyBuilder
```
private SOAPObjectBuilder<Body> bodyBuilder
```
    SOAP Body builder.
- Constructor Detail
  - HTTPSOAP11Encoder
```
public HTTPSOAP11Encoder()
```
    Constructor.
- Method Detail
  - prepareContext
```
public void prepareContext()
                    throws org.opensaml.messaging.encoder.MessageEncodingException
```
    Specified by:
    
    prepareContext in interface org.opensaml.messaging.encoder.MessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
    
    Overrides:
    
    prepareContext in class org.opensaml.messaging.encoder.AbstractMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
    
    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<MessageType extends org.opensaml.core.xml.XMLObject>
    
    Throws:
    
    org.opensaml.messaging.encoder.MessageEncodingException
  - 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
                                        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<MessageType extends org.opensaml.core.xml.XMLObject>

Class HTTPSOAP11Encoder<MessageType extends org.opensaml.core.xml.XMLObject>

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

log

envBuilder

bodyBuilder

Constructor Detail

HTTPSOAP11Encoder

Method Detail

prepareContext

doEncode

storeSOAPEnvelope

getSOAPEnvelope

buildAndStoreSOAPMessage

prepareHttpServletResponse

getSOAPAction

getHTTPResponseStatusCode

getMessageToLog