org.opensaml.messaging.encoder

Class AbstractMessageEncoder<MessageType>

java.lang.Object

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

org.opensaml.messaging.encoder.AbstractMessageEncoder<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>

Direct Known Subclasses:

AbstractHttpServletResponseMessageEncoder

public abstract class AbstractMessageEncoder<MessageType>
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements MessageEncoder<MessageType>, net.shibboleth.utilities.java.support.component.UnmodifiableComponent

Abstract message encoder.

Field Summary

Fields

Modifier and Type	Field and Description
private MessageContext<MessageType>	messageContext The message context.

Constructor Summary

Constructors

Constructor and Description
AbstractMessageEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
protected abstract void	doEncode() Performs the encoding logic.
protected void	doInitialize()
void	encode() Encode the MessageContext supplied via MessageEncoder.setMessageContext(MessageContext) to the sink.
protected MessageContext<MessageType>	getMessageContext() Get the message context.
void	prepareContext() This method should prepare the message context by creating and populating any binding-specific data structures required in the MessageContext, prior to actually encoding.
void	setMessageContext(MessageContext<MessageType> context) Set the MessageContext which is to be encoded.

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.InitializableComponent

initialize, isInitialized

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

destroy, isDestroyed

Field Detail

messageContext

private MessageContext<MessageType> messageContext

The message context.

Constructor Detail

AbstractMessageEncoder

public AbstractMessageEncoder()

Method Detail

setMessageContext

public void setMessageContext(MessageContext<MessageType> context)

Set the MessageContext which is to be encoded.

Specified by:

setMessageContext in interface MessageEncoder<MessageType>

Parameters:

context - the message context

encode

public void encode()
            throws MessageEncodingException

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

Specified by:

encode in interface MessageEncoder<MessageType>

Throws:

MessageEncodingException - if there is a problem encoding the message context

prepareContext

public void prepareContext()
                    throws MessageEncodingException

This method should prepare the message context by creating and populating any binding-specific data structures required in the MessageContext, prior to actually encoding.

This method should be called after the MessageContext has been set, and before any binding-specific Handler or HandlerChains are invoked.

Example: For a SOAP encoder, this method would create and store the basic SOAP Envelope structure in the message context, so that Handlers that are invoked have a place to which to add headers.

This method may be a no-op if not required by the binding, or if the message type of the context implies that the binding-specific structures have already been created elsewhere (e.g. message-oriented code where the calling code already knows its SOAP, and is operating on the raw SOAP envelope anyway).

. Default implementation is a no-op.

Specified by:

prepareContext in interface MessageEncoder<MessageType>

Throws:

MessageEncodingException - if there is a problem preparing the message context for encoding

getMessageContext

protected MessageContext<MessageType> getMessageContext()

Get the message context.

Returns:

the message context.

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

doInitialize

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

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

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

doEncode

protected abstract void doEncode()
                          throws MessageEncodingException

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

Throws:

MessageEncodingException - thrown if there is a problem encoding the message