Package net.shibboleth.idp.profile.logic

Class ScriptedPredicate

java.lang.Object

net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

net.shibboleth.utilities.java.support.logic.ScriptedPredicate<ProfileRequestContext>

net.shibboleth.idp.profile.logic.ScriptedPredicate

All Implemented Interfaces:

Predicate<ProfileRequestContext>, Predicate<ProfileRequestContext>

public class ScriptedPredicate
extends ScriptedPredicate<ProfileRequestContext>

A Predicate which calls out to a supplied script.

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.

Fields inherited from class net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

DEFAULT_ENGINE

Constructor Summary

Constructors

Constructor	Description
ScriptedPredicate(EvaluableScript theScript)	Constructor.
ScriptedPredicate(EvaluableScript theScript, String extraInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ScriptedPredicate	inlineScript(String scriptSource)	Factory to create ScriptedPredicate from inline data.
static ScriptedPredicate	inlineScript(String engineName, String scriptSource)	Factory to create ScriptedPredicate from inline data.
protected void	prepareContext(ScriptContext scriptContext, Object... input)
static ScriptedPredicate	resourceScript(String engineName, Resource resource)	Factory to create ScriptedPredicate from a Resource.
static ScriptedPredicate	resourceScript(Resource resource)	Factory to create ScriptedPredicate from a Resource.

Methods inherited from class net.shibboleth.utilities.java.support.logic.ScriptedPredicate

getInputType, resourceScript, resourceScript, setInputType, setReturnOnError, test

Methods inherited from class net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

evaluate, finalizeContext, getCustomObject, getHideExceptions, getLogPrefix, getOutputType, getReturnOnError, setCustomObject, setHideExceptions, setLogPrefix, setOutputType, setReturnOnError

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Methods inherited from interface net.shibboleth.utilities.java.support.logic.Predicate

apply

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

ScriptedPredicate

public ScriptedPredicate(@Nonnull @NotEmpty @ParameterName(name="theScript")
                         EvaluableScript theScript,
                         @Nullable @NotEmpty @ParameterName(name="extraInfo")
                         String extraInfo)

Constructor.

Parameters:

theScript - the script we will evaluate.

extraInfo - debugging information.

ScriptedPredicate

public ScriptedPredicate(@Nonnull @NotEmpty @ParameterName(name="theScript")
                         EvaluableScript theScript)

Constructor.

Parameters:

theScript - the script we will evaluate.

Method Detail

prepareContext

protected void prepareContext(@Nonnull
                              ScriptContext scriptContext,
                              @Nullable
                              Object... input)

Overrides:

prepareContext in class ScriptedPredicate<ProfileRequestContext>

resourceScript

public static ScriptedPredicate resourceScript(@Nonnull @NotEmpty
                                               String engineName,
                                               @Nonnull
                                               Resource resource)
                                        throws ScriptException,
                                               IOException

Factory to create ScriptedPredicate from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

Returns:

the predicate

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

public static ScriptedPredicate resourceScript(Resource resource)
                                        throws ScriptException,
                                               IOException

Factory to create ScriptedPredicate from a Resource.

Parameters:

resource - the resource to look at

Returns:

the predicate

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineScript

public static ScriptedPredicate inlineScript(@Nonnull @NotEmpty
                                             String engineName,
                                             @Nonnull @NotEmpty
                                             String scriptSource)
                                      throws ScriptException

Factory to create ScriptedPredicate from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the predicate

Throws:

ScriptException - if the compile fails

inlineScript

public static ScriptedPredicate inlineScript(@Nonnull @NotEmpty
                                             String scriptSource)
                                      throws ScriptException

Factory to create ScriptedPredicate from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the predicate

Throws:

ScriptException - if the compile fails