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

Class ScriptedMatcher

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.filter.matcher.impl.ScriptedMatcher

All Implemented Interfaces:

Matcher, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent

@ThreadSafe
public class ScriptedMatcher
extends AbstractIdentifiableInitializableComponent
implements Matcher, UnmodifiableComponent

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ScriptedMatcher.MatcherScriptEvaluator	Evaluator bound to the Matcher semantic.

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<FilterScriptContextExtender>	contextExtenders	Extenders for script context.
private Object	customObject	Custom object for script.
private final org.slf4j.Logger	log	Class logger.
private EvaluableScript	script	The script to evaluate.
private ScriptedMatcher.MatcherScriptEvaluator	scriptEvaluator	Evaluator.

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

MATCHER_FAILS, MATCHES_ALL, MATCHES_NONE

Constructor Summary

Constructors

Constructor	Description
ScriptedMatcher()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
boolean	equals(Object obj)
Object	getCustomObject()	Return the custom (externally provided) object.
Set<IdPAttributeValue>	getMatchingValues(IdPAttribute attribute, AttributeFilterContext filterContext)	Perform the AttributeValueMatching.
EvaluableScript	getScript()	Gets the script to be evaluated.
int	hashCode()
void	setCustomObject(Object object)	Set the custom (externally provided) object.
void	setScript(EvaluableScript matcherScript)	Sets the script to be evaluated.
void	setScriptContextExtenders(Collection<FilterScriptContextExtender> extenders)	Set any script context extenders to apply.
String	toString()

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, 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.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

script

@NonnullAfterInit
private EvaluableScript script

The script to evaluate.

scriptEvaluator

@NonnullAfterInit
private ScriptedMatcher.MatcherScriptEvaluator scriptEvaluator

Evaluator.

contextExtenders

@Nonnull
private Collection<FilterScriptContextExtender> contextExtenders

Extenders for script context.

customObject

@Nullable
private Object customObject

Custom object for script.

Constructor Details

ScriptedMatcher

public ScriptedMatcher()

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

setScriptContextExtenders

public void setScriptContextExtenders(@Nullable
 Collection<FilterScriptContextExtender> extenders)

Set any script context extenders to apply.

Parameters:

extenders - script extenders

Since:

5.0.0

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

getMatchingValues

@Nullable
@Unmodifiable
public Set<IdPAttributeValue> getMatchingValues(@Nonnull
 IdPAttribute attribute,
 @Nonnull
 AttributeFilterContext filterContext)

Perform the AttributeValueMatching.

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

• filterContext - the current instance of AttributeFilterContext
• attribute - the attribute whose values are to be evaluated

The script MUST return a Set containing the IdPAttributeValue objects that were matched.

Return those IdPAttributeValues which match this rule, or null if the matcher failed.

Specified by:

getMatchingValues in interface Matcher

Parameters:

attribute - the attribute under question.

filterContext - the filter context

Returns:

The result of this rule. Null if we failed.

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