HttpClientRequestSOAP11Encoder (OpenSAML :: SOAP Provider Implementations 3.3.0 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.encoder.AbstractMessageEncoder<MessageType>
  - - org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder<MessageType>
    - - org.opensaml.messaging.encoder.httpclient.BaseHttpClientRequestXMLMessageEncoder<MessageType>
      - org.opensaml.soap.client.soap11.encoder.http.impl.HttpClientRequestSOAP11Encoder<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, org.opensaml.messaging.encoder.httpclient.HttpClientRequestMessageEncoder<MessageType>, org.opensaml.messaging.encoder.MessageEncoder<MessageType>
```
public class HttpClientRequestSOAP11Encoder<MessageType extends org.opensaml.core.xml.XMLObject>
extends org.opensaml.messaging.encoder.httpclient.BaseHttpClientRequestXMLMessageEncoder<MessageType>
```
Basic SOAP 1.1 encoder for HTTP transport via an HttpClient's HttpRequest.

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

HttpClientRequestSOAP11Encoder()
Constructor.

Constructors
Constructor and Description
`HttpClientRequestSOAP11Encoder()` 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 org.apache.http.HttpEntity`	`createRequestEntity(Envelope message, Charset charset)` Create the request entity that makes up the POST message body.
`protected void`	`doEncode()`
`HttpPost`	`getHttpRequest()`
`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`	`prepareHttpRequest()` This implementation performs the following actions on the context's `HttpRequest`: Sets the SOAPAction HTTP header the value returned by `getSOAPAction()`, if that returns non-null.
`void`	`setHttpRequest(org.apache.http.HttpRequest httpRequest)`
`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.httpclient.BaseHttpClientRequestXMLMessageEncoder
encode, logEncodedMessage, marshallMessage

Methods inherited from class org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder
doDestroy, doInitialize

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 Logger log
```
    Class logger.
  - envBuilder
```
private SOAPObjectBuilder<Envelope> envBuilder
```
    SOAP Envelope builder.
  - bodyBuilder
```
private SOAPObjectBuilder<Body> bodyBuilder
```
    SOAP Body builder.
- Constructor Detail
  - HttpClientRequestSOAP11Encoder
```
public HttpClientRequestSOAP11Encoder()
```
    Constructor.
- Method Detail
  - getHttpRequest
```
@Nullable
public HttpPost getHttpRequest()
```
    This encoder implementation only operates on instances of HttpPost.
    
    Specified by:
    
    getHttpRequest in interface org.opensaml.messaging.encoder.httpclient.HttpClientRequestMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
    
    Overrides:
    
    getHttpRequest in class org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
  - setHttpRequest
```
public void setHttpRequest(org.apache.http.HttpRequest httpRequest)
```
    This encoder implementation only operates on instances of HttpPost.
    
    Specified by:
    
    setHttpRequest in interface org.opensaml.messaging.encoder.httpclient.HttpClientRequestMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
    
    Overrides:
    
    setHttpRequest in class org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>
  - 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
  - createRequestEntity
```
protected org.apache.http.HttpEntity createRequestEntity(@Nonnull
                                             Envelope message,
                                             @Nullable
                                             Charset charset)
                                                  throws org.opensaml.messaging.encoder.MessageEncodingException
```
    Create the request entity that makes up the POST message body.
    
    Parameters:
    message - message to be sent
    charset - character set used for the message
    
    Returns:
    request entity that makes up the POST message body
    
    Throws:
    
    org.opensaml.messaging.encoder.MessageEncodingException - thrown if the message could not be marshalled
  - 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
  - prepareHttpRequest
```
protected void prepareHttpRequest()
                           throws org.opensaml.messaging.encoder.MessageEncodingException
```
    This implementation performs the following actions on the context's HttpRequest:
    1. 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
  - getMessageToLog
```
protected org.opensaml.core.xml.XMLObject getMessageToLog()
```
    Overrides:
    
    getMessageToLog in class org.opensaml.messaging.encoder.httpclient.BaseHttpClientRequestXMLMessageEncoder<MessageType extends org.opensaml.core.xml.XMLObject>

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.opensaml.messaging.encoder.httpclient.BaseHttpClientRequestXMLMessageEncoder

Methods inherited from class org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder

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

HttpClientRequestSOAP11Encoder

Method Detail

getHttpRequest

setHttpRequest

prepareContext

doEncode

createRequestEntity

storeSOAPEnvelope

getSOAPEnvelope

buildAndStoreSOAPMessage

prepareHttpRequest

getSOAPAction

getMessageToLog