org.opensaml.soap.client.soap11.decoder.http.impl

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

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder<MessageType>

org.opensaml.messaging.decoder.httpclient.AbstractHttpClientResponseMessageDecoder<MessageType>

org.opensaml.messaging.decoder.httpclient.BaseHttpClientResponseXMLMessageDecoder<MessageType>

org.opensaml.soap.client.soap11.decoder.http.impl.HttpClientResponseSOAP11Decoder<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.decoder.httpclient.HttpClientResponseMessageDecoder<MessageType>, org.opensaml.messaging.decoder.MessageDecoder<MessageType>

public class HttpClientResponseSOAP11Decoder<MessageType extends org.opensaml.core.xml.XMLObject>
extends org.opensaml.messaging.decoder.httpclient.BaseHttpClientResponseXMLMessageDecoder<MessageType>

Basic SOAP 1.1 decoder for HTTP transport via an HttpClient's HttpResponse.

This decoder takes a mandatory MessageHandler instance which is used to populate the message that is returned as the MessageContext.getMessage().

A SOAP message oriented message exchange style might just populate the Envelope as the message. An application-specific payload-oriented message exchange would handle a specific type of payload structure.

Field Summary

Fields

Modifier and Type	Field and Description
private org.opensaml.messaging.handler.MessageHandler<MessageType>	bodyHandler Message handler to use in processing the message body.
private Logger	log Logger.

Constructor Summary

Constructors

Constructor and Description
HttpClientResponseSOAP11Decoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.opensaml.messaging.decoder.MessageDecodingException	buildFaultException(org.apache.http.HttpResponse response) Build an exception by processing a fault response, i.e.
protected void	doDecode()
protected void	doInitialize()
org.opensaml.messaging.handler.MessageHandler<MessageType>	getBodyHandler() Get the configured body handler MessageHandler.
protected Fault	getFault(Envelope soapMessage) Return the Fault element from the SOAP message, if any.
protected org.opensaml.core.xml.XMLObject	getMessageToLog()
protected void	processSuccessResponse(org.apache.http.HttpResponse httpResponse, SOAP11Context soapContext) Process a successful response, i.e.
void	setBodyHandler(org.opensaml.messaging.handler.MessageHandler<MessageType> newBodyHandler) Set the configured body handler MessageHandler.

Methods inherited from class org.opensaml.messaging.decoder.httpclient.BaseHttpClientResponseXMLMessageDecoder

decode, doDestroy, getParserPool, logDecodedMessage, setParserPool, unmarshallMessage

Methods inherited from class org.opensaml.messaging.decoder.httpclient.AbstractHttpClientResponseMessageDecoder

getHttpResponse, setHttpResponse

Methods inherited from class org.opensaml.messaging.decoder.AbstractMessageDecoder

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.decoder.MessageDecoder

getMessageContext

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

Logger.

bodyHandler

private org.opensaml.messaging.handler.MessageHandler<MessageType extends org.opensaml.core.xml.XMLObject> bodyHandler

Message handler to use in processing the message body.

Constructor Detail

HttpClientResponseSOAP11Decoder

public HttpClientResponseSOAP11Decoder()

Method Detail

getBodyHandler

public org.opensaml.messaging.handler.MessageHandler<MessageType> getBodyHandler()

Get the configured body handler MessageHandler.

Returns:

Returns the bodyHandler.

setBodyHandler

public void setBodyHandler(org.opensaml.messaging.handler.MessageHandler<MessageType> newBodyHandler)

Set the configured body handler MessageHandler.

Parameters:

newBodyHandler - The bodyHandler to set.

doDecode

protected void doDecode()
                 throws org.opensaml.messaging.decoder.MessageDecodingException

Specified by:

doDecode in class org.opensaml.messaging.decoder.AbstractMessageDecoder<MessageType extends org.opensaml.core.xml.XMLObject>

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

processSuccessResponse

protected void processSuccessResponse(org.apache.http.HttpResponse httpResponse,
                          SOAP11Context soapContext)
                               throws org.opensaml.messaging.decoder.MessageDecodingException,
                                      IOException

Process a successful response, i.e. one where the HTTP response code was 200.

Parameters:

httpResponse - the HTTP client response

soapContext - the SOAP11Context instance

Throws:

org.opensaml.messaging.decoder.MessageDecodingException - if message can not be unmarshalled

IOException - if there is a problem with the response entity input stream

buildFaultException

protected org.opensaml.messaging.decoder.MessageDecodingException buildFaultException(org.apache.http.HttpResponse response)
                                                                               throws org.opensaml.messaging.decoder.MessageDecodingException,
                                                                                      IOException

Build an exception by processing a fault response, i.e. one where the HTTP response code was 500.

Parameters:

response - the HTTP client response

Returns:

the message decoding exception representing the SOAP fault

Throws:

org.opensaml.messaging.decoder.MessageDecodingException - if message can not be unmarshalled

IOException - if there is a problem with the response entity input stream

getFault

protected Fault getFault(Envelope soapMessage)

Return the Fault element from the SOAP message, if any.

Parameters:

soapMessage - the SOAP 1.1. Envelope being processed

Returns:

the first Fault element found, or null

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class org.opensaml.messaging.decoder.httpclient.BaseHttpClientResponseXMLMessageDecoder<MessageType extends org.opensaml.core.xml.XMLObject>

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

getMessageToLog

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

Overrides:

getMessageToLog in class org.opensaml.messaging.decoder.httpclient.BaseHttpClientResponseXMLMessageDecoder<MessageType extends org.opensaml.core.xml.XMLObject>