Package org.opensaml.messaging.decoder

Class AbstractMessageDecoder

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder

Direct Known Subclasses:

AbstractHttpClientResponseMessageDecoder, AbstractHttpServletRequestMessageDecoder

public abstract class AbstractMessageDecoder
extends AbstractInitializableComponent
implements MessageDecoder, UnmodifiableComponent

Abstract message decoder.

Field Summary

Fields

Modifier and Type	Field	Description
private MessageContext	messageContext	Message context.

Constructor Summary

Constructors

Constructor	Description
AbstractMessageDecoder()

Method Summary

Modifier and Type	Method	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	getMessageContext()	Get the decoded message context.
protected void	setMessageContext(MessageContext 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.DestructableComponent

destroy, isDestroyed

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

initialize, isInitialized

Field Details

messageContext

private MessageContext messageContext

Message context.

Constructor Details

AbstractMessageDecoder

public AbstractMessageDecoder()

Method Details

getMessageContext

public MessageContext getMessageContext()

Get the decoded message context.

Specified by:

getMessageContext in interface MessageDecoder

Returns:

the decoded message context

setMessageContext

protected void setMessageContext(MessageContext 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

Throws:

MessageDecodingException - if there is a problem decoding the message context

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class 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