{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The bean named ","type":"text"},{"text":"shibboleth.Functions.Scripted","type":"text","marks":[{"type":"strong"}]},{"text":" executes a JSR-223 scriptlet to implement an arbitrary ","type":"text"},{"text":"Function","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-jdk.cgi/java.util.function.Function"}}]},{"text":" signature.","type":"text"}]},{"type":"paragraph","content":[{"text":"The bean named ","type":"text"},{"text":"shibboleth.BiFunctions.Scripted","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"4.1","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"text":" executes a JSR-223 scriptlet to implement an arbitrary ","type":"text"},{"text":"BiFunction","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-jdk.cgi/java.util.function.BiFunction"}}]},{"text":" signature.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"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 (","type":"text"},{"text":"Function","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-support.cgi/net.shibboleth.utilities.java.support.logic.ScriptedFunction"}}]},{"text":", ","type":"text"},{"text":"BiFunction","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-support.cgi/net.shibboleth.utilities.java.support.logic.ScriptedBiFunction"}}]},{"text":") for complete details.","type":"text"}]},{"type":"expand","attrs":{"title":"inlineScript"},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n","type":"text"}]}]},{"type":"expand","attrs":{"title":"resourceScript"},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reference","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"expand","attrs":{"title":"Bean Properties"},"content":[{"type":"paragraph","content":[{"text":"The following additional bean properties are available:","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"table","attrs":{"layout":"full-width","localId":"6437b9fc-8ade-42ee-b81e-23a021782d5c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"PropertyName","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"customObject","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Bean/Reference","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"An object to make available to the script via a variable named ","type":"text"},{"text":"custom","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"returnOnError","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"null","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"What to return if the script fails","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"hideExceptions","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"If true, then the ","type":"text"},{"text":"returnOnError","type":"text","marks":[{"type":"code"}]},{"text":" value is returned if the script raises an exception, otherwise the exception is passed out","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"inputType","type":"text"}]},{"type":"paragraph","content":[{"text":"(Function variant)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Class","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Adds type checking against the input to the function to enforce type safety","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"inputTypes","type":"text"}]},{"type":"paragraph","content":[{"text":"(BiFunction variant)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Pair,Class>","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Adds type checking against the input to the function to enforce type safety","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"outputType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[223.0]},"content":[{"type":"paragraph","content":[{"text":"Class","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[98.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Adds type checking against the output of the function to enforce type safety","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Script Context"},"content":[{"type":"paragraph","content":[{"text":"For the Function variant, the script environment will have these variables populated:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"input","type":"text","marks":[{"type":"code"}]},{"text":" - the function input","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"custom","type":"text","marks":[{"type":"code"}]},{"text":" - the object set via the ","type":"text"},{"text":"customObject","type":"text","marks":[{"type":"code"}]},{"text":" property, if any","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For the BiFunction variant, the script environment will have these variables populated:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"input1","type":"text","marks":[{"type":"code"}]},{"text":" - the first function input","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"input2","type":"text","marks":[{"type":"code"}]},{"text":" - the second function input","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"custom","type":"text","marks":[{"type":"code"}]},{"text":" - the object set via the ","type":"text"},{"text":"customObject","type":"text","marks":[{"type":"code"}]},{"text":" property, if any","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported