Package de.elo.mover.main.helper
Class RequestHelper
java.lang.Object
de.elo.mover.main.helper.RequestHelper
Überschrift: RequestHelper.
Beschreibung: Hilfsklasse für das Versenden von Requests.
Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2022
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddAttachment(IXconnect ixConnect, int objId, File sourceFile) Fügt eine Dateianbindung an das angegebene Dokument.static voidcreateFeedAction(IXconnect ixConnect, int objId, String text) Fügt den angegebenen Text im Feed ein.static com.jcraft.jsch.SessioncreateJschSession(String username, String password, String host, int port) Erzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.static longErzeugt einen neuen eigenen Ereignistyp, der außerhalb der definierten IX-Ereignistypen liegt.static TriggerInfocreateTriggerInfo(jakarta.servlet.http.HttpServletRequest request, int userId) Liefert das TriggerInfo-Objekt aus dem angegebenen HTTP-Request zurück.static voiddeleteSubscriptions(IXconnect ixConnect, HashMap<String, de.elo.ix.client.Subscription> subs) Löscht die angegebenen Abbonaments.static voiddownloadFilesFromFtp(String userName, String password, String host, int port, boolean useSsl, String ftpServerDirectory, String targetDirectory, String[] fileExtList, boolean deleteFtpFiles) Lädt die Dateien mit den angegebenen Dateiendungen von einem FTP-Server im angegeben lokalen Verzeichnis herunter.static ArrayList<de.elo.ix.client.ConfigFile> findConfigFiles(IXconnect ixConnect, String configDir, String postboxUserId, boolean inclDeputy) Liefert eine Liste mit den vorhandenen Konfigurationsdateien zurück.static FilegetAttachmentVersion(IXconnect ixConnect, int objId, File targetDir) Liefert die Arbeitsversion der Dateianbindung des angegebenen Dokuments zurück.static intgetDocIdFromUploadResult(String uploadResult) Liefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.static FilegetDocumentVersion(IXconnect ixConnect, int objId, File targetDir) Liefert die Arbeitsversion des angegebenen Dokuments zurück.static FilegetDocumentVersion(IXconnect ixConnect, int objId, File targetDir, boolean useShortName) Liefert die Arbeitsversion des angegebenen Dokuments zurück.static voidgetDocumentVersionPart(IXconnect ixConnect, int objId, 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 Eintrag zurück.static StringgetFeedGuid(IXconnect ixConnect, int objId) Liefert das Feed-GUID des angegebenen Eintrags zurück.static String[]getGuids(de.elo.ix.client.feed.Action[] actions) Liefert eine Liste mit den GUIDs der angegebenen Feed Aktionen zurück.static StringgetIxFileName(IXconnect ixConnect, String fileName, String userName, boolean intrayTransfer, boolean saveFilesOnServer) Liefert den passenden IX-Dateinamen für den angegebenen Benutzer zurück.static StringgetLanguage(jakarta.servlet.http.HttpServletRequest request) Liefert die Sprache aus dem angegebenen ServletRequest zurück.static LocalegetLocale(jakarta.servlet.http.HttpServletRequest request) Liefert das Locale-Objekt aus dem angegebenen HTTP-Request zurück.static ArrayList<de.elo.ix.client.Notification> getNotificationList(IXconnect ixConnect) Liefert eine Liste mit den vorhandenen Notifications zurück.getNotificationMap(IXconnect ixConnect) Liefert eine Map mit den vorhandenen Notifications zurück.static StringgetRelativePath(jakarta.servlet.http.HttpServletRequest request) Liefert den relativen Pfad aus dem angegebenen ServletRequest zurück.static StringgetStackTrace(Exception exc) Liefert den StackTrace der angegebenen Fehlermeldung als String zurück.static StringgetTextFromIxUrl(IXconnect ixConnect, String ixUrl, File targetFile) Speichert den Text der Indexserver-URL in der angegebenen Datei und liefert den Text zurück.static booleanhasAttachment(IXconnect ixConnect, int objId) Meldet zurück, ob der angegebene Eintrag 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 Eintrag eine Signatur hat.static de.elo.ix.client.SubscriptioninsertSubscription(IXconnect ixConnect, String feedGuid) Erstellt ein neues Abbonament für die angegebene Feed-GUID.static booleanisExceptionType(IXconnect ixConnect, Exception exc, int excType) Meldet zurück, ob die Fehlermeldung vom angegebenen Typ ist.static booleanisIxAvailable(String ixUrl) Meldet zurück, ob die angegebene Indexserver-URL erreichbar ist.static booleanisIxProxy(jakarta.servlet.http.HttpServletRequest request) Meldet zurück, ob der Indexserver-Proxy aktiv ist.static voidloadFilesFromServer(IXconnect ixConnect, File targetDir, String userName, boolean intrayTransfer) Lädt die Indexserver-Dateien für den angegebenen Benutzer herunter.static voidremoveAttachments(IXconnect ixConnect, int objId) Entfernt die Dateianbindung des angegebenen Dokuments.static voidremoveCookie(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, String name) Entfernt das angegebene Cookie-Objekt.static StringretrieveTicket(jakarta.servlet.http.HttpServletRequest request) Liefert das Indexserver-Ticket aus dem angegebenen ServletRequest zurück.static voidsaveFilesOnServer(IXconnect ixConnect, List<File> localFiles, String userName, boolean intrayTransfer) Speichert die angegebenen Postbox- oder Checkout-Dateien auf dem Index Server.static voidsaveIntrayFilesOnServer(IXconnect ixConnect, String dirPath) Speichert die Benutzer Postboxdateien aus dem angegebenen Postbox Verzeichnis in der entsprechenden Index Server Postbox.static voidsendHttpGetRequest(String url, File responseFile) Sendet eine HTTP GET-Anfrage an der angegebenen URL.static voidsendHttpGetRequestBasicAuth(String url, File responseFile, String user, String password) Sendet eine HTTP GET-Anfrage mit einer Basic Authentifizierung an der angegebenen URL.static voidsendHttpPostRequest(String url, byte[] source) Sendet eine HTTP Post-Anfrage an der angegebenen URL.static voidsendHttpPostRequest(String url, File sourceFile) Sendet eine HTTP-Post Anfrage an der angegebenen URL.static voiduploadFileToFtp(String userName, String password, String host, int port, boolean useSsl, File sourceFile, String targetFilePath) Lädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.static voidwriteCookie(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String name, String value, String path, boolean secure) Speichert das angegebene Cookie-Objekt.
-
Constructor Details
-
RequestHelper
public RequestHelper()
-
-
Method Details
-
sendHttpGetRequest
Sendet eine HTTP GET-Anfrage an der angegebenen URL.- Parameters:
url- URL, an die die Anfrage gesendet wirdresponseFile- Datei mit dem HTTP-Ergebnis- Throws:
IOExceptionException
-
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 wirdresponseFile- Datei mit dem HTTP-Ergebnisuser- Benutzerpassword- Passwort- Throws:
Exception
-
sendHttpPostRequest
Sendet 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:
Exception
-
sendHttpPostRequest
Sendet 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:
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-VerbindungobjId- Id des DokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wird- Returns:
- Arbeitsversion des Dokuments
- Throws:
Exception
-
getDocumentVersion
public static File getDocumentVersion(IXconnect ixConnect, int objId, File targetDir, boolean useShortName) throws Exception Liefert die Arbeitsversion des angegebenen Dokuments zurück.- Parameters:
ixConnect- Indexserver-VerbindungobjId- Id des DokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wirduseShortName- Kurzbezeichnung als Dateinamen verwenden- Returns:
- Arbeitsversion des Dokuments
- 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-VerbindungobjId- Id des DokumentstargetDir- Verzeichnis, in dem die Arbeitsversion heruntergelanden wird- Returns:
- Arbeitsversion der Dateianbindung
- Throws:
Exception
-
removeAttachments
Entfernt die Dateianbindung des angegebenen Dokuments.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Dokuments- Throws:
Exception
-
addAttachment
Fügt eine Dateianbindung an das angegebene Dokument.- Parameters:
ixConnect- Indexserver-VerbindungobjId- Id des Dokuments, zu dem die Dateianbindung eingefügt wirdsourceFile- Dateianbindung- Throws:
Exception
-
hasAttachment
Meldet zurück, ob der angegebene Eintrag eine Dateianbindung enthält.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Eintrags- Returns:
- Eintrag enthält eine Dateianbindung
- Throws:
Exception
-
hasSignature
Meldet zurück, ob der angegebene Eintrag eine Signatur hat.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Eintrags- Returns:
- Eintrag hat eine Signatur
- Throws:
Exception
-
hasFulltext
Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Eintrags- Returns:
- Eintrag hat einen Volltextinhalt
- Throws:
Exception
-
getDocIdFromUploadResult
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- Benutzernamepassword- Passworthost- Hostport- PortuseSsl- SSL-Verschlüsselung verwendenftpServerDirectory- Pfad auf dem FTP-ServertargetDirectory- ZielverzeichnisfileExtList- Liste mit DateiendungendeleteFtpFiles- 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- Benutzernamepassword- Benutzerpassworthost- Hostport- PortuseSsl- SSL-Verschlüsselung verwendensourceFile- QuelldateitargetFilePath- 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- Benutzernamepassword- Benutzerpassworthost- Hostnameport- Port für die Verbindung- Returns:
- JSCH-Session
- Throws:
com.jcraft.jsch.JSchExceptionException
-
createMyEventType
public static long createMyEventType()Erzeugt einen neuen eigenen Ereignistyp, der außerhalb der definierten IX-Ereignistypen liegt.- Returns:
- eigener Ereignistyp
-
createFeedAction
Fügt den angegebenen Text im Feed ein.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Eintragstext- Text- Throws:
Exception
-
getGuids
Liefert eine Liste mit den GUIDs der angegebenen Feed Aktionen zurück.- Parameters:
actions- Liste mit Feed Aktionen- Returns:
- Liste mit GUIDs
- Throws:
Exception
-
getFeedActions
public static de.elo.ix.client.feed.Action[] getFeedActions(IXconnect ixConnect, int objId) throws Exception Liefert eine Liste mit den Feed Aktionen zum angegebenen Eintrag zurück.- Parameters:
ixConnect- Indexserver-VerbindungobjId- ID des Eintrags- Returns:
- Liste mit Feed-Aktionen
- 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-VerbindungobjId- ID des DokumentstargetFile- Zieldateioffset- Versatzlength- Länge der zu lesenden Daten- Throws:
Exception
-
saveFilesOnServer
public static void saveFilesOnServer(IXconnect ixConnect, List<File> localFiles, String userName, boolean intrayTransfer) throws Exception Speichert die angegebenen Postbox- oder Checkout-Dateien auf dem Index Server.- Parameters:
ixConnect- Indexserver-VerbindunglocalFiles- Liste mit lokalen DateienuserName- BenutzernameintrayTransfer- Postbox- oder Checkout Dateien speichern- Throws:
Exception
-
saveIntrayFilesOnServer
Speichert die Benutzer Postboxdateien aus dem angegebenen Postbox Verzeichnis in der entsprechenden Index Server Postbox.- Parameters:
ixConnect- Indexserver-VerbindungdirPath- Verzeichnis mit Postboxdateien für die einzelnen Benutzer- Throws:
Exception
-
loadFilesFromServer
public static void loadFilesFromServer(IXconnect ixConnect, File targetDir, String userName, boolean intrayTransfer) throws Exception Lädt die Indexserver-Dateien für den angegebenen Benutzer herunter.- Parameters:
ixConnect- Indexserver-VerbindungtargetDir- Verzeichnis, in dem die Dateien heruntergeladen werdenuserName- BenutzernameintrayTransfer- Postbox-Dateien herunterladen- Throws:
Exception
-
getIxFileName
public static String getIxFileName(IXconnect ixConnect, String fileName, String userName, boolean intrayTransfer, boolean saveFilesOnServer) throws Exception Liefert den passenden IX-Dateinamen für den angegebenen Benutzer zurück.- Parameters:
ixConnect- Indexserver-VerbindungfileName- Name der Datei ohne den DateipfaduserName- BenutzerintrayTransfer- Postboxdatei oder ausgechecktes DokumentsaveFilesOnServer- Lokale Dateien auf dem Server auslagern- Returns:
- Index Server Dateiname
- Throws:
Exception
-
findConfigFiles
public static ArrayList<de.elo.ix.client.ConfigFile> findConfigFiles(IXconnect ixConnect, String configDir, String postboxUserId, boolean inclDeputy) throws Exception Liefert eine Liste mit den vorhandenen Konfigurationsdateien zurück.- Parameters:
ixConnect- Indexserver-VerbindungconfigDir- Verzeichnis für die KonfigurationsdateienpostboxUserId- ID des Postbox BenutzersinclDeputy- inklusive Vertretungen- Returns:
- Liste mit Konfigurationsdateien
- Throws:
Exception
-
isIxAvailable
Meldet zurück, ob die angegebene Indexserver-URL erreichbar ist.- Parameters:
ixUrl- Indexserver-URL- Returns:
- URL ist erreichbar
- Throws:
Exception
-
createTriggerInfo
public static TriggerInfo createTriggerInfo(jakarta.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
Liefert das Locale-Objekt aus dem angegebenen HTTP-Request zurück.- Parameters:
request- HttpServletRequest- Returns:
- Locale-Objekt
- Throws:
Exception
-
isExceptionType
public static boolean isExceptionType(IXconnect ixConnect, Exception exc, int excType) throws Exception Meldet zurück, ob die Fehlermeldung vom angegebenen Typ ist.- Parameters:
ixConnect- Indexserver-Verbindungexc- FehlermeldungexcType- Fehlertyp- Returns:
- Fehlermeldung ist vom angegebenen Typ
- Throws:
Exception
-
getStackTrace
Liefert den StackTrace der angegebenen Fehlermeldung als String zurück.- Parameters:
exc- Fehlermeldung- Returns:
- Stacktrace der Fehlermeldung
- Throws:
Exception
-
getNotificationList
public static ArrayList<de.elo.ix.client.Notification> getNotificationList(IXconnect ixConnect) throws Exception Liefert eine Liste mit den vorhandenen Notifications zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Liste mit Notifications
- Throws:
Exception
-
getNotificationMap
public static Map<String,de.elo.ix.client.Notification> getNotificationMap(IXconnect ixConnect) throws Exception Liefert eine Map mit den vorhandenen Notifications zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Map mit den Notifications
- Throws:
Exception
-
getFeedGuid
Liefert das Feed-GUID des angegebenen Eintrags zurück.- Parameters:
ixConnect- Indexserver-VerbindungobjId- Objekt ID des Eintrags- Returns:
- Feed-GUID
- Throws:
Exception
-
insertSubscription
public static de.elo.ix.client.Subscription insertSubscription(IXconnect ixConnect, String feedGuid) throws Exception Erstellt ein neues Abbonament für die angegebene Feed-GUID.- Parameters:
ixConnect- Indexserver-VerbindungfeedGuid- Feed-GUID- Returns:
- Abbonament
- Throws:
Exception
-
deleteSubscriptions
public static void deleteSubscriptions(IXconnect ixConnect, HashMap<String, de.elo.ix.client.Subscription> subs) throws ExceptionLöscht die angegebenen Abbonaments.- Parameters:
ixConnect- Indexserver-Verbindungsubs- HashMap mit Abbonaments- Throws:
Exception
-
getTextFromIxUrl
public static String getTextFromIxUrl(IXconnect ixConnect, String ixUrl, File targetFile) throws Exception Speichert den Text der Indexserver-URL in der angegebenen Datei und liefert den Text zurück.- Parameters:
ixConnect- Indexserver-VerbindungixUrl- Index Server URLtargetFile- Zieldatei, in der der Textinhalt eingefügt wird- Returns:
- Text der Indexserver-URL
- Throws:
Exception
-
retrieveTicket
Liefert das Indexserver-Ticket aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- Indexserver-Ticket
-
getLanguage
Liefert die Sprache aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- Sprache
- Throws:
Exception
-
isIxProxy
Meldet zurück, ob der Indexserver-Proxy aktiv ist.- Parameters:
request- ServletRequest- Returns:
- Indexserver-Proxy ist aktiv
- Throws:
Exception
-
removeCookie
public static void removeCookie(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, String name) throws Exception Entfernt das angegebene Cookie-Objekt.- Parameters:
req- ServletRequestresp- ServletResponsename- Cookie Bezeichnung- Throws:
Exception
-
writeCookie
public static void writeCookie(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String name, String value, String path, boolean secure) throws Exception Speichert das angegebene Cookie-Objekt.- Parameters:
request- ServletRequestresponse- ServletResponsename- Cookie Bezeichnungvalue- Cookie Wertpath- Pfadsecure-- Throws:
Exception
-
getRelativePath
public static String getRelativePath(jakarta.servlet.http.HttpServletRequest request) throws Exception Liefert den relativen Pfad aus dem angegebenen ServletRequest zurück.- Parameters:
request- ServletRequest- Returns:
- relativer Pfad
- Throws:
Exception
-