Package de.elo.mover.main.helper

Class ArchiveHelper

java.lang.Object
de.elo.mover.main.helper.ArchiveHelper
public class ArchiveHelper
extends java.lang.Object

Überschrift: ArchiveHelper.

Beschreibung: Hilfsklasse für wichtige Operationen im Repository.

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

  • Constructor Summary

    Constructors
    Constructor Description
    ArchiveHelper()  

  • Method Summary

    Modifier and Type Method Description
    static int addDynamicFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName, java.lang.String descr)
    Erstellt einen dynamischen Register im angegebenen Ordner.
    static int addNewFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName)
    Erzeugt einen neuen Ordner im angegebenen Ordner.
    static de.elo.ix.client.EditInfo createDefaultEditInfo​(IXconnect ixConnect, java.io.File file, java.lang.String maskName, int targetId)
    Erzeugt die Default-Metadaten für die angegebene Datei.
    static java.util.ArrayList<de.elo.ix.client.PublicDownload> createExternalLinks​(IXconnect ixConnect, int[] objIds, int downloadCount, java.lang.String expiredIsoDate, boolean useShortName)
    Erstellt die externen Links für die angegebenen Dokumente und liefert diese zurück.
    static void exportArchiveDocuments​(IXconnect ixConnect, int[] ids, java.io.File target, boolean zipFiles)
    Speichert die angegebenen Dokumente in einer ZIP-Datei oder in einem Ordner.
    static void exportArchiveDocuments​(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, java.io.File target, boolean zipFiles, boolean useShortName)
    Speichert die angegebenen Dokumente in einer ZIP-Datei oder in einem Ordner.
    static java.lang.String fixElementPath​(java.lang.String path, de.elo.ix.client.Sord sord)
    Liefert einen vollständigen Repositorypfad aus dem angegebenen Repositorypfad und der Eintagsbezeichnung zurück.
    static java.lang.String getArchiveName​(IXconnect ixConnect)
    Liefert die Bezeichnung des Repository zurück.
    static de.elo.ix.client.EditInfo getEditInfoFromServer​(IXconnect ixConnect, java.lang.String objectId, boolean withLock)
    Liest das Objekt mit allen Metadaten direkt vom Indexserver.
    static java.lang.String getElementPath​(IXconnect ixConnect, int objId)
    Liefert einen String mit dem Pfad zum angegebenen Eintrag zurück.
    static java.lang.String getElementPath​(IXconnect ixConnect, java.lang.String guid)
    Liefert einen String mit dem Pfad zum angegebenen Eintrag zurück.
    static java.lang.String getFulltextContent​(IXconnect ixConnect, int objId)
    Liefert den Volltext-Inhalt des angegebenen Eintrags zurück.
    static java.io.File getFulltextFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
    Erstellt eine Datei mit dem Volltext-Inhalt des Dokuments im angegebenen Verzeichnis.
    static de.elo.ix.client.SordZ getMbAllWithoutReplication()
    Liefert einen Selektor für alle Inhalte eines Eintrags außer den Replikationseinstellungen (mbReplSet, mkReplNames) zurück.
    static java.lang.String[] getParentNames​(IXconnect ixConnect, int objId)
    Liefert eine Liste mit den Bezeichnungen der übergeordneten Einträge zurück.
    static java.lang.String[] getReferencePaths​(IXconnect ixConnect, int objId)
    Liefert eine Liste mit den Referenzpfaden des angegebenen Eintrags zurück.
    static java.io.File getSignatureFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
    Lädt die Signaturdatei des Dokuments im angegebenen Verzeichnis.
    static java.util.ArrayList<de.elo.ix.client.Sord> getSubFolders​(IXconnect ixConnect, int folderId)
    Liefert eine Liste mit den Unterordnern des angegebenen Ordners zurück.
    static int insertIntoArchive​(IXconnect ixConnect, java.io.File file, int targetId, java.lang.String maskName, java.lang.String version, java.lang.String versionComment, boolean isMilestone)
    Legt die Datei im angegebenen Ordner ab.
    static void insertSignature​(IXconnect ixConnect, int objId, java.io.File sigFile)
    Fügt die angegebene Datei als Signatur ein.
    static boolean isValidGuid​(java.lang.String guid)
    Meldet zurück, ob die angegebene GUID ein gültiges Format besitzt.
    static void saveDocumentVersion​(IXconnect ixConnect, java.io.File file, int objId, java.lang.String version, java.lang.String versionComment, boolean isMilestone)
    Speichert die angegebene Datei als eine neue Version an dem Dokument.
    static void uploadDocumentPreview​(IXconnect ixConnect, int objId, java.io.File previewFile)
    Speichert das angegebene Vorschaudokument des Repository Dokumentes auf dem Indexserver.
    static void uploadFromFile​(IXconnect ixConnect, de.elo.ix.client.EditInfo editInfo, java.lang.String fileName, java.lang.String versionInfo, java.lang.String commentInfo, boolean isMilestone, boolean updateDocDate)
    Lädt die angegebene Datei auf den Indexserver hoch.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ArchiveHelper

      public ArchiveHelper()

  • Method Details

    • saveDocumentVersion

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

    • insertIntoArchive

      public static int insertIntoArchive​(IXconnect ixConnect, java.io.File file, int targetId, java.lang.String maskName, java.lang.String version, java.lang.String versionComment, boolean isMilestone) throws java.lang.Exception
      Legt die Datei im angegebenen Ordner 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:
      java.lang.Exception

    • createDefaultEditInfo

      public static de.elo.ix.client.EditInfo createDefaultEditInfo​(IXconnect ixConnect, java.io.File file, java.lang.String maskName, int targetId) throws byps.RemoteException, java.lang.Exception
      Erzeugt die 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
      java.lang.Exception

    • uploadFromFile

      public static void uploadFromFile​(IXconnect ixConnect, de.elo.ix.client.EditInfo editInfo, java.lang.String fileName, java.lang.String versionInfo, java.lang.String commentInfo, boolean isMilestone, boolean updateDocDate) throws de.elo.utils.net.RemoteException, java.lang.Exception
      Lädt die angegebene Datei auf den Indexserver hoch.
      Parameters:
      ixConnect - Indexserver-Verbindung
      editInfo - EditInfo
      fileName - Dateiname
      versionInfo - Versionsnummer
      commentInfo - Versionskommentar
      isMilestone - Nicht löschbare Version
      updateDocDate - Dokumentdatum anpassen
      Throws:
      de.elo.utils.net.RemoteException
      java.lang.Exception

    • getMbAllWithoutReplication

      public static de.elo.ix.client.SordZ getMbAllWithoutReplication()
      Liefert einen Selektor für alle Inhalte eines Eintrags außer den Replikationseinstellungen (mbReplSet, mkReplNames) zurück. Die Replikationskreise sollten bei der Ablage eines Dokuments nicht geschrieben werden, der Indexserver vererbt diese vom übergeordneten Ordner.
      Returns:
      Selektor für die Inhalte eines Eintrags

    • addNewFolder

      public static int addNewFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName) throws byps.RemoteException, java.lang.Exception
      Erzeugt einen neuen Ordner im angegebenen Ordner.
      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
      java.lang.Exception

    • addDynamicFolder

      public static int addDynamicFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName, java.lang.String descr) throws java.lang.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:
      java.lang.Exception

    • uploadDocumentPreview

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

    • exportArchiveDocuments

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

    • exportArchiveDocuments

      public static void exportArchiveDocuments​(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, java.io.File target, boolean zipFiles, boolean useShortName) throws java.lang.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 im Dateinamen verwenden
      Throws:
      java.lang.Exception

    • getElementPath

      public static java.lang.String getElementPath​(IXconnect ixConnect, int objId) throws java.lang.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:
      java.lang.Exception

    • getElementPath

      public static java.lang.String getElementPath​(IXconnect ixConnect, java.lang.String guid) throws java.lang.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:
      java.lang.Exception

    • getReferencePaths

      public static java.lang.String[] getReferencePaths​(IXconnect ixConnect, int objId) throws java.lang.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:
      java.lang.Exception

    • fixElementPath

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

    • getParentNames

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

    • getEditInfoFromServer

      public static de.elo.ix.client.EditInfo getEditInfoFromServer​(IXconnect ixConnect, java.lang.String objectId, boolean withLock) throws java.lang.Exception
      Liest das Objekt mit allen Metadaten direkt vom Indexserver.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objectId - ID des zu lesenden Eintrags
      withLock - Bei True wird der Eintrag gesperrt
      Returns:
      Metadaten eines Eintrags
      Throws:
      java.lang.Exception

    • getArchiveName

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

    • createExternalLinks

      public static java.util.ArrayList<de.elo.ix.client.PublicDownload> createExternalLinks​(IXconnect ixConnect, int[] objIds, int downloadCount, java.lang.String expiredIsoDate, boolean useShortName) throws java.lang.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 Metadaten
      Throws:
      java.lang.Exception

    • getFulltextFile

      public static java.io.File getFulltextFile​(IXconnect ixConnect, int objId, java.io.File targetDir) throws java.lang.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:
      java.lang.Exception

    • getFulltextContent

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

    • insertSignature

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

    • getSignatureFile

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

    • getSubFolders

      public static java.util.ArrayList<de.elo.ix.client.Sord> getSubFolders​(IXconnect ixConnect, int folderId) throws java.lang.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:
      java.lang.Exception

    • isValidGuid

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