Package de.elo.mover.utils
Class ELOAsServerUtils
java.lang.Object
de.elo.mover.utils.ELOAsServerUtils
Überschrift: ELOAsServerUtils.
Beschreibung: Hilfsklasse für die Server-Funktionalität.
Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2022
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidcreateFeedAction(IXconnect ixConnect, int objId, String text) Fügt den angegebenen Text im Feed ein.static longErzeugt einen neuen eigenen Ereignistyp, der außerhalb der definierten IX-Ereignistypen liegt.static voiddeleteSubscriptions(IXconnect ixConnect, HashMap<String, de.elo.ix.client.Subscription> subs) Löscht die angegebenen Abbonaments.static NamingEnumeration<SearchResult> execLdapQuery(IXconnect ixConnect, String ldapUrl, String baseDN, String ldapQuery, boolean ignoreSSLValidation) Führt die angegebene LDAP-Anfrage aus und liefert das Ergebnis zurück.static NamingEnumeration<SearchResult> execLdapQuery(IXconnect ixConnect, String ldapUrl, String baseDN, String userName, String password, String ldapQuery, boolean ignoreSSLValidation) Führt die angegebene LDAP-Abfrage aus und liefert das Ergebnis zurück.static List<SearchResult> execLdapQuery2(IXconnect ixConnect, String ldapUrl, String baseDN, String userName, String password, String ldapQuery, boolean ignoreSSLValidation) Führt die angegebene LDAP-Abfrage aus und liefert das Ergebnis zurück.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 StringLiefert die Access Manager URL aus der angegebenen Indexserver-Verbindung zurück.static StringLiefert die Access Manager URL aus der angegebenen Indexserver-Verbindung zurück.static PropertiesgetDMOptions(IXconnect ixConnect) Liefert die Document Manager Optionen zurück.static StringLiefert die Dokument Manager URL aus der angegebenen Indexserver- Verbindung zurück.static StringDeprecated.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 intgetFreeReplSetId(IXconnect ixConnect) Liefert die erste freie ID eines Replikationskreises zurück.static PropertiesgetFTOptions(IXconnect ixConnect) Liefert die Volltext-Optionen 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 StringLiefert die iSearch URL aus der angegebenen Indexserver-Verbindung 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 PropertiesgetIXOptions(IXconnect ixConnect) Liefert die Indexserver-Optionen zurück.static StringLiefert die Indexserver-URL aus der angegebenen Indexserver-Verbindung zurück.static StringgetIXVersion(IXconnect ixConnect) Liefert die Indexserver-Version 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 StringgetNameFromDn(String dn) Liefert den Gruppennamen aus dem angegebenen DN 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 int[]getReplSetIds(de.elo.ix.client.ReplSetName[] replSetNames) Liefert eine Liste mit den IDs der angegebenen Replikationskreise zurück.static String[]getReplSetNames(de.elo.ix.client.ReplSetName[] replSets) Liefert eine Liste mit den Namen der angegebenen Replikationskreise zurück.static ArrayList<de.elo.ix.client.ReplSetName> getReplSets(IXconnect ixConnect) Liefert eine Liste mit den vorhandenen Replikationskreisen 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 StringgetValidIxName(String ixName) Liefert einen gültigen Indexserver-Namen aus dem angegebenen Namen zurück.static de.elo.ix.client.SubscriptioninsertSubscription(IXconnect ixConnect, String feedGuid) Erstellt ein neues Abbonament für die angegebene Feed GUID.static booleanis64bit()Prüft, ob das Betriebssystem 64-bit ist.static booleanMeldet zurück, ob eine 64-bit JRE verwendet wird.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 booleanisLinux()Prüft, ob das aktuelle Betriebssystem ein Linux ist.static booleanisMacOSX()Prüft, ob das aktuelle Betriebssystem ein Apple Mac OS X ist.static booleanPrüft, ob das aktuelle Betriebssystem ein MS Windows ist.static booleanPrüft, ob das aktuelle Betriebssystem MS Windows 7 ist.static booleanPrüft, ob das aktuelle Betriebssystem Windows Server ist.static booleanPrüft, ob das aktuelle Betriebssystem MS Windows Vista ist.static voidloadFilesFromServer(IXconnect ixConnect, File targetDir, String userName, boolean intrayTransfer) Lädt die Indexserver-Dateien für den angegebenen Benutzer herunter.static voidremoveCookie(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, String name) Entfernt das angegebene "Cookie"-Objekt.static booleanreplSetExists(IXconnect ixConnect, int id) Meldet zurück, ob der Replikationskreis mit der angegebenen ID existiert.static booleanreplSetNameExists(IXconnect ixConnect, String replSetName) Meldet zurück, ob der angegebene Replikationskreis existiert.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 Indexserver Postbox.static voidsaveReplSet(IXconnect ixConnect, int id, String name, String descr, boolean mobile) Speichert den angegebenen Replikationskreis.static voidsaveReplSets(IXconnect ixConnect, de.elo.ix.client.ReplSetName[] replSets) Speichert die angegebenen Replikationskreise auf dem Indexserver.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
-
ELOAsServerUtils
public ELOAsServerUtils()
-
-
Method Details
-
getAMUrl
Liefert die Access Manager URL aus der angegebenen Indexserver-Verbindung zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Access Manager URL
- Throws:
Exception
-
getAMUrl2
Liefert die Access Manager URL aus der angegebenen Indexserver-Verbindung zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Access Manager URL
- Throws:
Exception
-
getDMUrl
Liefert die Dokument Manager URL aus der angegebenen Indexserver- Verbindung zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Dokument Manager URL
- Throws:
Exception
-
getDMUrl2
Deprecated.Liefert die DM-URL aus der angegebenen Indexserver-Verbindung zurück.- Parameters:
ixConnect- Indexserver-VerbindungrepositoryName- Bezeichnung des Repository- Returns:
- Document Manager URL
- Throws:
Exception
-
getIXVersion
Liefert die Indexserver-Version zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Indexserver-Version
- Throws:
Exception
-
getIXUrl
Liefert die Indexserver-URL aus der angegebenen Indexserver-Verbindung zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Indexserver-URL
- Throws:
Exception
-
getValidIxName
Liefert einen gültigen Indexserver-Namen aus dem angegebenen Namen zurück. Unzulässige Zeichen werden durch das Zeichen "_" ersetzt.- Parameters:
ixName- Indexserver-Name- Returns:
- Gültigen Indexserver-Namen
- Throws:
Exception
-
getISUrl
Liefert die iSearch URL aus der angegebenen Indexserver-Verbindung zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- iSearch URL
- Throws:
Exception
-
getDMOptions
Liefert die Document Manager Optionen zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Document Manager Optionen
- Throws:
Exception
-
getIXOptions
Liefert die Indexserver-Optionen zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Indexserver-Optionen
- Throws:
Exception
-
getFTOptions
Liefert die Volltext-Optionen zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Volltext-Optionen
- Throws:
Exception
-
execLdapQuery
public static NamingEnumeration<SearchResult> execLdapQuery(IXconnect ixConnect, String ldapUrl, String baseDN, String userName, String password, String ldapQuery, boolean ignoreSSLValidation) throws Exception Führt die angegebene LDAP-Abfrage aus und liefert das Ergebnis zurück.- Parameters:
ixConnect- Indexserver-VerbindungldapUrl- LDAP-URLbaseDN- Basis DNuserName- Benutzernamepassword- BenutzerpasswortldapQuery- LDAP-AbfrageignoreSSLValidation- SSLValidierung ignorieren- Returns:
- Ergebnis der Abfrage
- Throws:
Exception
-
execLdapQuery
public static NamingEnumeration<SearchResult> execLdapQuery(IXconnect ixConnect, String ldapUrl, String baseDN, String ldapQuery, boolean ignoreSSLValidation) throws Exception Führt die angegebene LDAP-Anfrage aus und liefert das Ergebnis zurück. Der Benutzername und das Passwort werden aus der "config.xml"-Datei ausgelesen.- Parameters:
ixConnect- Indexserver-VerbindungldapUrl- LDAP-URLbaseDN- Basis-DNldapQuery- LDAP-AbfrageignoreSSLValidation- SSL-Validierung ignorieren- Returns:
- Ergebnis der Abfrage
- Throws:
Exception
-
execLdapQuery2
public static List<SearchResult> execLdapQuery2(IXconnect ixConnect, String ldapUrl, String baseDN, String userName, String password, String ldapQuery, boolean ignoreSSLValidation) throws Exception Führt die angegebene LDAP-Abfrage aus und liefert das Ergebnis zurück.- Parameters:
ixConnect- Indexserver-VerbindungldapUrl- LDAP-URLbaseDN- Basis DNuserName- Benutzernamepassword- BenutzerpasswortldapQuery- LDAP-AbfrageignoreSSLValidation- SSL-Validierung ignorieren- Returns:
- Liste mit den Suchergebnissen
- Throws:
Exception
-
getNameFromDn
Liefert den Gruppennamen aus dem angegebenen DN zurück. Z.B. für die Eingabe "cn=Test Group,o=Sun,c=US" wird der Wert "Test Group" zurückgeliefert. Wenn ein Gleichheitszeichen im Gruppennamen vorkommt wird ein Leerstring zurückgeliefert.- Parameters:
dn- DN mit zwei oder mehr Zeichen. Ein Komma ist im Gruppennamen erlaubt, z.B. "cn=Group,Test,o=Sun,c=US"- Returns:
- Gruppenname oder Leerstring, falls nicht gefunden wurde
- Throws:
Exception
-
saveReplSet
public static void saveReplSet(IXconnect ixConnect, int id, String name, String descr, boolean mobile) throws Exception Speichert den angegebenen Replikationskreis.- Parameters:
ixConnect- Indexserver-Verbindungid- ID des Replikationskreisesname- Name des Replikationskreisesdescr- Beschreibung des Replikationskreisesmobile- Mobiler Replikationskreis- Throws:
Exception
-
saveReplSets
public static void saveReplSets(IXconnect ixConnect, de.elo.ix.client.ReplSetName[] replSets) throws Exception Speichert die angegebenen Replikationskreise auf dem Indexserver.- Parameters:
ixConnect- Indexserver VerbindungreplSets- Liste mit Replikationskreisen- Throws:
Exception
-
getReplSets
public static ArrayList<de.elo.ix.client.ReplSetName> getReplSets(IXconnect ixConnect) throws Exception Liefert eine Liste mit den vorhandenen Replikationskreisen zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- Liste mit Replikationskreisen
- Throws:
Exception
-
replSetExists
Meldet zurück, ob der Replikationskreis mit der angegebenen ID existiert.- Parameters:
ixConnect- Indexserver-Verbindungid- ID des Replikationskreises- Returns:
- Replikationskreis ist vorhanden
- Throws:
Exception
-
replSetNameExists
Meldet zurück, ob der angegebene Replikationskreis existiert.- Parameters:
ixConnect- Indexserver-VerbindungreplSetName- Name des Replikationskreises- Returns:
- Replikationskreis ist vorhanden
- Throws:
Exception
-
getReplSetIds
Liefert eine Liste mit den IDs der angegebenen Replikationskreise zurück.- Parameters:
replSetNames- Liste mit Replikationskreisen- Returns:
- Liste mit den IDs der Replikationskreise
- Throws:
Exception
-
getReplSetNames
Liefert eine Liste mit den Namen der angegebenen Replikationskreise zurück.- Parameters:
replSets- Liste mit Replikationskreisen- Returns:
- Liste mit den Namen der Replikationskreisen
- Throws:
Exception
-
getFreeReplSetId
Liefert die erste freie ID eines Replikationskreises zurück.- Parameters:
ixConnect- Indexserver-Verbindung- Returns:
- erste freie ID eines Replikationskreises
- Throws:
Exception
-
isWindows
public static boolean isWindows()Prüft, ob das aktuelle Betriebssystem ein MS Windows ist.- Returns:
- Betriebssystem ist Windows
-
isWindows7
public static boolean isWindows7()Prüft, ob das aktuelle Betriebssystem MS Windows 7 ist.- Returns:
- Windows 7 Betriebssystem
-
isWindowsVista
public static boolean isWindowsVista()Prüft, ob das aktuelle Betriebssystem MS Windows Vista ist.- Returns:
- Windows Vista Betriebssystem
-
isWindowsServer
public static boolean isWindowsServer()Prüft, ob das aktuelle Betriebssystem Windows Server ist.- Returns:
- Windows Server Betriebssystem
-
isMacOSX
public static boolean isMacOSX()Prüft, ob das aktuelle Betriebssystem ein Apple Mac OS X ist.- Returns:
- Betriebssystem is Mac OS
-
isLinux
public static boolean isLinux()Prüft, ob das aktuelle Betriebssystem ein Linux ist.- Returns:
- Betriebssystem ist Linux
-
is64bit
public static boolean is64bit()Prüft, ob das Betriebssystem 64-bit ist.- Returns:
- 64-bit Betriebssystem
-
is64BitJava
public static boolean is64BitJava()Meldet zurück, ob eine 64-bit JRE verwendet wird.- Returns:
- 64-bit JRE verwenden
-
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
-
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 Indexserver Postbox.- Parameters:
ixConnect- Indexserver-VerbindungdirPath- Verzeichnis mit Postboxdateien für die einzelnen Benutzer- 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:
- Indexserver-Dateiname
- 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
-
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
-
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- Indexserver-URLtargetFile- Zieldatei, in der der Textinhalt eingefügt wird- Returns:
- Text der Indexserver-URL
- Throws:
Exception
-
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
-