org.opensaml.ws.message.encoder

Class BaseMessageEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

All Implemented Interfaces:

MessageEncoder

Direct Known Subclasses:

BaseHandlerChainAwareMessageEncoder, BaseSAML1MessageEncoder, BaseSAML2MessageEncoder

public abstract class BaseMessageEncoder
extends Object
implements MessageEncoder

Base class for message decoders.

Constructor Summary

Constructors

Constructor and Description
BaseMessageEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doEncode(MessageContext messageContext) Encodes the outbound message onto the outbound transport.
void	encode(MessageContext messageContext) Encodes the message in the binding specific manner.
protected void	logEncodedMessage(MessageContext messageContext) Log the encoded message to the protocol message logger.
protected Element	marshallMessage(XMLObject message) Helper method that marshalls the given message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.ws.message.encoder.MessageEncoder

providesMessageConfidentiality, providesMessageIntegrity

Constructor Detail

BaseMessageEncoder

public BaseMessageEncoder()

Constructor.

Method Detail

encode

public void encode(MessageContext messageContext)
            throws MessageEncodingException

Encodes the message in the binding specific manner.

Specified by:

encode in interface MessageEncoder

Parameters:

messageContext - current message context

Throws:

MessageEncodingException - thrown if the problem can not be encoded

logEncodedMessage

protected void logEncodedMessage(MessageContext messageContext)

Log the encoded message to the protocol message logger.

Parameters:

messageContext - the message context to process

doEncode

protected abstract void doEncode(MessageContext messageContext)
                          throws MessageEncodingException

Encodes the outbound message onto the outbound transport.

Parameters:

messageContext - current message context

Throws:

MessageEncodingException - thrown if there is a problem encoding the message

marshallMessage

protected Element marshallMessage(XMLObject message)
                           throws MessageEncodingException

Helper method that marshalls the given message.

Parameters:

message - message the marshall and serialize

Returns:

marshalled message

Throws:

MessageEncodingException - thrown if the give message can not be marshalled into its DOM representation