org.opensaml.messaging.context

Interface MessageContextEvaluatingFunctor<MessageType,T>

Type Parameters:

MessageType - the message type of the message context on which to operate

T - the type of product of the component

public interface MessageContextEvaluatingFunctor<MessageType,T>

An interface for components which evaluate a MessageContext as the basis for extracting, calculating, or otherwise producing a specific data value.

Implementations should not have side effects and should not modify any data in the underlying message context. For a component that is intended to allow message context modification, see MessageContextMutatingFunctor.

Method Summary

Modifier and Type	Method and Description
T	evaluate(MessageContext<MessageType> msgContext) Using the specified MessageContext as the evaluation context, produce a data value product of the appropriate type.

Method Detail

evaluate

T evaluate(MessageContext<MessageType> msgContext)
    throws MessageException

Using the specified MessageContext as the evaluation context, produce a data value product of the appropriate type.

Parameters:

msgContext - the message context to evaluate

Returns:

value product based on the message context, or null

Throws:

MessageException - if there is a fatal error evaluating the context