Package org.ow2.authzforce.core.pdp.api

Interface EvaluationContext.Listener

Enclosing interface:

EvaluationContext

public static interface EvaluationContext.Listener

Evaluation context listener. Can be used for instance by PDP extensions to be notified when the evaluation context is used (by the PDP engine typically) and then do specific actions in this case.

Method Summary

Modifier and Type	Method	Description
<AV extends AttributeValue> void	attributeSelectorResultConsumed(AttributeSelectorExpression<AV> attributeSelector, Bag<AV> result)	To be called when EvaluationContext.getAttributeSelectorResult(AttributeSelectorExpression) is called
<AV extends AttributeValue> void	attributeSelectorResultProduced(AttributeSelectorExpression<AV> attributeSelector, Optional<AttributeBag<XPathValue>> contextSelectorBag, Bag<AV> result)	To be called when EvaluationContext.putAttributeSelectorResultIfAbsent(AttributeSelectorExpression, Bag) is called iff the result was not available in the context yet (i.e.
<AV extends AttributeValue> void	namedAttributeValueConsumed(AttributeFqn attributeFQN, AttributeBag<AV> value)	To be called when EvaluationContext.getNamedAttributeValue(AttributeFqn, Datatype) is called
<AV extends AttributeValue> void	namedAttributeValueProduced(AttributeFqn attributeFQN, AttributeBag<AV> value)	To be called when EvaluationContext.putNamedAttributeValue(AttributeFqn, AttributeBag, boolean) is called iff the value was not available in the context yet (i.e.

Method Detail

namedAttributeValueProduced

<AV extends AttributeValue> void namedAttributeValueProduced(AttributeFqn attributeFQN,
                                                             AttributeBag<AV> value)

To be called when EvaluationContext.putNamedAttributeValue(AttributeFqn, AttributeBag, boolean) is called iff the value was not available in the context yet (i.e. first time it is produced in the request context)

Parameters:

attributeFQN - attribute GUID (global ID = Category,Issuer,AttributeId)

value - attribute value bag

namedAttributeValueConsumed

<AV extends AttributeValue> void namedAttributeValueConsumed(AttributeFqn attributeFQN,
                                                             AttributeBag<AV> value)

To be called when EvaluationContext.getNamedAttributeValue(AttributeFqn, Datatype) is called

Parameters:

attributeFQN - attribute GUID (global ID = Category,Issuer,AttributeId)

value - attribute value bag; null if the request named attribute was undefined in this context

attributeSelectorResultProduced

<AV extends AttributeValue> void attributeSelectorResultProduced(AttributeSelectorExpression<AV> attributeSelector,
                                                                 Optional<AttributeBag<XPathValue>> contextSelectorBag,
                                                                 Bag<AV> result)

To be called when EvaluationContext.putAttributeSelectorResultIfAbsent(AttributeSelectorExpression, Bag) is called iff the result was not available in the context yet (i.e. first time it is produced in the request context)

Parameters:

attributeSelector - attribute selector

contextSelectorBag - (optional) xPath-expression value of attribute referenced by ContextSelectorId if present

result - evaluation result

attributeSelectorResultConsumed

<AV extends AttributeValue> void attributeSelectorResultConsumed(AttributeSelectorExpression<AV> attributeSelector,
                                                                 Bag<AV> result)

To be called when EvaluationContext.getAttributeSelectorResult(AttributeSelectorExpression) is called

Parameters:

attributeSelector - attribute selector

result - evaluation result