Class ScriptingService

java.lang.Object
de.willuhn.jameica.services.ScriptingService
All Implemented Interfaces:
de.willuhn.boot.Bootable
public class ScriptingService extends Object implements de.willuhn.boot.Bootable
Interface fuer den Scripting-Service.

  • Field Details

    • QUEUE_ADDED

      public static final String QUEUE_ADDED
      Die Queue, die nach dem Hinzufuegen eines Scripts benachrichtigt wird.
      See Also:

    • QUEUE_REMOVED

      public static final String QUEUE_REMOVED
      Die Queue, die nach dem Entfernen eines Scripts benachrichtigt wird.
      See Also:

  • Constructor Details

    • ScriptingService

      public ScriptingService()

  • Method Details

    • depends

      public Class<de.willuhn.boot.Bootable>[] depends()
      Specified by:
      depends in interface de.willuhn.boot.Bootable
      See Also:
      • Bootable.depends()

    • init

      public void init(de.willuhn.boot.BootLoader loader, de.willuhn.boot.Bootable caller) throws de.willuhn.boot.SkipServiceException
      Specified by:
      init in interface de.willuhn.boot.Bootable
      Throws:
      de.willuhn.boot.SkipServiceException
      See Also:
      • Bootable.init(de.willuhn.boot.BootLoader, de.willuhn.boot.Bootable)

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface de.willuhn.boot.Bootable
      See Also:
      • Bootable.shutdown()

    • reload

      public void reload()
      Startet den Scripting-Service neu, damit die Scripts neu geladen werden.

    • getEngine

      public ScriptEngine getEngine()
      Liefert die Script-Engine.
      Returns:
      die Script-Engine.

    • getFunction

      public List<String> getFunction(String event)
      Liefert die Namen der auszufuehrenden Javascript-Funktionen fuer das Event.
      Parameters:
      event - das Event.
      Returns:
      die auszufuehrenden JS-Funktion oder NULL, wenn keine definiert sind.

    • getScripts

      public List<File> getScripts()
      Liefert die Liste der vom User registrierten Scripts.
      Returns:
      Liste der vom User registrierten Scripts. Niemals NULL sondern hoechstens eine leere Liste.

    • contains

      public boolean contains(File file) throws IOException
      Prueft, ob das angegebene Script bereits hinzugefuegt wurde.
      Parameters:
      file - das zu pruefende Script.
      Returns:
      true, wenn es bereits vorhanden ist.
      Throws:
      IOException

    • addScript

      public void addScript(File file) throws de.willuhn.util.ApplicationException
      Fuegt ein neues Script hinzu.
      Parameters:
      file - das hinzuzufuegende Script.
      Throws:
      de.willuhn.util.ApplicationException - wenn die Script-Datei bereits vorhanden ist.

    • removeScript

      public void removeScript(File file)
      Entfernt das Script.
      Parameters:
      file - das zu entfernende Script.