Class ChecksumHelper


  • public class ChecksumHelper
    extends java.lang.Object

    Überschrift: ChecksumHelper.

    Beschreibung: Hilfsklasse für die Checksummen-Überprüfung.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018-2019

    • Constructor Summary

      Constructors 
      Constructor Description
      ChecksumHelper()  
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static int checkEntryChecksum​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
      Überprüft die Check-Summe der Arbeitsversion des angegebenen Archiveintrags.
      static int[] checkEntryChecksumVersions​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
      Überprüft die Check-Summe von allen Versionen des angegebenen Archiveintrags.
      static java.lang.String getAMUrl​(IXconnect ixConnect)
      Liefert die Access Manager URL aus der angegebenen Index Server Verbindung zurück.
      static java.lang.String getAMUrl2​(IXconnect ixConnect)
      Liefert die Access Manager URL aus der angegebenen Index Server Verbindung zurück.
      static ChecksumReport getChecksumReport​(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, java.io.File reportFile, boolean logOnlyErrors)
      Überprüft die Check-Summe der angegebenen Archiveinträge.
      static java.util.Properties getDMOptions​(IXconnect ixConnect)
      Liefert die Document Manager Optionen zurück.
      static java.lang.String getDMUrl​(IXconnect ixConnect)
      Liefert die Dokument Manager URL aus der angegebenen Index Server Verbindung zurück.
      static java.lang.String getDMUrl2​(IXconnect ixConnect, java.lang.String archiveName)
      Deprecated. 
      static java.util.Properties getFTOptions​(IXconnect ixConnect)
      Liefert die Volltext Optionen zurück.
      static java.lang.String getISUrl​(IXconnect ixConnect)
      Liefert die iSearch URL aus der angegebenen Index Server Verbindung zurück.
      static java.util.Properties getIXOptions​(IXconnect ixConnect)
      Liefert die Index Server Optionen zurück.
      static java.lang.String getIXUrl​(IXconnect ixConnect)
      Liefert die Index Server URL aus der angegebenen Index Server Verbindung zurück.
      static java.lang.String getValidIxName​(java.lang.String ixName)
      Liefert einen gültigen Index Server Namen aus dem angegebenen Namen zurück.
      static void saveChecksumReport​(ChecksumReport checksumReport)
      Speichert den angegebenen Report in der eingetragenen Reportdatei.
      • Methods inherited from class java.lang.Object

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

      • ChecksumHelper

        public ChecksumHelper()
    • Method Detail

      • getChecksumReport

        public static ChecksumReport getChecksumReport​(IXconnect ixConnect,
                                                       de.elo.ix.client.Sord[] sords,
                                                       java.io.File reportFile,
                                                       boolean logOnlyErrors)
                                                throws java.lang.Exception
        Überprüft die Check-Summe der angegebenen Archiveinträge.
        Parameters:
        ixConnect - Index Server Verbindung
        sords - Liste mit den Verschlagwortungsobjekten
        reportFile - Reportdatei
        logOnlyErrors - Nur Fehler loggen
        Returns:
        Report-Ergebnis
        Throws:
        java.lang.Exception
      • getAMUrl2

        public static java.lang.String getAMUrl2​(IXconnect ixConnect)
                                          throws java.lang.Exception
        Liefert die Access Manager URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Access Manager URL
        Throws:
        java.lang.Exception
      • getDMUrl

        public static java.lang.String getDMUrl​(IXconnect ixConnect)
                                         throws java.lang.Exception
        Liefert die Dokument Manager URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Dokument Manager URL
        Throws:
        java.lang.Exception
      • checkEntryChecksum

        public static int checkEntryChecksum​(IXconnect ixConnect,
                                             de.elo.ix.client.Sord sord)
                                      throws java.lang.Exception
        Überprüft die Check-Summe der Arbeitsversion des angegebenen Archiveintrags. Wenn der Return Wert größer als 0 ist, dann ist das Dokument in Ordnung. 0 zeigt an, dass keine Dokumentendatei vorhanden ist und Werte kleiner als 0 zeigen ein fehlerhaftes Dokument an.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        Returns:
        1: ok, 0: no document, -6: cannot read result, -10: checkum error
        Throws:
        java.lang.Exception
      • checkEntryChecksumVersions

        public static int[] checkEntryChecksumVersions​(IXconnect ixConnect,
                                                       de.elo.ix.client.Sord sord)
                                                throws java.lang.Exception
        Überprüft die Check-Summe von allen Versionen des angegebenen Archiveintrags. Wenn der Return Wert größer als 0 ist, dann ist das Dokument in Ordnung. 0 zeigt an, dass keine Dokumentendatei vorhanden ist und Werte kleiner als 0 zeigen ein fehlerhaftes Dokument an.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        Returns:
        Liste mit den Ergebnissen
        Throws:
        java.lang.Exception
      • saveChecksumReport

        public static void saveChecksumReport​(ChecksumReport checksumReport)
                                       throws java.lang.Exception
        Speichert den angegebenen Report in der eingetragenen Reportdatei.
        Parameters:
        checksumReport - Checksummen-Report
        Throws:
        java.lang.Exception
      • getAMUrl

        public static java.lang.String getAMUrl​(IXconnect ixConnect)
                                         throws java.lang.Exception
        Liefert die Access Manager URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Access Manager URL
        Throws:
        java.lang.Exception
      • getDMUrl2

        public static java.lang.String getDMUrl2​(IXconnect ixConnect,
                                                 java.lang.String archiveName)
                                          throws java.lang.Exception
        Deprecated.
        Liefert die DM-URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        archiveName - Archivname
        Returns:
        Document Manager URL
        Throws:
        java.lang.Exception
      • getIXUrl

        public static java.lang.String getIXUrl​(IXconnect ixConnect)
                                         throws java.lang.Exception
        Liefert die Index Server URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Index Server URL
        Throws:
        java.lang.Exception
      • getValidIxName

        public static java.lang.String getValidIxName​(java.lang.String ixName)
                                               throws java.lang.Exception
        Liefert einen gültigen Index Server Namen aus dem angegebenen Namen zurück. Unzulässige Zeichen werden durch das Zeichen "_" ersetzt.
        Parameters:
        ixName - Index Server Name
        Returns:
        gültigen Index Server Namen
        Throws:
        java.lang.Exception
      • getISUrl

        public static java.lang.String getISUrl​(IXconnect ixConnect)
                                         throws java.lang.Exception
        Liefert die iSearch URL aus der angegebenen Index Server Verbindung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        iSearch URL
        Throws:
        java.lang.Exception
      • getDMOptions

        public static java.util.Properties getDMOptions​(IXconnect ixConnect)
                                                 throws java.lang.Exception
        Liefert die Document Manager Optionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Document Manager Optionen
        Throws:
        java.lang.Exception
      • getIXOptions

        public static java.util.Properties getIXOptions​(IXconnect ixConnect)
                                                 throws java.lang.Exception
        Liefert die Index Server Optionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Index Server Optionen
        Throws:
        java.lang.Exception
      • getFTOptions

        public static java.util.Properties getFTOptions​(IXconnect ixConnect)
                                                 throws java.lang.Exception
        Liefert die Volltext Optionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Volltext Optionen
        Throws:
        java.lang.Exception