Package org.opensaml.messaging.encoder.servlet

Class BaseHttpServletResponseXMLMessageEncoder

java.lang.Object

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

org.opensaml.messaging.encoder.AbstractMessageEncoder

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageEncoder, HttpServletResponseMessageEncoder

Direct Known Subclasses:

BaseSAML1MessageEncoder, BaseSAML2MessageEncoder, HTTPSOAP11Encoder

public abstract class BaseHttpServletResponseXMLMessageEncoder
extends AbstractHttpServletResponseMessageEncoder

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
BaseHttpServletResponseXMLMessageEncoder()

Method Summary

Modifier and Type	Method	Description
void	encode()	Encode the MessageContext supplied via MessageEncoder.setMessageContext(MessageContext) to the sink.
protected Object	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

doInitialize, getHttpServletResponse, getHttpServletResponseSupplier, setHttpServletResponse, setHttpServletResponseSupplier

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

doDestroy, 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 net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface org.opensaml.messaging.encoder.MessageEncoder

prepareContext, setMessageContext

Field Details

protocolMessageLog

@Nonnull
private org.slf4j.Logger protocolMessageLog

Used to log protocol messages.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Details

BaseHttpServletResponseXMLMessageEncoder

public BaseHttpServletResponseXMLMessageEncoder()

Method Details

encode

public void encode()
            throws MessageEncodingException

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

Specified by:

encode in interface MessageEncoder

Overrides:

encode in class AbstractMessageEncoder

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

@Nullable
protected Object 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(@Nonnull
 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