Package org.forgerock.openig.script

Interface ScriptFactory

All Known Implementing Classes:
GroovyScriptFactory
public interface ScriptFactory
A factory for Scripts.

  • Method Details

    • init

      ScriptFactory init(Environment environment) throws ScriptException
      Initialize the factory with the given environment.
      Parameters:
      environment - the current environment information
      Returns:
      this factory to allow method chaining
      Throws:
      ScriptException - if the initialization failed

    • createResource

      Script createResource(String resource) throws ScriptException
      Build a new Script instance from a resource name.

      The resource name can either:

      • a relative path to the script base directory
      • an absolute URL
      Parameters:
      resource - Script resource name
      Returns:
      a new Script instance
      Throws:
      ScriptException - if resource is not available or if any pre-validation failed

    • createInline

      Script createInline(String... lines) throws ScriptException
      Build a new Script instance from the given lines representing the script content.
      Parameters:
      lines - script content
      Returns:
      a new Script instance
      Throws:
      ScriptException - if any pre-validation failed

    • mimeType

      String mimeType()
      Returns the mime-type of the script supported by this factory.
      Returns:
      the mime-type of the script supported by this factory.