Package net.shibboleth.idp.attribute.filter.policyrule.impl

Class ScriptedPolicyRule

java.lang.Object

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

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.policyrule.impl.ScriptedPolicyRule

All Implemented Interfaces:

PolicyRequirementRule, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent

@ThreadSafe
public class ScriptedPolicyRule
extends AbstractIdentifiableInitializableComponent
implements PolicyRequirementRule, UnmodifiableComponent

A PolicyRequirementRule that delegates to a JSR-223 script for its actual processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ScriptedPolicyRule.PolicyRuleScriptEvaluator	Evaluator bound to the Matcher semantic.

Nested classes/interfaces inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule

PolicyRequirementRule.Tristate

Field Summary

Fields

Modifier and Type	Field	Description
private Object	customObject	The custom object we inject into all scripts.
private org.slf4j.Logger	log	Class logger.
private Function<AttributeFilterContext,ProfileRequestContext>	prcLookupStrategy	Strategy used to locate the ProfileRequestContext to use.
private Function<ProfileRequestContext,SubjectContext>	scLookupStrategy	Strategy used to locate the SubjectContext to use.
private EvaluableScript	script	Script to be evaluated.
private ScriptedPolicyRule.PolicyRuleScriptEvaluator	scriptEvaluator	Evaluator.

Fields inherited from interface net.shibboleth.idp.attribute.filter.PolicyRequirementRule

MATCHES_ALL, MATCHES_NONE, REQUIREMENT_RULE_FAILS

Constructor Summary

Constructors

Constructor	Description
ScriptedPolicyRule()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
boolean	equals(Object obj)
Object	getCustomObject()	Return the custom (externally provided) object.
EvaluableScript	getScript()	Gets the script to be evaluated.
int	hashCode()
PolicyRequirementRule.Tristate	matches(AttributeFilterContext filterContext)	Calculate the PolicyRule.
void	setCustomObject(Object object)	Set the custom (externally provided) object.
void	setProfileRequestContextLookupStrategy(Function<AttributeFilterContext,ProfileRequestContext> strategy)	Set the strategy used to locate the ProfileRequestContext associated with a given AttributeFilterContext.
void	setScript(EvaluableScript matcherScript)	Sets the script to be evaluated.
void	setSubjectContextLookupStrategy(Function<ProfileRequestContext,SubjectContext> strategy)	Set the strategy used to locate the SubjectContext associated with a given ProfileRequestContext.
String	toString()

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

setId

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

getId

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

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

script

@NonnullAfterInit
private EvaluableScript script

Script to be evaluated.

scriptEvaluator

@NonnullAfterInit
private ScriptedPolicyRule.PolicyRuleScriptEvaluator scriptEvaluator

Evaluator.

prcLookupStrategy

@Nonnull
private Function<AttributeFilterContext,ProfileRequestContext> prcLookupStrategy

Strategy used to locate the ProfileRequestContext to use.

scLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SubjectContext> scLookupStrategy

Strategy used to locate the SubjectContext to use.

customObject

@Nullable
private Object customObject

The custom object we inject into all scripts.

Constructor Details

ScriptedPolicyRule

public ScriptedPolicyRule()

Constructor.

Method Details

getCustomObject

@Nullable
public Object getCustomObject()

Return the custom (externally provided) object.

Returns:

the custom object

setCustomObject

public void setCustomObject(@Nullable
Object object)

Set the custom (externally provided) object.

Parameters:

object - the custom object

getScript

@NonnullAfterInit
public EvaluableScript getScript()

Gets the script to be evaluated.

Returns:

the script to be evaluated

setScript

public void setScript(@Nonnull
EvaluableScript matcherScript)

Sets the script to be evaluated.

Parameters:

matcherScript - the script to be evaluated

setProfileRequestContextLookupStrategy

public void setProfileRequestContextLookupStrategy(@Nonnull
Function<AttributeFilterContext,ProfileRequestContext> strategy)

Set the strategy used to locate the ProfileRequestContext associated with a given AttributeFilterContext.

Parameters:

strategy - strategy used to locate the ProfileRequestContext associated with a given AttributeFilterContext

setSubjectContextLookupStrategy

public void setSubjectContextLookupStrategy(@Nonnull
Function<ProfileRequestContext,SubjectContext> strategy)

Set the strategy used to locate the SubjectContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the SubjectContext associated with a given ProfileRequestContext

matches

@Nonnull
public PolicyRequirementRule.Tristate matches(@Nonnull
AttributeFilterContext filterContext)

Calculate the PolicyRule.

When the script is evaluated, the following property will be available via the ScriptContext:

• filterContext - the current instance of AttributeFilterContext

The script MUST return a Boolean

Evaluate what this rule means.

Specified by:

matches in interface PolicyRequirementRule

Parameters:

filterContext - the context.

Returns:

whether the rule holds

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object