org.opensaml.messaging.encoder.servlet

Class BaseHttpServletResponseXMLMessageEncoder<MessageType extends XMLObject>

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>

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, MessageEncoder<MessageType>, HttpServletResponseMessageEncoder<MessageType>

public abstract class BaseHttpServletResponseXMLMessageEncoder<MessageType extends XMLObject>
extends AbstractHttpServletResponseMessageEncoder<MessageType>

Base class for message encoders which encode XML messages to HttpServletResponse.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private Logger	protocolMessageLog Used to log protocol messages.

Constructor Summary

Constructors

Constructor and Description
BaseHttpServletResponseXMLMessageEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	encode() Encode the MessageContext supplied via MessageEncoder.setMessageContext(MessageContext) to the sink.
protected XMLObject	getMessageToLog() Get the XMLObject which will be logged as the protocol message.
protected void	logEncodedMessage() 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 org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

doDestroy, doInitialize, getHttpServletResponse, setHttpServletResponse

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

doEncode, getMessageContext, prepareContext, 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

prepareContext, 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

protocolMessageLog

private Logger protocolMessageLog

Used to log protocol messages.

log

private final Logger log

Class logger.

Constructor Detail

BaseHttpServletResponseXMLMessageEncoder

public BaseHttpServletResponseXMLMessageEncoder()

Method Detail

encode

public void encode()
            throws MessageEncodingException

Encode the MessageContext supplied via MessageEncoder.setMessageContext(MessageContext) to the sink.

Specified by:

encode in interface MessageEncoder<MessageType extends XMLObject>

Overrides:

encode in class AbstractMessageEncoder<MessageType extends XMLObject>

Throws:

MessageEncodingException - if there is a problem encoding the message context

logEncodedMessage

protected void logEncodedMessage()

Log the encoded message to the protocol message logger.

getMessageToLog

protected XMLObject getMessageToLog()

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

Returns:

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

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