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:

com.google.common.base.Function<T,U>

public class ScriptedFunction<T,U>
extends AbstractScriptEvaluator
implements com.google.common.base.Function<T,U>

A Function which calls out to a supplied script.

Since:

7.4.0

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
U	apply(T input)
Class	getInputType() Get the input type to be enforced.
(package private) static ScriptedFunction	inlineScript(String scriptSource) Factory to create ScriptedFunction from inline data.
(package private) static ScriptedFunction	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.
(package private) static ScriptedFunction	resourceScript(Resource resource) Factory to create ScriptedFunction from a Resource.
(package private) static ScriptedFunction	resourceScript(String engineName, Resource resource) Factory to create ScriptedFunction from a Resource.
void	setInputType(Class 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 com.google.common.base.Function

equals

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 getInputType()

Get the input type to be enforced.

Returns:

input type

setInputType

public void setInputType(@Nullable
                Class 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 com.google.common.base.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

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

Factory to create ScriptedFunction from a Resource.

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

static ScriptedFunction resourceScript(Resource resource)
                                throws ScriptException,
                                       IOException

Factory to create ScriptedFunction from a Resource.

Parameters:

resource - the resource to look at

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineScript

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

Factory to create ScriptedFunction from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineScript

static ScriptedFunction inlineScript(@Nonnull@NotEmpty
                            String scriptSource)
                              throws ScriptException

Factory to create ScriptedFunction from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the function

Throws:

ScriptException - if the compile fails