Package de.elo.mover.main

Class Utils

java.lang.Object
de.elo.mover.main.Utils
public class Utils
extends java.lang.Object

Überschrift: Utils.

Beschreibung: Allgemeine ELOas Klasse mit Hilfsfunktionen.

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

  • Constructor Summary

    Constructors
    Constructor Description
    Utils()  

  • Method Summary

    Modifier and Type Method Description
    static java.lang.String appendActions​(java.lang.String uri)
    Wenn die URL nicht mit actions beendet wird, wird dieser Text am Ende angefügt.
    static void checkIn​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.io.File file, java.lang.String version, java.lang.String comment, boolean isMilestone)
    Checkt eine neue Dateiversion zu einem Sord Objekt ein.
    static int checkIn​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.lang.String data, java.lang.String fileName, java.lang.String version, java.lang.String comment, boolean isMilestone)
    Checkt eine neue Dateiversion zu einem Sord Objekt ein.
    static java.lang.String cleanupGroupName​(java.lang.String text)
    ELO Gruppennamen dürfen beliebige Zeichen enthalten, als JavaScript Variable sind aber nur Buchstaben, Ziffern und der Unterstrich zulässig.
    static java.lang.String escape​(java.lang.String fileText)
    Entfernt Zeilenumbrüche und führt escapes für " und ' ein.
    static java.lang.String escapeString​(java.lang.String text)
    Konvertiert den übergebenen String in eine XML/HTML kompatible Form.
    static java.lang.String fileToString​(java.io.File file, java.lang.String charSet)
    Liest eine Textdatei in einen String ein.
    static java.lang.String getFileExt​(java.io.File file)
    Liefert die Dateiendung zurück.
    static int getIntParam​(javax.servlet.http.HttpServletRequest request, java.lang.String name)
    Liefert den Wert eines Parameters als Integer Wert zurück.
    static java.lang.String getMoverData​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
    Liest die Regeldaten aus dem Sord Objekt.
    static java.lang.String getParamNotNull​(javax.servlet.http.HttpServletRequest request, java.lang.String name)
    Liefert einen Parameter Wert zurück.
    static java.io.File getTempFile​(java.lang.String tempDir, de.elo.ix.client.Sord sord)
    Bildet eine temporäre Datei aus dem temp-Pfad und der GUID des Sord Objekts
    static java.lang.String getText​(java.lang.String bundleName, java.lang.String textKey)
    Liefert den Text für den angegebenen Schlüssel zurück.
    static boolean isActionsPath​(java.lang.String uri)
    Ermittelt, ob eine URL mit "/actions" oder "/actions/" beendet wird.
    static boolean isEloInstPath​(java.lang.String uri)
    Ermittelt, ob eine URL mit "/eloinst" oder "/eloinst/" beendet wird.
    static java.lang.String loadUrl​(IXconnect ixConnect, java.lang.String url)
    Lädt die Daten aus einer Dokumenten-URL in einen MemoryStream und liefert sie als String zurück.
    static java.lang.String searchCheckoutData​(java.lang.String checkoutDir, de.elo.ix.client.Sord sord)
    Durchsucht das Checkout-Verzeichnis nach aktualisierten Versionen einen Rulesets oder JavaScript Library.
    static boolean splitZugferd​(java.lang.String fromPdf, java.lang.String toXml)  
    static void stringToFile​(java.lang.String text, java.io.File destinationFile, java.lang.String charSet)
    Schreibt einen String als Textdatei.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Utils

      public Utils()

  • Method Details

    • getFileExt

      public static java.lang.String getFileExt​(java.io.File file)
      Liefert die Dateiendung zurück. Die Dateiendung enthält auch den führenden Punkt, also z.B. ".txt".
      Parameters:
      file - Dateiobjekt mit Dateinamen
      Returns:
      Extension

    • escapeString

      public static java.lang.String escapeString​(java.lang.String text)
      Konvertiert den übergebenen String in eine XML/HTML kompatible Form.
      Parameters:
      text - Originaltext
      Returns:
      Text mit Escapes für die Sonderzeichen

    • cleanupGroupName

      public static java.lang.String cleanupGroupName​(java.lang.String text)
      ELO Gruppennamen dürfen beliebige Zeichen enthalten, als JavaScript Variable sind aber nur Buchstaben, Ziffern und der Unterstrich zulässig. Diese Funktion konvertiert unzulässige Zeichen in Unterstriche.
      Parameters:
      text - Gruppenname
      Returns:
      Konvertierter Text mit Unterstrichen für unzulässige Zeichen

    • fileToString

      public static java.lang.String fileToString​(java.io.File file, java.lang.String charSet) throws java.io.IOException
      Liest eine Textdatei in einen String ein.
      Parameters:
      file - Datei zum Lesen
      charSet - Zeichensatz
      Returns:
      Inhalt der Textdatei
      Throws:
      java.io.IOException

    • stringToFile

      public static void stringToFile​(java.lang.String text, java.io.File destinationFile, java.lang.String charSet) throws java.io.IOException
      Schreibt einen String als Textdatei.
      Parameters:
      text - Zu schreibender Text
      destinationFile - Zieldatei
      charSet - Zeichensatz
      Throws:
      java.io.IOException

    • getTempFile

      public static java.io.File getTempFile​(java.lang.String tempDir, de.elo.ix.client.Sord sord)
      Bildet eine temporäre Datei aus dem temp-Pfad und der GUID des Sord Objekts
      Parameters:
      tempDir - Verzeichnis für die temp-Datei
      sord - Sord Objekt mit der GUID für den Dateinamen
      Returns:
      Dateiobjekt

    • getMoverData

      public static java.lang.String getMoverData​(IXconnect ixConnect, de.elo.ix.client.Sord sord) throws java.rmi.RemoteException, java.io.IOException
      Liest die Regeldaten aus dem Sord Objekt. Diese können entweder direkt im Zusatztext stehen oder in der Dokumentendatei. Die Datei wird nur ausgelesen, wenn das Rule-Sord Objekt ein Dokument ist, eine Dokumentendatei vorhanden ist und in der ELO MOVER Konfiguration ein tempdir Verzeichnis konfiguriert wurde.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Metadaten eines Eintrags
      Returns:
      Regeldaten des Metadaten-Objekts
      Throws:
      java.rmi.RemoteException
      java.io.IOException

    • searchCheckoutData

      public static java.lang.String searchCheckoutData​(java.lang.String checkoutDir, de.elo.ix.client.Sord sord) throws java.io.IOException
      Durchsucht das Checkout-Verzeichnis nach aktualisierten Versionen einen Rulesets oder JavaScript Library.
      Parameters:
      checkoutDir - CheckOut-Verzeichnis im Dateisystem
      sord - Ruleset oder Lib-Eintrag im Repository
      Returns:
      Dateiinhalt aus dem checkout Bereich oder null wenn keine neuere Version vorhanden ist
      Throws:
      java.io.IOException

    • loadUrl

      public static java.lang.String loadUrl​(IXconnect ixConnect, java.lang.String url) throws java.rmi.RemoteException
      Lädt die Daten aus einer Dokumenten-URL in einen MemoryStream und liefert sie als String zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      url - Dokumenten URL
      Returns:
      Dokumenteninhalt als String
      Throws:
      java.rmi.RemoteException

    • checkIn

      public static void checkIn​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.io.File file, java.lang.String version, java.lang.String comment, boolean isMilestone) throws java.rmi.RemoteException
      Checkt eine neue Dateiversion zu einem Sord Objekt ein.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Zieldokument
      file - Neue Dateiversion
      version - Versionsnummer in der History
      comment - Versinskommentar in der History
      isMilestone - Flag - Nicht löschbare Version
      Throws:
      java.rmi.RemoteException

    • checkIn

      public static int checkIn​(IXconnect ixConnect, de.elo.ix.client.Sord sord, java.lang.String data, java.lang.String fileName, java.lang.String version, java.lang.String comment, boolean isMilestone) throws java.rmi.RemoteException, java.io.UnsupportedEncodingException
      Checkt eine neue Dateiversion zu einem Sord Objekt ein.
      Parameters:
      ixConnect - Indexserver-Verbindung
      sord - Zieldokument
      data - Daten
      fileName - Dateiname
      version - Versionsnummer in der History
      comment - Versinskommentar in der History
      isMilestone - Flag - Nicht löschbare Version
      Returns:
      ID der neuen Version
      Throws:
      java.rmi.RemoteException
      java.io.UnsupportedEncodingException

    • appendActions

      public static java.lang.String appendActions​(java.lang.String uri)
      Wenn die URL nicht mit actions beendet wird, wird dieser Text am Ende angefügt.
      Parameters:
      uri - zur prüfende URL
      Returns:
      URL mit /actions am Ende

    • isActionsPath

      public static boolean isActionsPath​(java.lang.String uri)
      Ermittelt, ob eine URL mit "/actions" oder "/actions/" beendet wird.
      Parameters:
      uri - URL
      Returns:
      URL endet mit "/actions" oder "/actions/"

    • isEloInstPath

      public static boolean isEloInstPath​(java.lang.String uri)
      Ermittelt, ob eine URL mit "/eloinst" oder "/eloinst/" beendet wird.
      Parameters:
      uri - URL
      Returns:
      URL endet mit "/eloinst" oder "/eloinst/"

    • getParamNotNull

      public static java.lang.String getParamNotNull​(javax.servlet.http.HttpServletRequest request, java.lang.String name)
      Liefert einen Parameter Wert zurück. Wenn der Parameter nicht existiert, wird keine null sondern ein Leerstring zurückgegeben.
      Parameters:
      request - HttpRequest Objekt mit allen Parametern
      name - Name des gewünschten Parameters
      Returns:
      Wert des Parameters oder Leerstring

    • getIntParam

      public static int getIntParam​(javax.servlet.http.HttpServletRequest request, java.lang.String name)
      Liefert den Wert eines Parameters als Integer Wert zurück.
      Parameters:
      request - HttpRequest Objekt
      name - gewünschter Parameter
      Returns:
      Wert des gewünschten Parameters oder -1 falls nicht vorhanden

    • splitZugferd

      public static boolean splitZugferd​(java.lang.String fromPdf, java.lang.String toXml)

    • escape

      public static java.lang.String escape​(java.lang.String fileText)
      Entfernt Zeilenumbrüche und führt escapes für " und ' ein.
      Parameters:
      fileText - Original-Text
      Returns:
      escape-Text

    • getText

      public static java.lang.String getText​(java.lang.String bundleName, java.lang.String textKey) throws java.lang.Exception
      Liefert den Text für den angegebenen Schlüssel zurück.
      Parameters:
      bundleName - Name der Textdatei
      textKey - Textschlüssel
      Returns:
      Text
      Throws:
      java.lang.Exception