Class ASHelper


  • public class ASHelper
    extends java.lang.Object

    Überschrift: ASHelper.

    Beschreibung: Allgemeine Hilfsklasse für den ELO Automation Service.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      ASHelper()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean archivePathExists​(IXconnect ixConnect, java.lang.String archivePath)
      Meldet zurück, ob der angegebene Archivpfad existiert.
      static boolean archivePathIsValid​(java.lang.String archivePath)
      Meldet zurück, ob der angegebene Pfad gültig ist (kein leerer String).
      static int createArcPath​(IXconnect ixConnect, int parentId, java.lang.String path)
      Legt den angegebenen Archivpfad an.
      static de.elo.ix.client.StoreInfo createStorePath​(IXconnect ixConnect, java.lang.String storeName, java.lang.String directory)
      Legt den angegebenen Speicherpfad an, falls dieser nicht vorhanden ist.
      static java.lang.String decryptPassword​(java.lang.String password)
      Liefert das entschlüsselte Passwort zurück.
      static java.lang.String encryptPassword​(java.lang.String password)
      Liefert das verschlüsselte Passwort zurück.
      static java.util.ArrayList<java.lang.String> getAsLibrariesNames()
      Liefert eine Liste mit den Namen der AS-Libraries zurück.
      static java.lang.String getAsVersion()
      Liefert die aktuelle AS-Version zurück.
      static java.lang.String getDefaultLang()
      Liefert die Default-Sprache zurück.
      static int getDefaultPathId​(IXconnect ixConnect)
      Liefert den Default-Ablagepfad zurück.
      static de.elo.ix.client.EditInfo getEditInfoFilingPaths​(IXconnect ixConnect)
      Liefert das EditInfo-Objekt mit den Ablagepfaden zurück.
      static de.elo.ix.client.EditInfo getEditInfoFromEswFile​(IXconnect ixConnect, java.io.File eswFile)
      Liefert das EditInfo-Objekt aus der angegebenen ESW-Datei zurück.
      static de.elo.ix.client.Sord getElemByArcpath​(IXconnect ixConnect, java.lang.String arcPath)
      Liefert den Archiveintrag mit dem angegebenen Archivpfad zurück.
      static de.elo.ix.client.Sord getElemByArcpathRelative​(IXconnect ixConnect, int rootId, java.lang.String arcPath)
      Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner zurück.
      static de.elo.ix.client.IdName[] getFilingPaths​(IXconnect ixConnect)
      Liefert die vorhandenen Ablagepfade zurück.
      static java.lang.String getGuidFromId​(IXconnect ixConnect, int objId)
      Liefert die GUID für die angegebene ObjektID zurück.
      static int getIdFromGuid​(IXconnect ixConnect, java.lang.String guid)
      Liefert die ObjektID für die angegebenen GUID zurück.
      static java.lang.String getJREString()
      Liefert Informationen zur Java Runtime Umgebung als formatierten String zurück.
      static java.lang.String[] getNames​(de.elo.ix.client.Sord[] sords)
      Liefert eine Liste mit den Namen der angegebenen Archiveinträge zurück.
      static int[] getObjectIdArray​(java.util.ArrayList<java.lang.Integer> objIdList)
      Liefert ein Array mit Objekt IDs aus der angegebenen Liste zurück.
      static java.util.ArrayList<java.lang.Integer> getObjectIdList​(java.lang.String[] objIdStrings)
      Liefert eine Liste mit Objekt IDs aus der angegebenen String-Liste zurück.
      static int[] getObjectIds​(de.elo.ix.client.Sord[] sords)
      Liefert eine Liste mit den Objekt IDs der angegebenen Archiveinträge zurück.
      static int getObjIdFromPath​(IXconnect ixConnect, java.lang.String archivePath)
      Liefert die ID des Archiveintrags für den angegebenen Pfad zurück.
      static de.elo.ix.client.Sord getPersonalFolder​(IXconnect ixConnect, int userId)
      Liefert die Verschlagwortung des Ordners "Persönlichen Bereich" zurück.
      static java.util.List<de.elo.ix.client.SordLink> getSordLinks​(IXconnect ixConnect, int objId)
      Liefert alle ein- und ausgehende Links des angegebenen Archiveintrags.
      static de.elo.ix.client.Sord[] getSords​(IXconnect ixConnect, int[] objIds)
      Liefert eine Liste mit den Archiveinträgen aus den angegebenen Objekt IDs zurück.
      static java.util.List<de.elo.ix.client.Sord> getSords​(java.lang.String[] sordNames)
      Liefert eine Liste mit Archiveinträgen mit den angegebenen Namen zurück.
      static java.lang.String[] getStringList​(int[] objIds)
      Liefert eine Liste mit den Objekt-IDs als Strings zurück.
      static boolean is64bit()
      Prüft, ob das Betriebssystem 64-bit ist.
      static boolean is64BitJava()
      Meldet zurück, ob eine 64-bit JRE verwendet wird.
      static boolean isLinux()
      Prüft, ob das aktuelle Betriebssystem ein Linux ist.
      static boolean isMacOSX()
      Prüft, ob das aktuelle Betriebssystem ein Apple Mac OS X ist.
      static boolean isWindows()
      Prüft, ob das aktuelle Betriebssystem ein MS Windows ist.
      static boolean isWindows7()
      Prüft, ob das aktuelle Betriebssystem MS Windows 7 ist.
      static boolean isWindowsServer()
      Prüft, ob das altuelle Betriebssystem Windows Server ist.
      static boolean isWindowsVista()
      Prüft, ob das aktuelle Betriebssystem MS Windows Vista ist.
      static void linkEntries​(IXconnect ixConnect, int sourceObjId, int destObjId)
      Verlinkt die Source Objekt ID mit der Ziel Objekt ID.
      static void saveEditInfoInEswFile​(IXconnect ixConnect, de.elo.ix.client.EditInfo editInfo, java.io.File eswFile)
      Speichert das angegebene EditInfo-Objekt in die angegebene ESW-Datei.
      • Methods inherited from class java.lang.Object

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

      • ASHelper

        public ASHelper()
    • Method Detail

      • getJREString

        public static java.lang.String getJREString()
        Liefert Informationen zur Java Runtime Umgebung als formatierten String zurück.
        Returns:
        Informationen zur Java Runtime Umgebung
      • getDefaultLang

        public static java.lang.String getDefaultLang()
        Liefert die Default-Sprache zurück.
        Returns:
        Default-Sprache
      • getAsVersion

        public static java.lang.String getAsVersion()
        Liefert die aktuelle AS-Version zurück.
        Returns:
        Aktuelle AS-Version
      • archivePathIsValid

        public static boolean archivePathIsValid​(java.lang.String archivePath)
                                          throws java.lang.Exception
        Meldet zurück, ob der angegebene Pfad gültig ist (kein leerer String).
        Parameters:
        archivePath - Archivpfad
        Returns:
        Pfad ist gültig
        Throws:
        java.lang.Exception
      • archivePathExists

        public static boolean archivePathExists​(IXconnect ixConnect,
                                                java.lang.String archivePath)
                                         throws java.lang.Exception
        Meldet zurück, ob der angegebene Archivpfad existiert.
        Parameters:
        ixConnect - Index Server Verbindung
        archivePath - Archivpfad
        Returns:
        Archivpfad existiert
        Throws:
        java.lang.Exception
      • createArcPath

        public static int createArcPath​(IXconnect ixConnect,
                                        int parentId,
                                        java.lang.String path)
                                 throws java.lang.Exception
        Legt den angegebenen Archivpfad an.
        Parameters:
        ixConnect - Index Server Verbindung
        parentId - Parent ID
        path - Archivpfad, z.B. "/EloAs/NewPath"
        Returns:
        ID des letzten Pfadeintrags
        Throws:
        java.lang.Exception
      • createStorePath

        public static de.elo.ix.client.StoreInfo createStorePath​(IXconnect ixConnect,
                                                                 java.lang.String storeName,
                                                                 java.lang.String directory)
                                                          throws java.lang.Exception
        Legt den angegebenen Speicherpfad an, falls dieser nicht vorhanden ist.
        Parameters:
        ixConnect - Index Server Verbindung
        storeName - Name des Speicherpfades
        directory - Verzeichnis des Speicherpfades
        Returns:
        Informationen zum Speicherpfad
        Throws:
        java.lang.Exception
      • getObjIdFromPath

        public static int getObjIdFromPath​(IXconnect ixConnect,
                                           java.lang.String archivePath)
                                    throws java.lang.Exception
        Liefert die ID des Archiveintrags für den angegebenen Pfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        archivePath - Archivpfad
        Returns:
        ObjektId
        Throws:
        java.lang.Exception
      • getElemByArcpath

        public static de.elo.ix.client.Sord getElemByArcpath​(IXconnect ixConnect,
                                                             java.lang.String arcPath)
                                                      throws java.lang.Exception
        Liefert den Archiveintrag mit dem angegebenen Archivpfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        arcPath - Archivpfad
        Returns:
        Archiveintrag oder null
        Throws:
        java.lang.Exception
      • getElemByArcpathRelative

        public static de.elo.ix.client.Sord getElemByArcpathRelative​(IXconnect ixConnect,
                                                                     int rootId,
                                                                     java.lang.String arcPath)
                                                              throws java.lang.Exception
        Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        rootId - ID des Startordners
        arcPath - Pfad relativ zum Startordner. Der Pfad besteht aus den Kurzbezeichnungen der Untereinträge mit beliebigem Trennzeichen. Der Pfad muss mit einem Trennzeichen beginnen.
        Returns:
        Archiveintrag
        Throws:
        java.lang.Exception - Fehler beim Lesen des Objektes vom Server
      • linkEntries

        public static void linkEntries​(IXconnect ixConnect,
                                       int sourceObjId,
                                       int destObjId)
                                throws java.lang.Exception
        Verlinkt die Source Objekt ID mit der Ziel Objekt ID.
        Parameters:
        ixConnect - Index Server Verbindung
        sourceObjId - ID des ersten Archiveintrags
        destObjId - ID des Zielarchiveintrags
        Throws:
        java.lang.Exception
      • getSordLinks

        public static java.util.List<de.elo.ix.client.SordLink> getSordLinks​(IXconnect ixConnect,
                                                                             int objId)
                                                                      throws java.lang.Exception
        Liefert alle ein- und ausgehende Links des angegebenen Archiveintrags.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        Returns:
        Liste mit den Links
        Throws:
        java.lang.Exception
      • getObjectIdList

        public static java.util.ArrayList<java.lang.Integer> getObjectIdList​(java.lang.String[] objIdStrings)
                                                                      throws java.lang.Exception
        Liefert eine Liste mit Objekt IDs aus der angegebenen String-Liste zurück.
        Parameters:
        objIdStrings - Liste mit Objekt IDs als String
        Returns:
        Liste mit Objekt IDs als Integer
        Throws:
        java.lang.Exception
      • getStringList

        public static java.lang.String[] getStringList​(int[] objIds)
                                                throws java.lang.Exception
        Liefert eine Liste mit den Objekt-IDs als Strings zurück.
        Parameters:
        objIds - Liste mit Objekt IDs
        Returns:
        Liste mit Strings
        Throws:
        java.lang.Exception
      • getObjectIdArray

        public static int[] getObjectIdArray​(java.util.ArrayList<java.lang.Integer> objIdList)
                                      throws java.lang.Exception
        Liefert ein Array mit Objekt IDs aus der angegebenen Liste zurück.
        Parameters:
        objIdList - Liste mit Objekt IDs
        Returns:
        Array mit Objekt IDs
        Throws:
        java.lang.Exception
      • getObjectIds

        public static int[] getObjectIds​(de.elo.ix.client.Sord[] sords)
                                  throws java.lang.Exception
        Liefert eine Liste mit den Objekt IDs der angegebenen Archiveinträge zurück.
        Parameters:
        sords - Liste mit Archiveinträgen
        Returns:
        Liste mit Objekt IDs
        Throws:
        java.lang.Exception
      • getNames

        public static java.lang.String[] getNames​(de.elo.ix.client.Sord[] sords)
                                           throws java.lang.Exception
        Liefert eine Liste mit den Namen der angegebenen Archiveinträge zurück.
        Parameters:
        sords - Liste mit Archiveinträgen
        Returns:
        Liste mit den Namen der Archiveinträge
        Throws:
        java.lang.Exception
      • getSords

        public static de.elo.ix.client.Sord[] getSords​(IXconnect ixConnect,
                                                       int[] objIds)
                                                throws java.lang.Exception
        Liefert eine Liste mit den Archiveinträgen aus den angegebenen Objekt IDs zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objIds - Liste mit Objekt IDs
        Returns:
        Liste mit Archiveinträgen
        Throws:
        java.lang.Exception
      • getSords

        public static java.util.List<de.elo.ix.client.Sord> getSords​(java.lang.String[] sordNames)
                                                              throws java.lang.Exception
        Liefert eine Liste mit Archiveinträgen mit den angegebenen Namen zurück.
        Parameters:
        sordNames - Liste mit Namen
        Returns:
        Liste mit Archiveinträgen
        Throws:
        java.lang.Exception
      • getEditInfoFromEswFile

        public static de.elo.ix.client.EditInfo getEditInfoFromEswFile​(IXconnect ixConnect,
                                                                       java.io.File eswFile)
                                                                throws java.lang.Exception
        Liefert das EditInfo-Objekt aus der angegebenen ESW-Datei zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        eswFile - ESW- oder ES8-Datei
        Returns:
        EditInfo
        Throws:
        java.lang.Exception
      • saveEditInfoInEswFile

        public static void saveEditInfoInEswFile​(IXconnect ixConnect,
                                                 de.elo.ix.client.EditInfo editInfo,
                                                 java.io.File eswFile)
                                          throws java.lang.Exception
        Speichert das angegebene EditInfo-Objekt in die angegebene ESW-Datei.
        Parameters:
        ixConnect - Index Server Verbindung
        editInfo - EditInfo
        eswFile - ESW- oder ES8-Datei
        Throws:
        java.lang.Exception
      • getGuidFromId

        public static java.lang.String getGuidFromId​(IXconnect ixConnect,
                                                     int objId)
                                              throws java.lang.Exception
        Liefert die GUID für die angegebene ObjektID zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        Returns:
        GUID des Archiveintrags
        Throws:
        java.lang.Exception
      • getIdFromGuid

        public static int getIdFromGuid​(IXconnect ixConnect,
                                        java.lang.String guid)
                                 throws java.lang.Exception
        Liefert die ObjektID für die angegebenen GUID zurück.
        Parameters:
        ixConnect - Index Server Verbdindung
        guid - GUID des Archiveintrags
        Returns:
        ID des Archiveintrags
        Throws:
        java.lang.Exception
      • getFilingPaths

        public static de.elo.ix.client.IdName[] getFilingPaths​(IXconnect ixConnect)
                                                        throws java.lang.Exception
        Liefert die vorhandenen Ablagepfade zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit Ablagepfaden
        Throws:
        java.lang.Exception
      • getDefaultPathId

        public static int getDefaultPathId​(IXconnect ixConnect)
                                    throws java.lang.Exception
        Liefert den Default-Ablagepfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Default-Ablagepfad
        Throws:
        java.lang.Exception
      • getEditInfoFilingPaths

        public static de.elo.ix.client.EditInfo getEditInfoFilingPaths​(IXconnect ixConnect)
                                                                throws java.lang.Exception
        Liefert das EditInfo-Objekt mit den Ablagepfaden zurück.
        Parameters:
        ixConnect - Index Server Vebindung
        Returns:
        EditInfo mit den Ablagepfaden
        Throws:
        java.lang.Exception
      • isWindows

        public static boolean isWindows()
        Prüft, ob das aktuelle Betriebssystem ein MS Windows ist.
        Returns:
        Betriebssystem ist Windows
      • isWindows7

        public static boolean isWindows7()
        Prüft, ob das aktuelle Betriebssystem MS Windows 7 ist.
        Returns:
        Windows 7 Betriebssystem
      • isWindowsVista

        public static boolean isWindowsVista()
        Prüft, ob das aktuelle Betriebssystem MS Windows Vista ist.
        Returns:
        Windows Vista Betriebssystem
      • isWindowsServer

        public static boolean isWindowsServer()
        Prüft, ob das altuelle Betriebssystem Windows Server ist.
        Returns:
        Windows Server Betriebssystem
      • isMacOSX

        public static boolean isMacOSX()
        Prüft, ob das aktuelle Betriebssystem ein Apple Mac OS X ist.
        Returns:
        Betriebssystem is Mac OS
      • isLinux

        public static boolean isLinux()
        Prüft, ob das aktuelle Betriebssystem ein Linux ist.
        Returns:
        Betriebssystem ist Linux
      • is64bit

        public static boolean is64bit()
        Prüft, ob das Betriebssystem 64-bit ist.
        Returns:
        64-bit Betriebssystem
      • is64BitJava

        public static boolean is64BitJava()
        Meldet zurück, ob eine 64-bit JRE verwendet wird.
        Returns:
        64-bit JRE verwenden
      • getAsLibrariesNames

        public static java.util.ArrayList<java.lang.String> getAsLibrariesNames()
                                                                         throws java.lang.Exception
        Liefert eine Liste mit den Namen der AS-Libraries zurück.
        Returns:
        Liste mit Library-Namen
        Throws:
        java.lang.Exception
      • encryptPassword

        public static java.lang.String encryptPassword​(java.lang.String password)
                                                throws java.lang.Exception
        Liefert das verschlüsselte Passwort zurück.
        Parameters:
        password - Passwort als Text
        Returns:
        verschlüsseltes Passwort
        Throws:
        java.lang.Exception
      • decryptPassword

        public static java.lang.String decryptPassword​(java.lang.String password)
                                                throws java.lang.Exception
        Liefert das entschlüsselte Passwort zurück.
        Parameters:
        password - verschlüsseltes Passwort
        Returns:
        entschlüsseltes Passwort
        Throws:
        java.lang.Exception
      • getPersonalFolder

        public static de.elo.ix.client.Sord getPersonalFolder​(IXconnect ixConnect,
                                                              int userId)
                                                       throws java.lang.Exception
        Liefert die Verschlagwortung des Ordners "Persönlichen Bereich" zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        userId - Benutzer ID
        Returns:
        Ordner "Persönlicher Bereich"
        Throws:
        java.lang.Exception