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

Class ScriptedBiFunction<T,​U,​V>

java.lang.Object
net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator
net.shibboleth.utilities.java.support.logic.ScriptedBiFunction<T,​U,​V>
Type Parameters:
T - first input type
U - second input type
V - return type
All Implemented Interfaces:
BiFunction<T,​U,​V>
public class ScriptedBiFunction<T,​U,​V>
extends AbstractScriptEvaluator
implements BiFunction<T,​U,​V>
A BiFunction which calls out to a supplied script.
Since:
8.2.0

  • Field Details

    • log

      @Nonnull private final org.slf4j.Logger log
      Class logger.

    • inputTypes

      @Nullable private Pair<Class<T>,​Class<U>> inputTypes
      Input types.

  • Constructor Details

  • Method Details

    • getInputTypes

      @Nullable public Pair<Class<T>,​Class<U>> getInputTypes()
      Get the input type to be enforced.
      Returns:
      input type

    • setInputTypes

      public void setInputTypes​(@Nullable Pair<Class<T>,​Class<U>> types)
      Set the input types to be enforced.
      Parameters:
      types - the input types

    • setOutputType

      public void setOutputType​(@Nullable Class<?> type)
      Set the output type to be enforced.
      Overrides:
      setOutputType in class AbstractScriptEvaluator
      Parameters:
      type - output 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

      @Nullable public V apply​(@Nullable T first, @Nullable U second)
      Specified by:
      apply in interface BiFunction<T,​U,​V>

    • 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,​ V> ScriptedBiFunction<T,​U,​V> resourceScript​(@Nonnull @NotEmpty String engineName, @Nonnull Resource resource) throws ScriptException, IOException
      Factory to create ScriptedBiFunction from a Resource.
      Type Parameters:
      T - first input type
      U - second input type
      V - return 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,​ V> ScriptedBiFunction<T,​U,​V> resourceScript​(Resource resource) throws ScriptException, IOException
      Factory to create ScriptedBiFunction from a Resource.
      Type Parameters:
      T - first input type
      U - second input type
      V - return 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,​ V> ScriptedBiFunction<T,​U,​V> inlineScript​(@Nonnull @NotEmpty String engineName, @Nonnull @NotEmpty String scriptSource) throws ScriptException
      Factory to create ScriptedBiFunction from inline data.
      Type Parameters:
      T - first input type
      U - second input type
      V - return 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,​ V> ScriptedBiFunction<T,​U,​V> inlineScript​(@Nonnull @NotEmpty String scriptSource) throws ScriptException
      Factory to create ScriptedBiFunction from inline data.
      Type Parameters:
      T - first input type
      U - second input type
      V - return type
      Parameters:
      scriptSource - the script, as a string
      Returns:
      the function
      Throws:
      ScriptException - if the compile fails