Package de.elo.mover.main.helper
Class RequestHelper
- java.lang.Object
-
- de.elo.mover.main.helper.RequestHelper
-
public class RequestHelper extends java.lang.ObjectÜberschrift: RequestHelper.
Beschreibung: Hilfsklasse für das Versenden von Requests.
Copyright: Copyright (c) ELO Digital Office GmbH 2018
-
-
Constructor Summary
Constructors Constructor Description RequestHelper()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static voidaddAttachment(IXconnect ixConnect, int objId, java.io.File sourceFile)Fügt eine Dateianbindung an das angegebene Archivelement.static voidcreateFeedAction(IXconnect ixConnect, int objId, java.lang.String text)Fügt den angegebenen Text im Feed ein.static com.jcraft.jsch.SessioncreateJschSession(java.lang.String username, java.lang.String password, java.lang.String host, int port)Erzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.static longcreateMyEventType()Erzeugt einen neuen eigenen Ereignistyp, der außerhalb der definierten IX-Ereignistypen liegt.static TriggerInfocreateTriggerInfo(javax.servlet.http.HttpServletRequest request, int userId)Liefert das TriggerInfo-Objekt aus dem angegebenen HTTP-Request zurück.static voiddeleteSubscriptions(IXconnect ixConnect, java.util.HashMap<java.lang.String,de.elo.ix.client.Subscription> subs)Löscht die angegebenen Abbonaments.static java.util.ArrayList<de.elo.ix.client.ConfigFile>findConfigFiles(IXconnect ixConnect, java.lang.String configDir, java.lang.String postboxUserId, boolean inclDeputy)Liefert eine Liste mit den vorhandenen Konfigurationsdateien zurück.static java.io.FilegetAttachmentVersion(IXconnect ixConnect, int objId, java.io.File targetDir)Liefert die Arbeitsversion der Dateianbindung des angegebenen Archivdokuments zurück.static intgetDocIdFromUploadResult(java.lang.String uploadResult)Liefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.static java.io.FilegetDocumentVersion(IXconnect ixConnect, int objId, java.io.File targetDir)Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.static java.io.FilegetDocumentVersion(IXconnect ixConnect, int objId, java.io.File targetDir, boolean useShortName)Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.static voidgetDocumentVersionPart(IXconnect ixConnect, int objId, java.io.File targetFile, long offset, long length)Lädt den angegebene Teil der Arbeitsversion herunter.static de.elo.ix.client.feed.Action[]getFeedActions(IXconnect ixConnect, int objId)Liefert eine Liste mit den Feed Aktionen zum angegebenen Archiveintrag zurück.static java.lang.StringgetFeedGuid(IXconnect ixConnect, int objId)Liefert das Feed GUID des angegebenen Archiveintrags zurück.static java.lang.String[]getGuids(de.elo.ix.client.feed.Action[] actions)Liefert eine Liste mit den GUIDs der angegebenen Feed Aktionen zurück.static java.lang.StringgetIxFileName(IXconnect ixConnect, java.lang.String fileName, java.lang.String userName, boolean intrayTransfer, boolean saveFilesOnServer)Liefert den passenden IX-Dateinamen für den angegebenen Benutzer zurück.static java.lang.StringgetLanguage(javax.servlet.http.HttpServletRequest request)Liefert die Sprache aus dem angegebenen ServletRequest zurück.static java.util.LocalegetLocale(javax.servlet.http.HttpServletRequest request)Liefert das Locale-Objekt aus dem angegebenen HTTP-Request zurück.static java.util.ArrayList<de.elo.ix.client.Notification>getNotificationList(IXconnect ixConnect)Liefert eine Liste mit den vorhandenen Notifications zurück.static java.util.Map<java.lang.String,de.elo.ix.client.Notification>getNotificationMap(IXconnect ixConnect)Liefert eine Map mit den vorhandenen Notifications zurück.static java.lang.StringgetRelativePath(javax.servlet.http.HttpServletRequest request)Liefert den relativen Pfad aus dem angegebenen ServletRequest zurück.static java.lang.StringgetStackTrace(java.lang.Exception exc)Liefert den StackTrace der angegebenen Fehlermeldung als String zurück.static java.lang.StringgetTextFromIxUrl(IXconnect ixConnect, java.lang.String ixUrl, java.io.File targetFile)Speichert den Text der Index Server URL in der angegebenen Datei und liefert den Text zurück.static booleanhasAttachment(IXconnect ixConnect, int objId)Meldet zurück, ob der angegebene Archiveintrag eine Dateianbindung enthält.static booleanhasFulltext(IXconnect ixConnect, int objId)Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.static booleanhasSignature(IXconnect ixConnect, int objId)Meldet zurück, ob der angegebene Archiveintrag eine Signatur hat.static de.elo.ix.client.SubscriptioninsertSubscription(IXconnect ixConnect, java.lang.String feedGuid)Erstellt ein neues Abbonament für die angegebene Feed GUID.static booleanisExceptionType(IXconnect ixConnect, java.lang.Exception exc, int excType)Meldet zurück, ob die Fehlermeldung vom angegebenen Typ ist.static booleanisIxAvailable(java.lang.String ixUrl)Meldet zurück, ob die angegebene Index Server URL erreichbar ist.static booleanisIxProxy(javax.servlet.http.HttpServletRequest request)Meldet zurück, ob der Index Server Proxy aktiv ist.static voidloadFileFromFtp(com.jcraft.jsch.Session session, java.io.File outputFile, java.lang.String remoteDir, boolean delSourceFile)Lädt eine Datei von einem SFTP-Server im angegeben File-Objekt herunter.static voidloadFilesFromServer(IXconnect ixConnect, java.io.File targetDir, java.lang.String userName, boolean intrayTransfer)Lädt die Index Server Dateien für den angegebenen Benutzer herunter.static voidremoveAttachments(IXconnect ixConnect, int objId)Entfernt die Dateianbindung des angegebenen Archivdokuments.static voidremoveCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String name)Entfernt das angegebene Cookie-Objekt.static java.lang.StringretrieveTicket(javax.servlet.http.HttpServletRequest request)Liefert das Index Server Ticket aus dem angegebenen ServletRequest zurück.static voidsaveFilesOnServer(IXconnect ixConnect, java.util.List<java.io.File> localFiles, java.lang.String userName, boolean intrayTransfer)Speichert die angegebenen Postbox- oder Checkout-Dateien auf dem Index Server.static voidsaveIntrayFilesOnServer(IXconnect ixConnect, java.lang.String dirPath)Speichert die Benutzer Postboxdateien aus dem angegebenen Postbox Verzeichnis in der entsprechenden Index Server Postbox.static voidsendHttpGetRequest(java.lang.String url, java.io.File responseFile)Sendet eine HTTP GET-Anfrage an der angegebenen URL.static voidsendHttpPostRequest(java.lang.String url, byte[] source)Sendet eine HTTP Post-Anfrage an der angegebenen URL.static voidsendHttpPostRequest(java.lang.String url, java.io.File sourceFile)Sendet eine HTTP-Post Anfrage an der angegebenen URL.static voiduploadFileToFtp(com.jcraft.jsch.Session session, java.io.File sourceFile, java.lang.String targetFilePath)Lädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.static voidwriteCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String name, java.lang.String value, java.lang.String path, boolean secure)Speichert das angegebene Cookie-Objekt.
-
-
-
Method Detail
-
sendHttpGetRequest
public static void sendHttpGetRequest(java.lang.String url, java.io.File responseFile) throws java.io.IOException, java.lang.ExceptionSendet eine HTTP GET-Anfrage an der angegebenen URL.- Parameters:
url- URL, an die die Anfrage gesendet wirdresponseFile- Datei mit dem HTTP-Ergebnis- Throws:
java.io.IOExceptionjava.lang.Exception
-
sendHttpPostRequest
public static void sendHttpPostRequest(java.lang.String url, java.io.File sourceFile) throws java.lang.ExceptionSendet eine HTTP-Post Anfrage an der angegebenen URL.- Parameters:
url- URL, an die die Anfrage gesendet wirdsourceFile- Datei mit den Daten, die versendet werden- Throws:
java.lang.Exception
-
sendHttpPostRequest
public static void sendHttpPostRequest(java.lang.String url, byte[] source) throws java.lang.ExceptionSendet eine HTTP Post-Anfrage an der angegebenen URL.- Parameters:
url- URL, an die die Anfrage gesendet wirdsource- byte-Array mit den Daten für die Anfrage- Throws:
java.lang.Exception
-
getDocumentVersion
public static java.io.File getDocumentVersion(IXconnect ixConnect, int objId, java.io.File targetDir) throws java.lang.Exception
Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.- Parameters:
ixConnect- Index Server VerbindungobjId- Id des ArchivdokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wird- Returns:
- Arbeitsversion
- Throws:
java.lang.Exception
-
getDocumentVersion
public static java.io.File getDocumentVersion(IXconnect ixConnect, int objId, java.io.File targetDir, boolean useShortName) throws java.lang.Exception
Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.- Parameters:
ixConnect- Index Server VerbindungobjId- Id des ArchivdokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wirduseShortName- Kurzbezeichnung als Dateinamen verwenden- Returns:
- Arbeitsversion
- Throws:
java.lang.Exception
-
getAttachmentVersion
public static java.io.File getAttachmentVersion(IXconnect ixConnect, int objId, java.io.File targetDir) throws java.lang.Exception
Liefert die Arbeitsversion der Dateianbindung des angegebenen Archivdokuments zurück.- Parameters:
ixConnect- Index Server VerbindungobjId- Id des ArchivdokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wird- Returns:
- Arbeitsversion
- Throws:
java.lang.Exception
-
removeAttachments
public static void removeAttachments(IXconnect ixConnect, int objId) throws java.lang.Exception
Entfernt die Dateianbindung des angegebenen Archivdokuments.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archivdokuments- Throws:
java.lang.Exception
-
addAttachment
public static void addAttachment(IXconnect ixConnect, int objId, java.io.File sourceFile) throws java.lang.Exception
Fügt eine Dateianbindung an das angegebene Archivelement.- Parameters:
ixConnect- Index Server VerbindungobjId- Id des Dokuments, zu dem die Dateianbindung eingefügt wirdsourceFile- Dateianbindung- Throws:
java.lang.Exception
-
hasAttachment
public static boolean hasAttachment(IXconnect ixConnect, int objId) throws java.lang.Exception
Meldet zurück, ob der angegebene Archiveintrag eine Dateianbindung enthält.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archiveintrags- Returns:
- Archiveintrag enthält eine Dateianbindung
- Throws:
java.lang.Exception
-
hasSignature
public static boolean hasSignature(IXconnect ixConnect, int objId) throws java.lang.Exception
Meldet zurück, ob der angegebene Archiveintrag eine Signatur hat.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archiveintrags- Returns:
- Archiveintrag hat eine Signatur
- Throws:
java.lang.Exception
-
hasFulltext
public static boolean hasFulltext(IXconnect ixConnect, int objId) throws java.lang.Exception
Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archiveintragss- Returns:
- Archiveintrag hat einen Volltextinhalt
- Throws:
java.lang.Exception
-
getDocIdFromUploadResult
public static int getDocIdFromUploadResult(java.lang.String uploadResult) throws java.lang.ExceptionLiefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.- Parameters:
uploadResult- Upload-Ergebnis- Returns:
- Dokument-ID
- Throws:
java.lang.Exception
-
loadFileFromFtp
public static void loadFileFromFtp(com.jcraft.jsch.Session session, java.io.File outputFile, java.lang.String remoteDir, boolean delSourceFile) throws java.lang.ExceptionLädt eine Datei von einem SFTP-Server im angegeben File-Objekt herunter.- Parameters:
session- Session-ObjektoutputFile- ZieldateiremoteDir- Verzeichnis, von dem die Datei heruntergeladen wirddelSourceFile- Datei auf dem FTP-Server löschen- Throws:
java.lang.Exception
-
uploadFileToFtp
public static void uploadFileToFtp(com.jcraft.jsch.Session session, java.io.File sourceFile, java.lang.String targetFilePath) throws java.lang.ExceptionLädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.- Parameters:
session- Session ObjektsourceFile- QuelldateitargetFilePath- Pfad der Datei auf dem FTP-Server- Throws:
java.lang.Exception
-
createJschSession
public static com.jcraft.jsch.Session createJschSession(java.lang.String username, java.lang.String password, java.lang.String host, int port) throws com.jcraft.jsch.JSchException, java.lang.ExceptionErzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.- Parameters:
username- Benutzernamepassword- Benutzerpassworthost- Hostnameport- Port für die Verbindung- Returns:
- JSCH-Session
- Throws:
com.jcraft.jsch.JSchExceptionjava.lang.Exception
-
createMyEventType
public static long createMyEventType()
Erzeugt einen neuen eigenen Ereignistyp, der außerhalb der definierten IX-Ereignistypen liegt.- Returns:
- eigener Ereignistyp
-
createFeedAction
public static void createFeedAction(IXconnect ixConnect, int objId, java.lang.String text) throws java.lang.Exception
Fügt den angegebenen Text im Feed ein.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archiveintragstext- Text- Throws:
java.lang.Exception
-
getGuids
public static java.lang.String[] getGuids(de.elo.ix.client.feed.Action[] actions) throws java.lang.ExceptionLiefert eine Liste mit den GUIDs der angegebenen Feed Aktionen zurück.- Parameters:
actions- Liste mit Feed Aktionen- Returns:
- Liste mit GUIDs
- Throws:
java.lang.Exception
-
getFeedActions
public static de.elo.ix.client.feed.Action[] getFeedActions(IXconnect ixConnect, int objId) throws java.lang.Exception
Liefert eine Liste mit den Feed Aktionen zum angegebenen Archiveintrag zurück.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des Archiveintrags- Returns:
- Liste mit Feed Aktionen
- Throws:
java.lang.Exception
-
getDocumentVersionPart
public static void getDocumentVersionPart(IXconnect ixConnect, int objId, java.io.File targetFile, long offset, long length) throws java.lang.Exception
Lädt den angegebene Teil der Arbeitsversion herunter.- Parameters:
ixConnect- Index Server VerbindungobjId- ID des ArchivdokumentstargetFile- Zieldateioffset- Versatzlength- Länge der zu lesenden Daten- Throws:
java.lang.Exception
-
saveFilesOnServer
public static void saveFilesOnServer(IXconnect ixConnect, java.util.List<java.io.File> localFiles, java.lang.String userName, boolean intrayTransfer) throws java.lang.Exception
Speichert die angegebenen Postbox- oder Checkout-Dateien auf dem Index Server.- Parameters:
ixConnect- Index Server VerbindunglocalFiles- Liste mit lokalen DateienuserName- BenutzernameintrayTransfer- Postbox- oder Checkout Dateien speichern- Throws:
java.lang.Exception
-
saveIntrayFilesOnServer
public static void saveIntrayFilesOnServer(IXconnect ixConnect, java.lang.String dirPath) throws java.lang.Exception
Speichert die Benutzer Postboxdateien aus dem angegebenen Postbox Verzeichnis in der entsprechenden Index Server Postbox.- Parameters:
ixConnect- Index Server VerbindungdirPath- Verzeichnis mit Postboxdateien für die einzelnen Benutzer- Throws:
java.lang.Exception
-
loadFilesFromServer
public static void loadFilesFromServer(IXconnect ixConnect, java.io.File targetDir, java.lang.String userName, boolean intrayTransfer) throws java.lang.Exception
Lädt die Index Server Dateien für den angegebenen Benutzer herunter.- Parameters:
ixConnect- Index Server VerbindungtargetDir- Verzeichnis, in dem die Dateien heruntergeladen werdenuserName- BenutzernameintrayTransfer- Postbox-Dateien herunterladen- Throws:
java.lang.Exception
-
getIxFileName
public static java.lang.String getIxFileName(IXconnect ixConnect, java.lang.String fileName, java.lang.String userName, boolean intrayTransfer, boolean saveFilesOnServer) throws java.lang.Exception
Liefert den passenden IX-Dateinamen für den angegebenen Benutzer zurück.- Parameters:
ixConnect- Index Server VerbindungfileName- Name der Datei ohne den DateipfaduserName- BenutzerintrayTransfer- Postboxdatei oder ausgechecktes DokumentsaveFilesOnServer- Lokale Dateien auf dem Server auslagern- Returns:
- Index Server Dateiname
- Throws:
java.lang.Exception
-
findConfigFiles
public static java.util.ArrayList<de.elo.ix.client.ConfigFile> findConfigFiles(IXconnect ixConnect, java.lang.String configDir, java.lang.String postboxUserId, boolean inclDeputy) throws java.lang.Exception
Liefert eine Liste mit den vorhandenen Konfigurationsdateien zurück.- Parameters:
ixConnect- Index Server VerbindungconfigDir- Verzeichnis für die KonfigurationsdateienpostboxUserId- ID des Postbox BenutzersinclDeputy- inklusive Vertretungen- Returns:
- Liste mit Konfigurationsdateien
- Throws:
java.lang.Exception
-
isIxAvailable
public static boolean isIxAvailable(java.lang.String ixUrl) throws java.lang.ExceptionMeldet zurück, ob die angegebene Index Server URL erreichbar ist.- Parameters:
ixUrl- Index Server URL- Returns:
- URL ist erreichbar
- Throws:
java.lang.Exception
-
createTriggerInfo
public static TriggerInfo createTriggerInfo(javax.servlet.http.HttpServletRequest request, int userId)
Liefert das TriggerInfo-Objekt aus dem angegebenen HTTP-Request zurück.- Parameters:
request- HTTP-RequestuserId- Benutzer ID- Returns:
- TriggerInfo
-
getLocale
public static java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request) throws java.lang.ExceptionLiefert das Locale-Objekt aus dem angegebenen HTTP-Request zurück.- Parameters:
request- HttpServletRequest- Returns:
- Locale-Objekt
- Throws:
java.lang.Exception
-
isExceptionType
public static boolean isExceptionType(IXconnect ixConnect, java.lang.Exception exc, int excType) throws java.lang.Exception
Meldet zurück, ob die Fehlermeldung vom angegebenen Typ ist.- Parameters:
ixConnect- Index Server Verbindungexc- FehlermeldungexcType- Fehlertyp- Returns:
- Fehlermeldung ist vom angegebenen Typ
- Throws:
java.lang.Exception
-
getStackTrace
public static java.lang.String getStackTrace(java.lang.Exception exc) throws java.lang.ExceptionLiefert den StackTrace der angegebenen Fehlermeldung als String zurück.- Parameters:
exc- Fehlermeldung- Returns:
- Stacktrace der Fehlermeldung
- Throws:
java.lang.Exception
-
getNotificationList
public static java.util.ArrayList<de.elo.ix.client.Notification> getNotificationList(IXconnect ixConnect) throws java.lang.Exception
Liefert eine Liste mit den vorhandenen Notifications zurück.- Parameters:
ixConnect- Index Server Verbindung- Returns:
- Liste mit Notifications
- Throws:
java.lang.Exception
-
getNotificationMap
public static java.util.Map<java.lang.String,de.elo.ix.client.Notification> getNotificationMap(IXconnect ixConnect) throws java.lang.Exception
Liefert eine Map mit den vorhandenen Notifications zurück.- Parameters:
ixConnect- Index Server Verbindung- Returns:
- Map mit den Notifications
- Throws:
java.lang.Exception
-
getFeedGuid
public static java.lang.String getFeedGuid(IXconnect ixConnect, int objId) throws java.lang.Exception
Liefert das Feed GUID des angegebenen Archiveintrags zurück.- Parameters:
ixConnect- Index Server VerbindungobjId- Objekt ID des Archiveintrags- Returns:
- Feed GUID
- Throws:
java.lang.Exception
-
insertSubscription
public static de.elo.ix.client.Subscription insertSubscription(IXconnect ixConnect, java.lang.String feedGuid) throws java.lang.Exception
Erstellt ein neues Abbonament für die angegebene Feed GUID.- Parameters:
ixConnect- Index Server VerbindungfeedGuid- Feed GUID- Returns:
- Abbonament
- Throws:
java.lang.Exception
-
deleteSubscriptions
public static void deleteSubscriptions(IXconnect ixConnect, java.util.HashMap<java.lang.String,de.elo.ix.client.Subscription> subs) throws java.lang.Exception
Löscht die angegebenen Abbonaments.- Parameters:
ixConnect- Index Server Verbindungsubs- HashMap mit Abbonaments- Throws:
java.lang.Exception
-
getTextFromIxUrl
public static java.lang.String getTextFromIxUrl(IXconnect ixConnect, java.lang.String ixUrl, java.io.File targetFile) throws java.lang.Exception
Speichert den Text der Index Server URL in der angegebenen Datei und liefert den Text zurück.- Parameters:
ixConnect- Index Server VerbindungixUrl- Index Server URLtargetFile- Zieldatei, in der der Textinhalt eingefügt wird- Returns:
- Text der Index Server URL
- Throws:
java.lang.Exception
-
retrieveTicket
public static java.lang.String retrieveTicket(javax.servlet.http.HttpServletRequest request)
Liefert das Index Server Ticket aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- Index Server Ticket
-
getLanguage
public static java.lang.String getLanguage(javax.servlet.http.HttpServletRequest request) throws java.lang.ExceptionLiefert die Sprache aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- Sprache
- Throws:
java.lang.Exception
-
isIxProxy
public static boolean isIxProxy(javax.servlet.http.HttpServletRequest request) throws java.lang.ExceptionMeldet zurück, ob der Index Server Proxy aktiv ist.- Parameters:
request- ServletRequest- Returns:
- Index Server Proxy ist aktiv
- Throws:
java.lang.Exception
-
removeCookie
public static void removeCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, java.lang.String name) throws java.lang.ExceptionEntfernt das angegebene Cookie-Objekt.- Parameters:
req- ServletRequestresp- ServletResponsename- Cookie Bezeichnung- Throws:
java.lang.Exception
-
writeCookie
public static void writeCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String name, java.lang.String value, java.lang.String path, boolean secure) throws java.lang.ExceptionSpeichert das angegebene Cookie-Objekt.- Parameters:
request- ServletRequestresponse- ServletResponsename- Cookie Bezeichnungvalue- Cookie Wertpath- Pfadsecure-- Throws:
java.lang.Exception
-
getRelativePath
public static java.lang.String getRelativePath(javax.servlet.http.HttpServletRequest request) throws java.lang.ExceptionLiefert den relativen Pfad aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- relativer Pfad
- Throws:
java.lang.Exception
-
-