net.shibboleth.idp.profile.logic

Class ScriptedPredicate

java.lang.Object

net.shibboleth.idp.profile.logic.ScriptedPredicate

All Implemented Interfaces:

Predicate<ProfileRequestContext>

public class ScriptedPredicate
extends Object
implements Predicate<ProfileRequestContext>

A Predicate which calls out to a supplied script.

Field Summary

Fields

Modifier and Type	Field and Description
private Object	customObject A custom object to inject into the script.
static String	DEFAULT_ENGINE The default language is Javascript.
private boolean	hideExceptions Whether to raise runtime exceptions if a script fails.
private org.slf4j.Logger	log log.
private String	logPrefix Debugging info.
private boolean	returnOnError Value to return from predicate when an error occurs.
private EvaluableScript	script The script we care about.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(ProfileRequestContext profileContext)
Object	getCustomObject() Return the custom (externally provided) object.
(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.
(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	setCustomObject(Object object) Set the custom (externally provided) object.
void	setHideExceptions(boolean flag) Set whether to hide exceptions in script execution (default is false).
void	setReturnOnError(boolean flag) Set value to return if an error occurs (default is false).

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

DEFAULT_ENGINE

public static final String DEFAULT_ENGINE

The default language is Javascript.

See Also:

Constant Field Values

log

private final org.slf4j.Logger log

log.

script

@Nonnull
private final EvaluableScript script

The script we care about.

logPrefix

@Nullable
private final String logPrefix

Debugging info.

customObject

@Nullable
private Object customObject

A custom object to inject into the script.

hideExceptions

private boolean hideExceptions

Whether to raise runtime exceptions if a script fails.

returnOnError

private boolean returnOnError

Value to return from predicate when an error occurs.

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

getCustomObject

@Nullable
public Object getCustomObject()

Return the custom (externally provided) object.

Returns:

the custom object

setCustomObject

public void setCustomObject(Object object)

Set the custom (externally provided) object.

Parameters:

object - the custom object

setHideExceptions

public void setHideExceptions(boolean flag)

Set whether to hide exceptions in script execution (default is false).

Parameters:

flag - flag to set

setReturnOnError

public void setReturnOnError(boolean flag)

Set value to return if an error occurs (default is false).

Parameters:

flag - flag to set

apply

public boolean apply(@Nullable
            ProfileRequestContext profileContext)

Specified by:

apply in interface Predicate<ProfileRequestContext>

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