Package de.elo.mover.utils

Class ELOAsUtils

java.lang.Object
de.elo.mover.utils.ELOAsUtils
public class ELOAsUtils extends Object

Überschrift: ELOAsUtils.

Beschreibung: Hilfsklasse für den ELO Automation Service.

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

  • Constructor Details

    • ELOAsUtils

      public ELOAsUtils()

  • Method Details

    • findDoublet

      public static de.elo.ix.client.EditInfo findDoublet(IXconnect ixConnect, File file) throws Exception
      Liefert die Metadaten der angegebenen Datei zurück.
      Parameters:
      ixConnect - Verbindung zum Indexserver
      file - Datei, die abgelegt wird
      Returns:
      EditInfo des bereits abgelegten Dokuments oder null
      Throws:
      Exception

    • createMd5

      public static String createMd5(File file) throws Exception
      Emittelt den MD5-Hash der angegebenen Datei.
      Parameters:
      file - Datei
      Returns:
      MD5-Hash
      Throws:
      IOException
      Exception

    • hasBarcodeLicense

      public static boolean hasBarcodeLicense(IXconnect ixConnect) throws Exception
      Meldet zurück, ob eine Barcode Lizenz in der angegebenen Indexserver-Verbindung vorhanden ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Barcode Lizenz ist vorhanden
      Throws:
      Exception

    • getBarcode

      public static String getBarcode(IXconnect ixConnect, File file, int page, String barcodeConfig) throws Exception
      Liefert die Barcode-Informationen für die angegebene Datei zurück.
      Parameters:
      ixConnect - Verbindung zum Index Server
      file - Datei
      page - Seite, aus der die Barcode-Information ausgelesen wird
      barcodeConfig - Barcode-Konfiguration
      Returns:
      Barcodeinformationen
      Throws:
      Exception

    • getBarcodeResult

      public static com.google.zxing.Result getBarcodeResult(IXconnect ixConnect, File file, int page, String barcodeConfig) throws Exception
      Liefert die Barcode-Informationen für die angegebene Datei zurück.
      Parameters:
      ixConnect - Verbindung zum Index Server
      file - Datei
      page - Seite, aus der die Barcode-Information ausgelesen wird
      barcodeConfig - Barcode-Konfiguration
      Returns:
      Barcodeinformationen
      Throws:
      Exception

    • writeBarcode

      public static void writeBarcode(IXconnect ixConnect, File targetFile, String barcodeText, int width, int height, String barcodeConfig) throws Exception
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      Parameters:
      ixConnect - Verbindung zum IndexServer
      targetFile - Datei, in der die Barcodeinformationen geschrieben werden
      barcodeText - Text, der als Barcode geschrieben wird
      width - Barcode-Breite
      height - Barcode-Höhe
      barcodeConfig - Barcode-Konfiguration
      Throws:
      Exception

    • writeBarcode

      public static void writeBarcode(IXconnect ixConnect, File targetFile, String barcodeText, String barcodeFormat, int width, int height, String barcodeConfig) throws Exception
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      Parameters:
      ixConnect - Verbindung zum IndexServer
      targetFile - Datei, in der die Barcodeinformationen geschrieben werden
      barcodeText - Text, der als Barcode geschrieben wird
      barcodeFormat - Barcode-Format
      width - Barcode-Breite
      height - Barcode-Höhe
      barcodeConfig - Barcode-Konfiguration
      Throws:
      Exception

    • writeBarcode

      public static void writeBarcode(IXconnect ixConnect, File targetFile, String barcodeText, String barcodeFormat, int width, int height, int xPos, int yPos, String barcodeConfig) throws Exception
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      Parameters:
      ixConnect - Verbindung zum IndexServer
      targetFile - Datei, in der die Barcodeinformationen geschrieben werden
      barcodeText - Text, der als Barcode geschrieben wird
      barcodeFormat - Barcode-Format
      width - Barcode-Breite
      height - Barcode-Höhe
      xPos - Horizontale Barcode-Position
      yPos - Vertikale Barcode-Position
      barcodeConfig - Barcode-Konfiguration
      Throws:
      Exception

    • createBarcodeReader

      public static BarcodeReader createBarcodeReader(String barcodeRulesDescr) throws Exception
      Erzeugt ein Objekt für die Barcode-Erkennung.
      Parameters:
      barcodeRulesDescr - Definition der Barcode-Regeln
      Returns:
      Barcode-Reader
      Throws:
      Exception

    • createBarcodeReader

      public static BarcodeReader createBarcodeReader() throws Exception
      Erzeugt ein Objekt für die Barcode-Erkennung.
      Returns:
      Barcode-Reader
      Throws:
      Exception

    • createBarcodeReader2

      public static BarcodeReader createBarcodeReader2(IXconnect currIxConnect) throws Exception
      Erzeugt ein Objekt für die Barcode-Erkennung.
      Parameters:
      currIxConnect - Indexserver-Verbindung
      Returns:
      Barcode-Reader
      Throws:
      Exception

    • isImageFile

      public static boolean isImageFile(File file) throws Exception
      Meldet zurück, ob die angegebene Datei ein Bild ist.
      Parameters:
      file - Datei
      Returns:
      Datei ist ein Bild
      Throws:
      Exception

    • startProcess

      public static void startProcess(String[] arguments) throws Exception
      Startet das angegebene externe Programm.
      Parameters:
      arguments - Programmargumente
      Throws:
      Exception

    • getOcrRect

      public static String getOcrRect(IXconnect ixConnect, int objId, String[] langs, int pageNr, int top, int left, int bottom, int right) throws byps.RemoteException, Exception
      Liefert den durch die OCR erkannten Text vom angegebenen Rechteck zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ObjektId des Eintrags
      langs - Liste mit OCR-Sprachen
      pageNr - Seitennummer (Anfang bei 0)
      top - Obere Grenze des OCR-Rechtecks
      left - Linke Grenze des OCR-Rechtecks
      bottom - Untere Grenze des OCR-Rechtecks
      right - Rechte Grenze des OCR-Rechtecks
      Returns:
      OCR-Text
      Throws:
      byps.RemoteException
      Exception

    • getOcrText

      public static String getOcrText(IXconnect ixConnect, int objId, String[] langs) throws byps.RemoteException, Exception
      Liefert den kompletten OCR-Text für das angegebene Dokument zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Objekt-ID des Eintrags
      langs - Liste mit OCR-Sprachen
      Returns:
      Kompletter OCR-Text
      Throws:
      byps.RemoteException
      Exception

    • getOcrTextForPage

      public static String getOcrTextForPage(IXconnect ixConnect, String objId, int pageNr, String[] langs) throws Exception
      Liefert den OCR-Text aus der angegebenen Dokumentseite zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Dokuments
      pageNr - Seite des Dokuments
      langs - Liste mit OCR-Sprachen
      Returns:
      OCR-Text der Dokumentseite
      Throws:
      Exception

    • createSearchableFile

      public static void createSearchableFile(IXconnect ixConnect, File tiffFile, File pdfFile, String[] languages) throws Exception
      Erzeugt eine durchsuchbare PDF-Datei aus der angegebenen TIFF-Datei mit Hilfe der ELO OCR.
      Parameters:
      ixConnect - Indexserver-Verbindung
      tiffFile - TIFF-Datei
      pdfFile - Durchsuchbare PDF-Datei
      languages - Liste mit den OCR-Sprachen
      Throws:
      Exception

    • createSearchableFileForEntry

      public static void createSearchableFileForEntry(IXconnect ixConnect, String objId, File pdfFile, String[] languages) throws Exception
      Erzeugt eine durchsuchbare PDF-Datei aus dem angegebenen Repository Eintrag mit Hilfe der ELO OCR.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Objekt-ID des Eintrags
      pdfFile - Durchsuchbare PDF-Datei
      languages - Liste mit den OCR-Sprachen
      Throws:
      Exception

    • checkOcrAvail

      public static boolean checkOcrAvail(IXconnect ixConnect) throws Exception
      Meldet zurück, ob die OCR verfügbar ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      OCR verfügbar
      Throws:
      Exception

    • getExternalOcrLanguages

      public static String[] getExternalOcrLanguages(IXconnect ixConnect) throws Exception
      Liefert die vorhandenen externen OCR-Sprachen zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den OCR-Sprachen
      Throws:
      Exception

    • getInternalOcrLanguages

      public static String[] getInternalOcrLanguages(IXconnect ixConnect) throws Exception
      Liefert die vorhandenen internen OCR-Sprachen zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den OCR-Sprachen
      Throws:
      Exception

    • sendHttpGetRequest

      public static void sendHttpGetRequest(String url, File responseFile) throws IOException, Exception
      Sendet eine HttpGet-Anfrage an der angegebenen URL.
      Parameters:
      url - URL, an die die Anfrage gesendet wird
      responseFile - Datei mit dem Anfrageergebnis
      Throws:
      IOException
      Exception

    • sendHttpGetRequestBasicAuth

      public static void sendHttpGetRequestBasicAuth(String url, File responseFile, String user, String password) throws Exception
      Sendet eine HTTP GET-Anfrage mit einer Basic Authentifizierung an der angegebenen URL.
      Parameters:
      url - URL, an die die Anfrage gesendet wird
      responseFile - Datei mit dem HTTP-Ergebnis
      user - Benutzer
      password - Passwort
      Throws:
      Exception

    • sendHttpPostRequest

      public static void sendHttpPostRequest(String url, File sourceFile) throws Exception
      Versendet eine HttpPost-Anfrage an der angegebenen URL.
      Parameters:
      url - URL, an die die Anfrage gesendet wird
      sourceFile - Datei mit den Daten, die versendet werden
      Throws:
      Exception

    • sendHttpPostRequest

      public static void sendHttpPostRequest(String url, byte[] source) throws Exception
      Sendet eine HTTP Post-Anfrage an der angegebenen URL.
      Parameters:
      url - URL, an die die Anfrage gesendet wird
      source - byte-Array mit den Daten für die Anfrage
      Throws:
      Exception

    • getDocumentVersion

      public static File getDocumentVersion(IXconnect ixConnect, int objId, File targetDir) throws Exception
      Liefert die Arbeitsversion des angegebenen Dokuments zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Dokuments
      targetDir - Verzeichnis, in dem die Arbeitsversion heruntergelanden wird
      Returns:
      Arbeitsversion
      Throws:
      Exception

    • getDocumentVersionPart

      public static void getDocumentVersionPart(IXconnect ixConnect, int objId, File targetFile, long offset, long length) throws Exception
      Lädt den angegebene Teil der Arbeitsversion herunter.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Dokuments
      targetFile - Zieldatei
      offset - Versatz
      length - Länge der zu lesenden Daten
      Throws:
      Exception

    • getAttachmentVersion

      public static File getAttachmentVersion(IXconnect ixConnect, int objId, File targetDir) throws Exception
      Liefert die Arbeitsversion der Dateianbindung des angegebenen Dokuments zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Dokuments
      targetDir - Verzeichnis, in dem die Arbeitsversion heruntergelanden wird
      Returns:
      Arbeitsversion der Dateianbindung
      Throws:
      Exception

    • removeAttachments

      public static void removeAttachments(IXconnect ixConnect, int objId) throws Exception
      Entfernt die Dateianbindung des angegebenen Dokuments.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Dokuments
      Throws:
      Exception

    • addAttachment

      public static void addAttachment(IXconnect ixConnect, int objId, File sourceFile) throws Exception
      Fügt eine Dateianbindung an das angegebene Dokument.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Dokuments, zu dem die Dateianbindung eingefügt wird
      sourceFile - Dateianbindung
      Throws:
      Exception

    • saveDocumentVersion

      public static void saveDocumentVersion(IXconnect ixConnect, File file, int objId, String version, String versionComment, boolean isMilestone) throws Exception
      Speichert die angegebene Datei als eine neue Version an dem Dokument.
      Parameters:
      ixConnect - Indexserver-Verbindung
      file - Datei, die als neue Version gespeichert wird
      objId - Id des Dokuments
      version - Versionsbezeichnung
      versionComment - Versionskommentar
      isMilestone - Nicht löschbare Version
      Throws:
      Exception

    • insertIntoArchive

      public static int insertIntoArchive(IXconnect ixConnect, File file, int targetId, String maskName, String version, String versionComment, boolean isMilestone) throws Exception
      Legt die Datei im angegebenen Zielordner ab.
      Parameters:
      ixConnect - Indexserver-Verbindung
      file - Datei, die abgelegt wird
      targetId - Zielordner
      maskName - Maske
      version - Versionsbezeichnung
      versionComment - Versionskommentar
      isMilestone - Nicht löschbare Version
      Returns:
      Id des Dokuments
      Throws:
      Exception

    • createDefaultEditInfo

      public static de.elo.ix.client.EditInfo createDefaultEditInfo(IXconnect ixConnect, File file, String maskName, int targetId) throws byps.RemoteException, Exception
      Erzeugt eine Default-Metadaten für die angegebene Datei.
      Parameters:
      ixConnect - Indexserver-Verbindung
      file - Datei, die abgelegt wird
      maskName - Maskennamen
      targetId - Id des Ablageordners
      Returns:
      Default-Metadaten
      Throws:
      byps.RemoteException
      Exception

    • addNewFolder

      public static int addNewFolder(IXconnect ixConnect, String folderName, int parentId, String maskName) throws byps.RemoteException, Exception
      Erzeugt einen neuen Ordner im angegebenen Repositoryordner.
      Parameters:
      ixConnect - Indexserver-Verbindung
      folderName - Ordnername
      parentId - Id des Ordners, in dem der neue Ordner angelegt wird
      maskName - Maskennamen oder null für die Default-Ordnermaske
      Returns:
      Id des neuen Ordners
      Throws:
      byps.RemoteException
      Exception

    • addDynamicFolder

      public static int addDynamicFolder(IXconnect ixConnect, String folderName, int parentId, String maskName, String descr) throws Exception
      Erstellt einen dynamischen Register im angegebenen Ordner.
      Parameters:
      ixConnect - Indexserver-Verbindung
      folderName - Name des dynamischen Ordners
      parentId - ParentId des dynamischen Ordners
      maskName - Maske des dynamischen Ordners
      descr - Zusatztext/Definition der Datenbankabfrage
      Returns:
      ID des neuen Ordners
      Throws:
      Exception

    • uploadDocumentPreview

      public static void uploadDocumentPreview(IXconnect ixConnect, int objId, File previewFile) throws Exception
      Speichert das angegebene Vorschaudokument des Repository Dokumentes auf dem Indexserver.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Dokumentes
      previewFile - Vorschaudokument
      Throws:
      Exception

    • exportArchiveDocuments

      public static void exportArchiveDocuments(IXconnect ixConnect, int[] ids, File target, boolean zipFiles) throws Exception
      Speichert die angegebenen Dokumente in einer Zip-Datei oder in einem Ordner.
      Parameters:
      ixConnect - Indexserver-Verbindung
      ids - ObjektIds der Dokumente
      target - ZIP-Datei oder Zielordner
      zipFiles - Dokumente zippen
      Throws:
      Exception

    • exportArchiveDocuments

      public static void exportArchiveDocuments(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, File target, boolean zipFiles, boolean useShortName) throws Exception
      Speichert die angegebenen Dokumente in einer Zip-Datei oder in einem Ordner.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sords - Liste mit Einträgen
      target - ZIP-Datei oder Zielordner
      zipFiles - Dokumente zippen
      useShortName - Kurzbezeichnung als Dateiname verwenden
      Throws:
      Exception

    • getElementPath

      public static String getElementPath(IXconnect ixConnect, int objId) throws Exception
      Liefert einen String mit dem Pfad zum angegebenen Eintrag zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Eintrags
      Returns:
      Pfad zum Eintrag
      Throws:
      Exception

    • getElementPath

      public static String getElementPath(IXconnect ixConnect, String guid) throws Exception
      Liefert einen String mit dem Pfad zum angegebenen Eintrag zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      guid - GUID des Eintrags
      Returns:
      Pfad zum Eintrag
      Throws:
      Exception

    • getReferencePaths

      public static String[] getReferencePaths(IXconnect ixConnect, int objId) throws Exception
      Liefert eine Liste mit den Referenzpfaden des angegebenen Eintrags zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Eintrags
      Returns:
      Liste mit den Referenzpfaden
      Throws:
      Exception

    • fixElementPath

      public static String fixElementPath(String path, de.elo.ix.client.Sord sord) throws Exception
      Liefert einen vollständigen Ablagepfad aus dem angegebenen Ablagepfad und der Eintragsbezeichnung zurück.
      Parameters:
      path - Ablagepfad
      sord - Metadaten des Eintrags
      Returns:
      Vollständiger Ablagepfad
      Throws:
      Exception

    • getParentNames

      public static String[] getParentNames(IXconnect ixConnect, int objId) throws Exception
      Liefert eine Liste mit den Namen der übergeordneten Einträgen zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Eintrags, dessen Pfad ausgelesen wird
      Returns:
      Liste mit den Namen der übergeordneten Einträgen
      Throws:
      Exception

    • getJREString

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

    • getDefaultLang

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

    • getAsVersion

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

    • archivePathIsValid

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

    • archivePathExists

      public static boolean archivePathExists(IXconnect ixConnect, String archivePath) throws Exception
      Meldet zurück, ob der angegebene Ablagepfad existiert.
      Parameters:
      ixConnect - Indexserver-Verbindung
      archivePath - Ablagepfad
      Returns:
      Ablagepfad existiert
      Throws:
      Exception

    • createArcPath

      public static int createArcPath(IXconnect ixConnect, int parentId, String path) throws Exception
      Legt den angegebenen Ablagepfad an.
      Parameters:
      ixConnect - Indexserver-Verbindung
      parentId - Parent ID
      path - Ablagepfad als String
      Returns:
      ID des letzten Pfadeintrags
      Throws:
      Exception

    • createStorePath

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

    • getObjIdFromPath

      public static int getObjIdFromPath(IXconnect ixConnect, String archivePath) throws Exception
      Liefert die ID des Eintrags für den angegebenen Pfad zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      archivePath - Ablagepfad
      Returns:
      ObjektId
      Throws:
      Exception

    • getElemByArcpath

      public static de.elo.ix.client.Sord getElemByArcpath(IXconnect ixConnect, String arcPath) throws Exception
      Liefert den Eintrag mit dem angegebenen Ablagepfad zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      arcPath - Ablagepfad
      Returns:
      Eintrag oder null
      Throws:
      Exception

    • getElemByArcpathRelative

      public static de.elo.ix.client.Sord getElemByArcpathRelative(IXconnect ixConnect, int rootId, String arcPath) throws Exception
      Liefert den Eintrag über einen Ablagepfad relativ zu einem Startordner zurück.
      Parameters:
      ixConnect - Indexserver-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:
      Eintrag
      Throws:
      Exception - Fehler beim Lesen des Objektes vom Server

    • linkEntries

      public static void linkEntries(IXconnect ixConnect, int sourceObjId, int destObjId) throws Exception
      Verlinkt die Source Objekt-ID mit der Ziel Objekt-ID.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sourceObjId - ID des ersten Eintrags
      destObjId - ID des Zieleintrags
      Throws:
      Exception

    • unlinkEntries

      public static void unlinkEntries(IXconnect ixConnect, int sourceObjId, int destObjId) throws Exception
      Entfernt den Link zwischen den angegebenen Repository-Einträgen.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sourceObjId - Objekt-ID des ersten Eintrags
      destObjId - Objekt-ID des zweiten Eintrags
      Throws:
      Exception

    • getSordLinks

      public static List<de.elo.ix.client.SordLink> getSordLinks(IXconnect ixConnect, int objId) throws Exception
      Liefert alle ein- und ausgehende Links des angegebenen Eintrags.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - Id des Eintrags
      Returns:
      Liste mit den Links
      Throws:
      Exception

    • getDocIdFromUploadResult

      public static int getDocIdFromUploadResult(String uploadResult) throws Exception
      Liefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.
      Parameters:
      uploadResult - Upload-Ergebnis
      Returns:
      Dokument-ID
      Throws:
      Exception

    • downloadFilesFromFtp

      public static void downloadFilesFromFtp(String userName, String password, String host, int port, boolean useSsl, String ftpServerDirectory, String targetDirectory, String[] fileExtList, boolean deleteFtpFiles) throws Exception
      Lädt die Dateien mit den angegebenen Dateiendungen von einem FTP-Server im angegeben lokalen Verzeichnis herunter.
      Parameters:
      userName - Benutzername
      password - Passwort
      host - Host
      port - Port
      useSsl - SSL-Verschlüsselung verwenden
      ftpServerDirectory - Pfad auf dem FTP-Server
      targetDirectory - Zielverzeichnis
      fileExtList - Liste mit Dateiendungen
      deleteFtpFiles - Dateien auf dem FTP-Server löschen
      Throws:
      Exception

    • uploadFileToFtp

      public static void uploadFileToFtp(String userName, String password, String host, int port, boolean useSsl, File sourceFile, String targetFilePath) throws Exception
      Lädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.
      Parameters:
      userName - Benutzername
      password - Benutzerpasswort
      host - Host
      port - Port
      useSsl - SSL-Verschlüsselung verwenden
      sourceFile - Quelldatei
      targetFilePath - Pfad der Datei auf dem FTP-Server
      Throws:
      Exception

    • createJschSession

      public static com.jcraft.jsch.Session createJschSession(String username, String password, String host, int port) throws com.jcraft.jsch.JSchException, Exception
      Erzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.
      Parameters:
      username - Benutzername
      password - Benutzerpasswort
      host - Hostname
      port - Port für die Verbindung
      Returns:
      JSCH-Session
      Throws:
      com.jcraft.jsch.JSchException
      Exception

    • getChecksumReport

      public static ChecksumReport getChecksumReport(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, File reportFile, boolean logOnlyErrors) throws Exception
      Überprüft die Check-Summe der angegebenen Einträge.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sords - Liste mit den Metadaten-Objekten
      reportFile - Reportdatei
      logOnlyErrors - Nur Fehler loggen
      Returns:
      Report-Ergebnis
      Throws:
      Exception

    • saveChecksumReport

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

    • checkEntryChecksum

      public static int checkEntryChecksum(IXconnect ixConnect, de.elo.ix.client.Sord sord) throws Exception
      Überprüft die CheckSumme des angegebenen Eintrags. 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 - Indexserver-Verbindung
      sord - Metadaten eines Eintrags
      Returns:
      1: ok, 0: no document, -6: cannot read result, -10: checkum error
      Throws:
      Exception

    • checkEntryChecksumVersions

      public static int[] checkEntryChecksumVersions(IXconnect ixConnect, de.elo.ix.client.Sord sord) throws Exception
      Überprüft die CheckSumme von allen Versionen des angegebenen Eintrags. 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 - Indexserver-Verbindung
      sord - Metadaten eines Eintrags
      Returns:
      Liste mit den Ergebnissen
      Throws:
      Exception

    • getArchiveName

      public static String getArchiveName(IXconnect ixConnect) throws Exception
      Liefert die Repository-Bezeichnung zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Repository-Bezeichnung
      Throws:
      Exception

    • createExternalLinks

      public static ArrayList<de.elo.ix.client.PublicDownload> createExternalLinks(IXconnect ixConnect, int[] objIds, int downloadCount, String expiredIsoDate, boolean useShortName) throws Exception
      Erstellt die externen Links für die angegebenen Dokumente und liefert diese zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objIds - Liste mit Objekt-Ids
      downloadCount - Maximale Anzahl der Downloads
      expiredIsoDate - Ablaufdatum der Dokument-URL
      useShortName - Kurzbezeichnung verwenden
      Returns:
      Liste mit Download Links
      Throws:
      Exception

    • getFulltextFile

      public static File getFulltextFile(IXconnect ixConnect, int objId, File targetDir) throws Exception
      Erstellt eine Datei mit dem Volltext-Inhalt des Dokuments im angegebenen Verzeichnis.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      targetDir - Zielverzeichnis
      Returns:
      Datei mit dem Volltextinhalt
      Throws:
      Exception

    • getFulltextContent

      public static String getFulltextContent(IXconnect ixConnect, int objId) throws Exception
      Liefert den Volltext-Inhalt des angegebenen Eintrags zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Volltext-Inhalt
      Throws:
      Exception

    • insertSignature

      public static void insertSignature(IXconnect ixConnect, int objId, File sigFile) throws Exception
      Fügt die angegebene Datei als Signatur ein.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      sigFile - Signaturdatei
      Throws:
      Exception

    • getSignatureFile

      public static File getSignatureFile(IXconnect ixConnect, int objId, File targetDir) throws Exception
      Lädt die Signaturdatei des Dokuments im angegebenen Verzeichnis.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      targetDir - Zielverzeichnis
      Returns:
      Signaturdatei
      Throws:
      Exception

    • hasAttachment

      public static boolean hasAttachment(IXconnect ixConnect, int objId) throws Exception
      Meldet zurück, ob der angegebene Eintrag eine Dateianbindung enthält.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Eintrag enthält eine Dateianbindung
      Throws:
      Exception

    • hasSignature

      public static boolean hasSignature(IXconnect ixConnect, int objId) throws Exception
      Meldet zurück, ob der angegebene Eintrag eine Signatur hat.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Eintrag hat eine Signatur
      Throws:
      Exception

    • hasFulltext

      public static boolean hasFulltext(IXconnect ixConnect, int objId) throws Exception
      Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Eintrag hat einen Volltextinhalt
      Throws:
      Exception

    • getSubFolders

      public static ArrayList<de.elo.ix.client.Sord> getSubFolders(IXconnect ixConnect, int folderId) throws Exception
      Liefert eine Liste mit den Unterordnern des angegebenen Ordners zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      folderId - Ordner ID
      Returns:
      Liste mit den Unterordnern
      Throws:
      Exception

    • getFilingPaths

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

    • getDefaultPathId

      public static int getDefaultPathId(IXconnect ixConnect) throws Exception
      Liefert den Default-Ablagepfad zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Default-Ablagepfad
      Throws:
      Exception

    • getEditInfoFilingPaths

      public static de.elo.ix.client.EditInfo getEditInfoFilingPaths(IXconnect ixConnect) throws Exception
      Liefert das EditInfo-Objekt mit den Ablagepfaden zurück.
      Parameters:
      ixConnect - Indexserver-Vebindung
      Returns:
      EditInfo mit den Ablagepfaden
      Throws:
      Exception

    • getAsLibrariesNames

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

    • getPersonalFolder

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

    • addReportEntry

      public static void addReportEntry(IXconnect ixConnect, int objId, int actionNo, int extra1, int extra2, String message) throws Exception
      Schreibt einen Report Eintrag in die Datenbank. Der Parameter "actionNo" muss im Bereich von 3000 bis 3999 liegen.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ELO Objekt zu dem der Reporteintrag geschrieben werden soll
      actionNo - Aktionsnummer, Anwenderdefiniert, 3000...3999
      extra1 - Datenbankfeld extra1
      extra2 - Datenbankfeld extra2
      message - Kommentarfeld
      Throws:
      Exception - Wenn der Reporteintrag nicht angelegt werden kann

    • getReportInfo

      public static de.elo.ix.client.ReportInfo getReportInfo(IXconnect ixConnect, int objId, int userId, int actionNo, String comment, int extra1, int extra2, String extraInfo) throws Exception
      Erzeugt ein "ReportInfo"-Objekt aus den angegebenen Daten.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      userId - Benutzer-ID
      actionNo - Aktion Nummer
      comment - Kommentar der Aktion
      extra1 - Erstes Feld
      extra2 - Zweites Feld
      extraInfo - Zusätzliche Information
      Returns:
      ReportInfo Objekt
      Throws:
      Exception

    • saveReport

      public static void saveReport(IXconnect ixConnect, int userId, int objId, int actionNr, String startDate, String endDate, int maxReportCount, File targetFile) throws Exception
      Speichert die Reportdaten in der angegebenen Datei.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      objId - ID des Eintrags
      actionNr - Aktionsnummer oder -1 für alle Reporteinträge
      startDate - Startdatum oder null für keine Einschränkung
      endDate - Enddatum oder null für keine Einschränkung
      maxReportCount - Maximale Anzahl an Reporteinträgen
      targetFile - Textdatei, in der der Report geschrieben wird
      Throws:
      Exception

    • writeReportInfos

      public static void writeReportInfos(ArrayList<de.elo.ix.client.ReportInfo> reportInfos, int actionNr, int maxReportCount, File targetFile) throws Exception
      Schreibt die Reportdaten in der angegebenen Datei.
      Parameters:
      reportInfos - Liste mit Reportdaten
      actionNr - Aktion ID oder -1 für alle Reporteinträge
      maxReportCount - Maximale Anzahl an Reporteinträgen
      targetFile - Zieldatei
      Throws:
      Exception

    • getReportList

      public static ArrayList<de.elo.ix.client.ReportInfo> getReportList(IXconnect ixConnect, de.elo.ix.client.FindReportInfo findInfo) throws Exception
      Liefert eine Liste mit den Reporteinträgen für die angegebenen Suchkriterien zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      findInfo - Suchkriterien
      Returns:
      Liste mit Reporteinträgen
      Throws:
      Exception

    • getReportMode

      public static String getReportMode(IXconnect ixConnect) throws Exception
      Liefert den Report Modus aus den Reportoptionen zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Report Modus
      Throws:
      Exception

    • isValidGuid

      public static boolean isValidGuid(String guid) throws Exception
      Meldet zurück, ob die angegebene GUID ein gültiges Format besitzt.
      Parameters:
      guid - GUID
      Returns:
      GUID hat ein gültiges Format
      Throws:
      Exception

    • getLastDocumentId

      public static int getLastDocumentId(IXconnect ixConnect) throws Exception
      Liefert die letzte physikalische Dokumentennummer im Repository zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Letzte physikalische Dokumentennummer
      Throws:
      Exception