org.opensaml.ws.message.decoder

クラス BaseMessageDecoder

java.lang.Object

org.opensaml.ws.message.decoder.BaseMessageDecoder

すべての実装されたインタフェース:

MessageDecoder

直系の既知のサブクラス:

BaseHandlerChainAwareMessageDecoder, BaseSAMLMessageDecoder

public abstract class BaseMessageDecoder
extends Object
implements MessageDecoder

Base class for message decoders.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseMessageDecoder() Constructor.
BaseMessageDecoder(ParserPool pool) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	decode(MessageContext messageContext) Decodes a message in a binding specific manner.
protected abstract void	doDecode(MessageContext messageContext) Decodes a message, updating the message context.
protected ParserPool	getParserPool() Gets the parser pool used to deserialize incomming messages.
protected void	logDecodedMessage(MessageContext messageContext) Log the decoded message to the protocol message logger.
protected void	processSecurityPolicy(MessageContext messageContext) Process any SecurityPolicys which can be resolved for the message context.
protected void	setParserPool(ParserPool pool) Sets the parser pool used to deserialize incomming messages.
protected XMLObject	unmarshallMessage(InputStream messageStream) Helper method that deserializes and unmarshalls the message from the given stream.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

BaseMessageDecoder

public BaseMessageDecoder()

Constructor.

BaseMessageDecoder

public BaseMessageDecoder(ParserPool pool)

Constructor.

パラメータ:

pool - parser pool used to deserialize messages

メソッドの詳細

decode

public void decode(MessageContext messageContext)
            throws MessageDecodingException,
                   SecurityException

Decodes a message in a binding specific manner.

定義:

decode インタフェース内 MessageDecoder

パラメータ:

messageContext - current message context

例外:

MessageDecodingException - thrown if the message can not be decoded

SecurityException - thrown if the decoded message does not meet the required security constraints

logDecodedMessage

protected void logDecodedMessage(MessageContext messageContext)

Log the decoded message to the protocol message logger.

パラメータ:

messageContext - the message context to process

processSecurityPolicy

protected void processSecurityPolicy(MessageContext messageContext)
                              throws SecurityException

Process any SecurityPolicys which can be resolved for the message context.

パラメータ:

messageContext - the message context to process

例外:

SecurityException - thrown if the decoded message does not meet the required security constraints

doDecode

protected abstract void doDecode(MessageContext messageContext)
                          throws MessageDecodingException

Decodes a message, updating the message context. Security policy evaluation is handled outside this method.

パラメータ:

messageContext - current message context

例外:

MessageDecodingException - thrown if there is a problem decoding the message

getParserPool

protected ParserPool getParserPool()

Gets the parser pool used to deserialize incomming messages.

戻り値:

parser pool used to deserialize incomming messages

setParserPool

protected void setParserPool(ParserPool pool)

Sets the parser pool used to deserialize incomming messages.

パラメータ:

pool - parser pool used to deserialize incomming messages

unmarshallMessage

protected XMLObject unmarshallMessage(InputStream messageStream)
                               throws MessageDecodingException

Helper method that deserializes and unmarshalls the message from the given stream.

パラメータ:

messageStream - input stream containing the message

戻り値:

the inbound message

例外:

MessageDecodingException - thrown if there is a problem deserializing and unmarshalling the message