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

Class HTTPSOAP11Decoder<MessageType extends XMLObject>

java.lang.Object

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

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

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder<MessageType>

org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<MessageType>

org.opensaml.soap.soap11.decoder.http.impl.HTTPSOAP11Decoder<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, MessageDecoder<MessageType>, HttpServletRequestMessageDecoder<MessageType>

Direct Known Subclasses:

HTTPSOAP11Decoder, HTTPSOAP11Decoder

public class HTTPSOAP11Decoder<MessageType extends XMLObject>
extends BaseHttpServletRequestXMLMessageDecoder<MessageType>

Basic SOAP 1.1 decoder for HTTP transport.

This decoder takes a mandatory MessageHandler instance which is used to determine 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.

Constructor Summary

Constructors

Constructor and Description
HTTPSOAP11Decoder()

Method Summary

Modifier and Type	Method and Description
protected void	doDecode() Performs the decoding logic.
protected void	doInitialize()
MessageHandler<MessageType>	getBodyHandler() Get the configured body handler MessageHandler.
protected XMLObject	getMessageToLog() Get the XMLObject which will be logged as the protocol message.
void	setBodyHandler(MessageHandler<MessageType> newBodyHandler) Set the configured body handler MessageHandler.

Methods inherited from class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder

decode, doDestroy, getParserPool, logDecodedMessage, setParserPool, unmarshallMessage

Methods inherited from class org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

getHttpServletRequest, setHttpServletRequest

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

Constructor Detail

HTTPSOAP11Decoder

public HTTPSOAP11Decoder()

Method Detail

getBodyHandler

public MessageHandler<MessageType> getBodyHandler()

Get the configured body handler MessageHandler.

Returns:

Returns the bodyHandler.

setBodyHandler

public void setBodyHandler(MessageHandler<MessageType> newBodyHandler)

Set the configured body handler MessageHandler.

Parameters:

newBodyHandler - The bodyHandler to set.

doDecode

protected void doDecode()
                 throws MessageDecodingException

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

Specified by:

doDecode in class AbstractMessageDecoder<MessageType extends XMLObject>

Throws:

MessageDecodingException - thrown if there is a problem decoding the message

doInitialize

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

Overrides:

doInitialize in class BaseHttpServletRequestXMLMessageDecoder<MessageType extends XMLObject>

Throws:

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

getMessageToLog

protected XMLObject getMessageToLog()

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

Overrides:

getMessageToLog in class BaseHttpServletRequestXMLMessageDecoder<MessageType extends XMLObject>

Returns:

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