Class ScriptHelper


  • public class ScriptHelper
    extends java.lang.Object

    Überschrift: ScriptHelper.

    Beschreibung: Hilfsklasse für die ELO-Skripte.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptHelper()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addOnlyJsAndTextFiles​(de.elo.ix.client.Sord[] sords, java.util.ArrayList<de.elo.ix.client.Sord> allIxScripts)
      Fügt nur die Java Script und Textdateien in die angegebene Liste ein.
      static void checkinScript​(IXconnect ixConnect, java.io.File scriptFile)
      Speichert das angegebene Skript auf dem Index Server.
      static java.lang.String checkStandardAsLibraries​(java.lang.String jsImports)
      Überprüft die Version der Standard ELO AS Libraries und liefert falls nötig eine Statusmeldung zurück.
      static void downloadAsJarFiles​(IXconnect ixConnect, java.lang.String asBaseGuid)
      Lädt die externen JAR-Dateien für den ELO AS im temporären AS-Verzeichnis herunter.
      static de.elo.ix.client.Any getAnyObject​(java.lang.Object[] array)
      Liefert ein Any-Object aus dem angegebenen Object-Array zurück.
      static java.util.ArrayList<java.io.File> getAsJarFiles()
      Liefert die Liste mit den externen JAR-Dateien für den ELO AS zurück.
      static java.lang.String getAsJavaFolderGuid​(IXconnect ixConnect, java.lang.String asBaseGuid)
      Liefert die GUID des Ordners mit den externen JAR-Dateien zurück.
      static java.util.ArrayList<de.elo.ix.client.Sord> getDirectAsRules​(IXconnect ixConnect)
      Liefert eine Liste mit den direkten AS-Regeln zurück.
      static java.lang.String getInstallLogPath()
      Liefert den Pfad der Logdatei für die Skriptinstallation zurück.
      static java.util.ArrayList<de.elo.ix.client.Sord> getIXScripts​(IXconnect ixConnect)
      Liefert eine Liste mit den vorhandenen Index Server Skripten zurück.
      static java.lang.String getPayloadDirPath()
      Liefert den Ordnerpfad für die zu ladenden Dateien zurück.
      static java.lang.String getScriptEngineVersion()
      Liefert die Version der verwendeten ScriptEngine zurück.
      static java.util.ArrayList<de.elo.ix.client.Sord> getStandardAsLibraries​(IXconnect ixConnect)
      Liefert eine Liste mit den Standard AS Libraries und den selbst definierten AS Libraries zurück.
      static java.util.ArrayList<de.elo.ix.client.Sord> getTriggerAsRules​(IXconnect ixConnect)
      Liefert eine Liste mit den zeitgesteuerten AS Regeln zurück.
      static void importStdEloAsLibs​(IXconnect ixConnect, java.lang.String javaScriptFolderGuid)
      Importiert die Standard ELO AS Libraries im Ordner "JavaScript".
      static void installEloScript​(IXconnect ixConnect, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, WebAppContextParam webAppParams)
      Installiert die ELO-Skripte aus der angegebene URL (ZIP-Datei).
      static void setInstallLogPath​(java.lang.String installLogFilePath)
      Setzt den Pfad der Logdatei für die Skriptinstallation.
      static void setPayloadDirPath​(java.lang.String payloadDirPath)
      Setzt den angegebenen Ordnerpfad für die zu ladenden Dateien.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ScriptHelper

        public ScriptHelper()
    • Method Detail

      • getIXScripts

        public static java.util.ArrayList<de.elo.ix.client.Sord> getIXScripts​(IXconnect ixConnect)
                                                                       throws java.lang.Exception
        Liefert eine Liste mit den vorhandenen Index Server Skripten zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit Archivdokumenten
        Throws:
        java.lang.Exception
      • addOnlyJsAndTextFiles

        public static void addOnlyJsAndTextFiles​(de.elo.ix.client.Sord[] sords,
                                                 java.util.ArrayList<de.elo.ix.client.Sord> allIxScripts)
                                          throws java.lang.Exception
        Fügt nur die Java Script und Textdateien in die angegebene Liste ein.
        Parameters:
        sords - Liste mit Archiveinträgen
        allIxScripts - Liste für alle Index Server Skripte
        Throws:
        java.lang.Exception
      • getDirectAsRules

        public static java.util.ArrayList<de.elo.ix.client.Sord> getDirectAsRules​(IXconnect ixConnect)
                                                                           throws java.lang.Exception
        Liefert eine Liste mit den direkten AS-Regeln zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit den direkten AS-Regeln
        Throws:
        java.lang.Exception
      • getTriggerAsRules

        public static java.util.ArrayList<de.elo.ix.client.Sord> getTriggerAsRules​(IXconnect ixConnect)
                                                                            throws java.lang.Exception
        Liefert eine Liste mit den zeitgesteuerten AS Regeln zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit zeitgesteuerten AS Regeln
        Throws:
        java.lang.Exception
      • getStandardAsLibraries

        public static java.util.ArrayList<de.elo.ix.client.Sord> getStandardAsLibraries​(IXconnect ixConnect)
                                                                                 throws java.lang.Exception
        Liefert eine Liste mit den Standard AS Libraries und den selbst definierten AS Libraries zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit den Standard AS Libraries
        Throws:
        java.lang.Exception
      • downloadAsJarFiles

        public static void downloadAsJarFiles​(IXconnect ixConnect,
                                              java.lang.String asBaseGuid)
                                       throws java.lang.Exception
        Lädt die externen JAR-Dateien für den ELO AS im temporären AS-Verzeichnis herunter.
        Parameters:
        ixConnect - Index Server Verbindung
        asBaseGuid - GUID des AS-Ordners
        Throws:
        java.lang.Exception
      • getAsJavaFolderGuid

        public static java.lang.String getAsJavaFolderGuid​(IXconnect ixConnect,
                                                           java.lang.String asBaseGuid)
                                                    throws java.lang.Exception
        Liefert die GUID des Ordners mit den externen JAR-Dateien zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        asBaseGuid - GUID des AS-Ordners
        Returns:
        GUID des Ordners mit den externen JAR-Dateien
        Throws:
        java.lang.Exception
      • getAsJarFiles

        public static java.util.ArrayList<java.io.File> getAsJarFiles()
        Liefert die Liste mit den externen JAR-Dateien für den ELO AS zurück.
        Returns:
        Liste mit den externen JAR-Dateien
      • getPayloadDirPath

        public static java.lang.String getPayloadDirPath()
        Liefert den Ordnerpfad für die zu ladenden Dateien zurück.
        Returns:
        Pfad für die zu ladenden Dateien
      • setPayloadDirPath

        public static void setPayloadDirPath​(java.lang.String payloadDirPath)
        Setzt den angegebenen Ordnerpfad für die zu ladenden Dateien.
        Parameters:
        payloadDirPath - Pfad für die zu ladenden Dateien
      • getInstallLogPath

        public static java.lang.String getInstallLogPath()
        Liefert den Pfad der Logdatei für die Skriptinstallation zurück.
        Returns:
        Pfad der Logdatei für die Skriptinstallation
      • setInstallLogPath

        public static void setInstallLogPath​(java.lang.String installLogFilePath)
        Setzt den Pfad der Logdatei für die Skriptinstallation.
        Parameters:
        installLogFilePath - Pfad der Logdatei für die Skriptinstallation
      • installEloScript

        public static void installEloScript​(IXconnect ixConnect,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response,
                                            WebAppContextParam webAppParams)
                                     throws java.lang.Exception
        Installiert die ELO-Skripte aus der angegebene URL (ZIP-Datei).
        Parameters:
        ixConnect - Index Server Verbindung
        request - HTTP-Anfrage
        response - HTTP-Antwort
        webAppParams - Parameter der Webanwendung
        Throws:
        java.lang.Exception
      • importStdEloAsLibs

        public static void importStdEloAsLibs​(IXconnect ixConnect,
                                              java.lang.String javaScriptFolderGuid)
                                       throws java.lang.Exception
        Importiert die Standard ELO AS Libraries im Ordner "JavaScript".
        Parameters:
        ixConnect - Index Server Verbindung
        javaScriptFolderGuid - GUID des "JavaScript" Ordners
        Throws:
        java.lang.Exception
      • getScriptEngineVersion

        public static java.lang.String getScriptEngineVersion()
        Liefert die Version der verwendeten ScriptEngine zurück.
        Returns:
        Version der ScriptEngine oder null
      • checkStandardAsLibraries

        public static java.lang.String checkStandardAsLibraries​(java.lang.String jsImports)
        Überprüft die Version der Standard ELO AS Libraries und liefert falls nötig eine Statusmeldung zurück.
        Parameters:
        jsImports - Importierte JavaScript Objekte
        Returns:
        Statusmeldung oder null
      • checkinScript

        public static void checkinScript​(IXconnect ixConnect,
                                         java.io.File scriptFile)
                                  throws java.lang.Exception
        Speichert das angegebene Skript auf dem Index Server.
        Parameters:
        ixConnect - Index Server Verbindung
        scriptFile - Skriptdatei
        Throws:
        java.lang.Exception
      • getAnyObject

        public static de.elo.ix.client.Any getAnyObject​(java.lang.Object[] array)
                                                 throws java.lang.Exception
        Liefert ein Any-Object aus dem angegebenen Object-Array zurück.
        Parameters:
        array - Object-Array
        Returns:
        Any-Object
        Throws:
        java.lang.Exception