net.shibboleth.utilities.java.support.logic

Class ScriptedPredicate<T>

java.lang.Object

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

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

Type Parameters:

T - input type

All Implemented Interfaces:

com.google.common.base.Predicate<T>

public class ScriptedPredicate<T>
extends AbstractScriptEvaluator
implements com.google.common.base.Predicate<T>

A Predicate which calls out to a supplied script.

Since:

7.4.0

Field Summary

Fields

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

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

DEFAULT_ENGINE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptedPredicate(EvaluableScript theScript) Constructor.
protected	ScriptedPredicate(EvaluableScript theScript, String extraInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	apply(T input)
(package private) static ScriptedPredicate	inlineScript(String scriptSource) Factory to create ScriptedPredicate from inline data.
(package private) static ScriptedPredicate	inlineScript(String engineName, String scriptSource) Factory to create ScriptedPredicate from inline data.
protected void	prepareContext(ScriptContext scriptContext, Object... input) Pre-process the script context before execution.
(package private) static ScriptedPredicate	resourceScript(Resource resource) Factory to create ScriptedPredicate from a Resource.
(package private) static ScriptedPredicate	resourceScript(String engineName, Resource resource) Factory to create ScriptedPredicate from a Resource.
void	setReturnOnError(boolean flag) Set value to return if an error occurs.

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 com.google.common.base.Predicate

equals

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

ScriptedPredicate

protected 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

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

Constructor.

Parameters:

theScript - the script we will evaluate.

Method Detail

setReturnOnError

public void setReturnOnError(boolean flag)

Set value to return if an error occurs.

Parameters:

flag - value to return

apply

public boolean apply(@Nullable
                     T input)

Specified by:

apply in interface com.google.common.base.Predicate<T>

prepareContext

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

Pre-process the script context before execution.

Specified by:

prepareContext in class AbstractScriptEvaluator

Parameters:

scriptContext - the script context

input - the input

resourceScript

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

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

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

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