ScriptedFunction

The bean named shibboleth.Functions.Scripted executes a JSR-223 scriptlet to implement an arbitrary Function signature.

The bean named shibboleth.BiFunctions.Scripted executes a JSR-223 scriptlet to implement an arbitrary BiFunction signature.

Configuration

A Scripted Function is instantiated using one of two static factory methods (rather than created directly by invoking a Java constructor), so they have a different syntax in Spring. You can refer to the javadoc (ScriptedFunction, ScriptedBiFunction) for complete details.

If provided with one parameter, this is the script to be executed. If two parameters are the provided, then the first is the name of the (installed) JSR-223 lanuage and the second is the script.

<bean id="MyFunction" parent="shibboleth.Functions.Scripted" factory-method="inlineScript"
		p:inputType="java.lang.Integer" p:outputType="java.lang.Integer"
		p:hideExceptions="true">
    <constructor-arg>
        <value>
        <![CDATA[
			input + 42;
         ]]>
        </value>
    </constructor-arg>
</bean>

If provided with one parameter this is the location (usually the file name) of the resource (file) containing the script. If two parameters are provided, the the first is the name of the (installed) JSR-223 lanuage and the second is the location.

<bean id="MyFunction" parent="shibboleth.Functions.Scripted" factory-method="resourceScript"
	c:_0="javascript" c:_1="%{idp.home}/conf/script.js" />

Reference

The following additional bean properties are available:

PropertyName	Type	Default	Description

PropertyName	Type	Default	Description
customObject	Bean/Reference		An object to make available to the script via a variable named `custom`
returnOnError	Object	null	What to return if the script fails
hideExceptions	boolean	false	If true, then the `returnOnError` value is returned if the script raises an exception, otherwise the exception is passed out
inputType (Function variant)	Class<?>		Adds type checking against the input to the function to enforce type safety
inputTypes (BiFunction variant)	Pair<Class<?>,Class<?>>		Adds type checking against the input to the function to enforce type safety
outputType	Class<?>		Adds type checking against the output of the function to enforce type safety

For the Function variant, the script environment will have these variables populated:

input - the function input
custom - the object set via the customObject property, if any

For the BiFunction variant, the script environment will have these variables populated:

input1 - the first function input
input2 - the second function input
custom - the object set via the customObject property, if any