Package de.elo.mover.main.helper

Class ArchiveHelper

  • public class ArchiveHelper
extends java.lang.Object

    Überschrift: ArchiveHelper.

    Beschreibung: Hilfsklasse für wichtige Archivoperationen.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      ArchiveHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      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 Archivordner.
      static de.elo.ix.client.EditInfo createDefaultEditInfo​(IXconnect ixConnect, java.io.File file, java.lang.String maskName, int targetId)
      Erzeugt eine Default-Verschlagwortung 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 Archivdokumente 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 Archivdokumente 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 Archivpfad aus dem angegebenen Archivpfad und der Archiveintagsbezeichnung zurück.
      static java.lang.String getArchiveName​(IXconnect ixConnect)
      Liefert die Archivbezeichnung zurück.
      static de.elo.ix.client.EditInfo getEditInfoFromServer​(IXconnect ixConnect, java.lang.String objectId, boolean withLock)
      Liest das EditInfo direkt vom Server.
      static java.lang.String getElementPath​(IXconnect ixConnect, int objId)
      Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
      static java.lang.String getElementPath​(IXconnect ixConnect, java.lang.String guid)
      Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
      static java.lang.String getFulltextContent​(IXconnect ixConnect, int objId)
      Liefert den Volltext-Inhalt des angegebenen Archiveintrags zurück.
      static java.io.File getFulltextFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Erstellt eine Datei mit dem Volltext-Inhalt des Archivdokuments im angegebenen Verzeichnis.
      static de.elo.ix.client.SordZ getMbAllWithoutReplication()
      Liefert ein SordZ für alle Inhalte (mbAll) außer den Replikationseinstellungen (mbReplSet, mkReplNames).
      static java.lang.String[] getParentNames​(IXconnect ixConnect, int objId)
      Liefert eine Liste mit den Parentnamen zurück.
      static java.lang.String[] getReferencePaths​(IXconnect ixConnect, int objId)
      Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
      static java.io.File getSignatureFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Lädt die Signaturdatei des Archivdokuments 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)
      Archiviert die Datei im angegebenen Archivordner.
      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 Archivdokument.
      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 Detail

      • ArchiveHelper

        public ArchiveHelper()

    • Method Detail

      • 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 Archivdokument.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Datei, die als neue Version
        objId - Id des Archivdokuments
        version - Versionsbezeichnung
        versionComment - Versionskommentar
        isMilestone - Meilensteinversion
        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
        Archiviert die Datei im angegebenen Archivordner.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Datei, die archiviert wird
        targetId - Zielordner
        maskName - Verschlagwortungsmaske
        version - Versionsbezeichnung
        versionComment - Versionskommentar
        isMilestone - Meilensteinversion
        Returns:
        Id des Archivdokuments
        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 eine Default-Verschlagwortung für die angegebene Datei.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Zu archivierende Datei
        maskName - Maskennamen
        targetId - Id des Ablageordners
        Returns:
        Default-Verschlagwortung
        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 - Index Server Verbindung
        editInfo - EditInfo
        fileName - Dateiname
        versionInfo - Versionsnummer
        commentInfo - Versionskommentar
        isMilestone - Ist die neue Version ein Meilenstein
        updateDocDate - Dokumentdatum anpassen
        Throws:
        de.elo.utils.net.RemoteException
        java.lang.Exception

      • getMbAllWithoutReplication

        public static de.elo.ix.client.SordZ getMbAllWithoutReplication()
        Liefert ein SordZ für alle Inhalte (mbAll) außer den Replikationseinstellungen (mbReplSet, mkReplNames). Die Replikationskreise sollten bei der Archivablage eines Dokuments nicht geschrieben werden, der IX vererbt dann vom übergeordneten Ordner.
        Returns:
        SordZ

      • 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 Archivordner.
        Parameters:
        ixConnect - Index Server 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 - Index Server 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

      • exportArchiveDocuments

        public static void exportArchiveDocuments​(IXconnect ixConnect,
                                          int[] ids,
                                          java.io.File target,
                                          boolean zipFiles)
                                   throws java.lang.Exception
        Speichert die angegebenen Archivdokumente in einer ZIP-Datei oder in einem Ordner.
        Parameters:
        ixConnect - Index Server Verbindung
        ids - ObjektIds der Archivdokumente
        target - ZIP-Datei oder Zielordner
        zipFiles - Archivdokumente 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 Archivdokumente in einer ZIP-Datei oder in einem Ordner.
        Parameters:
        ixConnect - Index Server Verbindung
        sords - Liste mit Archiveinträgen
        target - ZIP-Datei oder Zielordner
        zipFiles - Archivdokumente 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 Archiveintrag zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        Returns:
        Pfad zum Archiveintrag
        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 Archiveintrag zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        guid - GUID des Archiveintrags
        Returns:
        Pfad zum Archiveintrag
        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 Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        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 Archivpfad aus dem angegebenen Archivpfad und der Archiveintagsbezeichnung zurück.
        Parameters:
        path - Archivpfad
        sord - Verschlagwortung des Archiveintrags
        Returns:
        reparierten Archivpfad
        Throws:
        java.lang.Exception

      • getParentNames

        public static java.lang.String[] getParentNames​(IXconnect ixConnect,
                                                int objId)
                                         throws java.lang.Exception
        Liefert eine Liste mit den Parentnamen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archivelements, dessen Pfad ausgelesen wird
        Returns:
        Liste mit Parentnamen
        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 EditInfo direkt vom Server. Nur in Ausnahmen verwenden! Für normale Fälle mit Cache getEditInfo benutzen!
        Parameters:
        ixConnect - Index Server Connection
        objectId - String Nummer des zu lesenden Objekts
        withLock - Bei True wird die EditInfo gesperrt
        Returns:
        EditInfo
        Throws:
        java.lang.Exception

      • getArchiveName

        public static java.lang.String getArchiveName​(IXconnect ixConnect)
                                       throws java.lang.Exception
        Liefert die Archivbezeichnung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Archivbezeichnung
        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 - Index Server Verbindung
        objIds - Liste mit Objekt-Ids
        downloadCount - Maximale Anzahl der Downloads
        expiredIsoDate - Ablaufdatum der Dokument-URL
        useShortName - Kurzbezeichnung verwenden
        Returns:
        Liste mit Verschlagwortungsinformationen
        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 Archivdokuments im angegebenen Verzeichnis.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        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 Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        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 - Index Server Verbindung
        objId - ID des Archiveintrags
        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 Archivdokuments im angegebenen Verzeichnis.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        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 - Index Server 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