Module net.shibboleth.utilities.java.support

Package net.shibboleth.utilities.java.support.logic

Class ScriptedFunction<T,U>

java.lang.Object

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

net.shibboleth.utilities.java.support.logic.ScriptedFunction<T,U>

Type Parameters:

T - input type

U - output type

All Implemented Interfaces:

Function<T,U>

public class ScriptedFunction<T,U>
extends AbstractScriptEvaluator
implements Function<T,U>

A Function which calls out to a supplied script.

Since:

7.4.0

Field Summary

Fields

Modifier and Type	Field	Description
private Class<T>	inputTypeClass	Input Type.
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	Description
protected	ScriptedFunction(EvaluableScript theScript)	Constructor.
protected	ScriptedFunction(EvaluableScript theScript, String extraInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
U	apply(T input)
Class<T>	getInputType()	Get the input type to be enforced.
static <T,U> ScriptedFunction<T,U>	inlineScript(String scriptSource)	Factory to create ScriptedFunction from inline data.
static <T,U> ScriptedFunction<T,U>	inlineScript(String engineName, String scriptSource)	Factory to create ScriptedFunction from inline data.
protected void	prepareContext(ScriptContext scriptContext, Object... input)	Pre-process the script context before execution.
static <T,U> ScriptedFunction<T,U>	resourceScript(String engineName, Resource resource)	Factory to create ScriptedFunction from a Resource.
static <T,U> ScriptedFunction<T,U>	resourceScript(Resource resource)	Factory to create ScriptedFunction from a Resource.
void	setInputType(Class<T> type)	Set the input type to be enforced.
void	setOutputType(Class<?> type)	Set the output type to be enforced.
void	setReturnOnError(Object value)	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

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.Function

andThen, compose

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

inputTypeClass

@Nullable
private Class<T> inputTypeClass

Input Type.

Constructor Detail

ScriptedFunction

protected ScriptedFunction(@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.

ScriptedFunction

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

Constructor.

Parameters:

theScript - the script we will evaluate.

Method Detail

setOutputType

public void setOutputType(@Nullable
                          Class<?> type)

Set the output type to be enforced.

Overrides:

setOutputType in class AbstractScriptEvaluator

Parameters:

type - output type

getInputType

@Nullable
public Class<T> getInputType()

Get the input type to be enforced.

Returns:

input type

setInputType

public void setInputType(@Nullable
                         Class<T> type)

Set the input type to be enforced.

Parameters:

type - input type

setReturnOnError

public void setReturnOnError(@Nullable
                             Object value)

Set value to return if an error occurs.

Overrides:

setReturnOnError in class AbstractScriptEvaluator

Parameters:

value - value to return

apply

public U apply(@Nullable
               T input)

Specified by:

apply in interface Function<T,U>

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

public static <T,U> ScriptedFunction<T,U> resourceScript(@Nonnull @NotEmpty
                                                                     String engineName,
                                                                     @Nonnull
                                                                     Resource resource)
                                                              throws ScriptException,
                                                                     IOException

Factory to create ScriptedFunction from a Resource.

Type Parameters:

T - input type

U - output type

Parameters:

resource - the resource to look at

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

public static <T,U> ScriptedFunction<T,U> resourceScript(Resource resource)
                                                              throws ScriptException,
                                                                     IOException

Factory to create ScriptedFunction from a Resource.

Type Parameters:

T - input type

U - output type

Parameters:

resource - the resource to look at

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineScript

public static <T,U> ScriptedFunction<T,U> inlineScript(@Nonnull @NotEmpty
                                                                   String engineName,
                                                                   @Nonnull @NotEmpty
                                                                   String scriptSource)
                                                            throws ScriptException

Factory to create ScriptedFunction from inline data.

Type Parameters:

T - input type

U - output type

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineScript

public static <T,U> ScriptedFunction<T,U> inlineScript(@Nonnull @NotEmpty
                                                                   String scriptSource)
                                                            throws ScriptException

Factory to create ScriptedFunction from inline data.

Type Parameters:

T - input type

U - output type

Parameters:

scriptSource - the script, as a string

Returns:

the function

Throws:

ScriptException - if the compile fails