org.opensaml.messaging.decoder

Class AbstractMessageDecoder<MessageType>

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder<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>

Direct Known Subclasses:

AbstractHttpServletRequestMessageDecoder

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

Abstract message decoder.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractMessageDecoder()

Method Summary

Modifier and Type	Method and Description
void	decode() Decode message data from the source and store it so that it may be retrieved via MessageDecoder.getMessageContext().
protected abstract void	doDecode() Performs the decoding logic.
protected void	doDestroy()
MessageContext<MessageType>	getMessageContext() Get the decoded message context.
protected void	setMessageContext(MessageContext<MessageType> context) Set the message context.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doInitialize, 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

Message context.

Constructor Detail

AbstractMessageDecoder

public AbstractMessageDecoder()

Method Detail

getMessageContext

public MessageContext<MessageType> getMessageContext()

Get the decoded message context.

Specified by:

getMessageContext in interface MessageDecoder<MessageType>

Returns:

the decoded message context

setMessageContext

protected void setMessageContext(MessageContext<MessageType> context)

Set the message context.

Parameters:

context - the message context

decode

public void decode()
            throws MessageDecodingException

Decode message data from the source and store it so that it may be retrieved via MessageDecoder.getMessageContext().

Specified by:

decode in interface MessageDecoder<MessageType>

Throws:

MessageDecodingException - if there is a problem decoding the message context

doDestroy

protected void doDestroy()

Overrides:

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

doDecode

protected abstract 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.

Throws:

MessageDecodingException - thrown if there is a problem decoding the message