Package de.elo.mover.utils

Class ELOAsUserUtils

java.lang.Object
de.elo.mover.utils.ELOAsUserUtils
public class ELOAsUserUtils
extends java.lang.Object

Überschrift: ELOAsUserUtils.

Beschreibung: Hilfsklasse für die ELO Benutzer und Gruppen.

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

  • Constructor Summary

    Constructors 
    Constructor Description
    ELOAsUserUtils()  

  • Method Summary

    Modifier and Type Method Description
    static void addUsersToGroup​(IXconnect ixConnect, int groupId, java.lang.String[] userNames)
    Fügt die Benutzer in die angegebene Gruppe ein.
    static de.elo.ix.client.UserInfo[] castToUserInfos​(java.lang.Object[] objects)
    Die Methode konvertiert ein Array von Objekten in ein Array von "UserInfo"-Objekten.
    static void dumpUserNames​(IXconnect ixConnect)
    Gibt die vorhandenen Benutzer und Gruppen in der ELOas-Logdatei aus.
    static java.lang.String[] getGuids​(de.elo.ix.client.UserInfo[] userInfos)
    Liefert die GUIDs der angegebenen "UserInfo"-Objekte zurück.
    static java.util.List<java.lang.Integer> getIds​(java.util.List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
    static int[] getIDs​(de.elo.ix.client.UserInfo[] userInfos)
    Die Methode liefert die IDs der angegebenen "UserInfo"-Objekte.
    static java.util.List<java.lang.String> getIdsAsString​(java.util.List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
    static java.util.List<java.lang.Integer> getIdsSorted​(java.util.List<de.elo.ix.client.UserName> userNames)
    Die Methode liefert die IDs der angegebenen "UserName"-Objekte.
    static java.lang.String[] getNames​(de.elo.ix.client.UserInfo[] userInfos)
    Die Methode liefert die Namen der angegebene "UserInfo"-Objekte zurück.
    static java.util.List<java.lang.String> getNames​(java.util.List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den Bezeichnungen der angegebenen "UserName"-Objekte zurück.
    static java.lang.String[] getStringArray​(int[] userIds)
    Liefert eine Liste mit den Benutzer-IDs als Strings zurück.
    static de.elo.ix.client.UserInfo[] getSubset​(de.elo.ix.client.UserInfo[] set, int type)
    Die Methode liefert eine Untermenge von "UserInfo"-Objekten mit dem angegebenen Typ.
    static int getUserIdFromName​(IXconnect ixConnect, java.lang.String userName)
    Liefert die Benutzer-ID des angegebenen Benutzernamens zurück.
    static de.elo.ix.client.UserName getUserName​(IXconnect ixConnect, java.lang.String userName)
    Liefert das "UserName"-Objekt für den angegebenen Benutzer zurück.
    static java.lang.String getUserNameByEmail​(IXconnect ixConnect, java.lang.String emailAddress)
    Liefert den Benutzernamen für die angegebene E-Mail Adresse zurück.
    static java.lang.String getUserNameFromId​(IXconnect ixConnect, int userId)
    Liefert den Benutzernamen der angegebenen Benutzer-ID zurück.
    static java.lang.String getUserOption​(IXconnect ixConnect, int userId, java.lang.String optionKey)
    Liefert den Wert der angegebenen Benutzer-Option zurück.
    static de.elo.ix.client.UserName[] getUsers​(IXconnect ixConnect, boolean inclGroups)
    Liefert eine Liste mit den vorhandenen Benutzern zurück.
    static de.elo.ix.client.UserInfo[] getUsersForParentId​(int parentId, de.elo.ix.client.UserInfo[] users)
    Liefert eine Liste mit den "UserInfo"-Objekten für den angegebenen Parent zurück.
    static boolean isMemberOf​(IXconnect ixConnect, java.lang.String userId, java.lang.String groupIdOrName)
    Meldet zurück, ob der angegebene Benutzer ein Mitglied der Gruppe ist.
    static de.elo.ix.client.UserInfo[] join​(de.elo.ix.client.UserInfo[] firstList, de.elo.ix.client.UserInfo[] secList)
    Die Methode erstellt aus zwei "UserInfo"-Arrays ein neues Array.
    static de.elo.ix.client.UserName[] join​(de.elo.ix.client.UserName[] firstUserNames, de.elo.ix.client.UserName[] secUserNames)
    Die Methode erstellt aus den angegebenen Listen eine neue Liste.
    static void removeUserFromGroup​(IXconnect ixConnect, int userId, int groupId)
    Entfernt den Benutzer aus der angegebenen Gruppe.
    static void setForceChangePassword​(IXconnect ixConnect, int[] userIds)
    Erzwingt das Ändern des Anmeldepassworts für die angegebenen Benutzer.
    static void setPasswordDuration​(IXconnect ixConnect, int[] userIds, int passwordDurationDays)
    Setzt die Anzahl der Tage, für die das Benutzerpasswort gültig sein wird.
    static void setShouldChangePassword​(IXconnect ixConnect, int[] userIds)
    Setzt die Eigenschaft für eine freiwillige Passwortänderung für die angegebenen Benutzer.
    static void setSubstitution​(IXconnect ixConnect, java.lang.String activeUserName, java.lang.String[] userNames, boolean inheritRights)
    Setzt die angegebenen Benutzer als Vertreter.
    static de.elo.ix.client.UserName[] sortUserNames​(de.elo.ix.client.UserName[] unsortedUserNames)
    Die Methode liefert eine Liste mit den sortierten "UserName"-Objekten zurück.
    static boolean userIdExists​(IXconnect ixConnect, int userId)
    Meldet zurück, ob die angegebene Benutzer-ID existiert.
    static boolean userNameExists​(IXconnect ixConnect, java.lang.String userName)
    Meldet zurück, ob der angegebene Benutzer existiert.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getNames

      public static java.util.List<java.lang.String> getNames​(java.util.List<de.elo.ix.client.UserName> userNames) throws java.lang.Exception
      Liefert eine Liste mit den Bezeichnungen der angegebenen "UserName"-Objekte zurück.
      Parameters:
      userNames - Liste mit "UserName"-Objekten
      Returns:
      Liste mit den Bezeichnungen
      Throws:
      java.lang.Exception

    • getIds

      public static java.util.List<java.lang.Integer> getIds​(java.util.List<de.elo.ix.client.UserName> userNames) throws java.lang.Exception
      Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
      Parameters:
      userNames - Liste mit "UserName"-Objekten
      Returns:
      Liste mit den Bezeichnungen
      Throws:
      java.lang.Exception

    • getIdsSorted

      public static java.util.List<java.lang.Integer> getIdsSorted​(java.util.List<de.elo.ix.client.UserName> userNames) throws java.lang.Exception
      Die Methode liefert die IDs der angegebenen "UserName"-Objekte. Die IDs sind sortiert.
      Parameters:
      userNames - Objekte, deren IDs benötigt werden
      Returns:
      IDs der angegebenen "UserName"-Objekte
      Throws:
      java.lang.Exception

    • getIdsAsString

      public static java.util.List<java.lang.String> getIdsAsString​(java.util.List<de.elo.ix.client.UserName> userNames) throws java.lang.Exception
      Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
      Parameters:
      userNames - Liste mit "UserName"-Objekten
      Returns:
      Liste mit den Bezeichnungen
      Throws:
      java.lang.Exception

    • userNameExists

      public static boolean userNameExists​(IXconnect ixConnect, java.lang.String userName) throws java.lang.Exception
      Meldet zurück, ob der angegebene Benutzer existiert.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userName - Benutzername
      Returns:
      Benutzer existiert
      Throws:
      java.lang.Exception

    • userIdExists

      public static boolean userIdExists​(IXconnect ixConnect, int userId) throws java.lang.Exception
      Meldet zurück, ob die angegebene Benutzer-ID existiert.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      Returns:
      Benutzer-ID exisitiert
      Throws:
      java.lang.Exception

    • sortUserNames

      public static de.elo.ix.client.UserName[] sortUserNames​(de.elo.ix.client.UserName[] unsortedUserNames) throws java.lang.Exception
      Die Methode liefert eine Liste mit den sortierten "UserName"-Objekten zurück.
      Parameters:
      unsortedUserNames - Unsortiertes Array von "UserName"-Objekten
      Returns:
      Sortiertes Array von "UserName"-Objekten
      Throws:
      java.lang.Exception

    • join

      public static de.elo.ix.client.UserName[] join​(de.elo.ix.client.UserName[] firstUserNames, de.elo.ix.client.UserName[] secUserNames) throws java.lang.Exception
      Die Methode erstellt aus den angegebenen Listen eine neue Liste. Duplikate werden dabei eliminiert.
      Parameters:
      firstUserNames - Das erste Array
      secUserNames - Das zweite Array
      Returns:
      Liste mit allen Einträgen
      Throws:
      java.lang.Exception

    • getUserName

      public static de.elo.ix.client.UserName getUserName​(IXconnect ixConnect, java.lang.String userName) throws java.lang.Exception
      Liefert das "UserName"-Objekt für den angegebenen Benutzer zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userName - Benutzername oder Benutzer-ID
      Returns:
      "UserName"-Objekt
      Throws:
      java.lang.Exception

    • getUserNameFromId

      public static java.lang.String getUserNameFromId​(IXconnect ixConnect, int userId) throws java.lang.Exception
      Liefert den Benutzernamen der angegebenen Benutzer-ID zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      Returns:
      Benutzername
      Throws:
      java.lang.Exception

    • getUserIdFromName

      public static int getUserIdFromName​(IXconnect ixConnect, java.lang.String userName) throws java.lang.Exception
      Liefert die Benutzer-ID des angegebenen Benutzernamens zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userName - Benutzername
      Returns:
      Benutzer-ID
      Throws:
      java.lang.Exception

    • getUsers

      public static de.elo.ix.client.UserName[] getUsers​(IXconnect ixConnect, boolean inclGroups) throws java.lang.Exception
      Liefert eine Liste mit den vorhandenen Benutzern zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      inclGroups - Inklusive Gruppen
      Returns:
      Liste mit den Benutzern
      Throws:
      java.lang.Exception

    • getUserNameByEmail

      public static java.lang.String getUserNameByEmail​(IXconnect ixConnect, java.lang.String emailAddress) throws java.lang.Exception
      Liefert den Benutzernamen für die angegebene E-Mail Adresse zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      emailAddress - E-Mail Adresse des Benutzers
      Returns:
      Benutzername
      Throws:
      java.lang.Exception

    • setSubstitution

      public static void setSubstitution​(IXconnect ixConnect, java.lang.String activeUserName, java.lang.String[] userNames, boolean inheritRights) throws java.lang.Exception
      Setzt die angegebenen Benutzer als Vertreter.
      Parameters:
      ixConnect - Indexserver-Verbindung
      activeUserName - Benutzer, für den die Vertretter gesetzt werden
      userNames - Liste mit Benutzernamen
      inheritRights - Mit Berechtigungsübernahme
      Throws:
      java.lang.Exception

    • setForceChangePassword

      public static void setForceChangePassword​(IXconnect ixConnect, int[] userIds) throws java.lang.Exception
      Erzwingt das Ändern des Anmeldepassworts für die angegebenen Benutzer.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userIds - Liste mit Benutzern
      Throws:
      java.lang.Exception

    • setShouldChangePassword

      public static void setShouldChangePassword​(IXconnect ixConnect, int[] userIds) throws java.lang.Exception
      Setzt die Eigenschaft für eine freiwillige Passwortänderung für die angegebenen Benutzer.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userIds - Liste mit Benutzern
      Throws:
      java.lang.Exception

    • setPasswordDuration

      public static void setPasswordDuration​(IXconnect ixConnect, int[] userIds, int passwordDurationDays) throws java.lang.Exception
      Setzt die Anzahl der Tage, für die das Benutzerpasswort gültig sein wird.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userIds - Liste mit Benutzer-IDs
      passwordDurationDays - Tage für die Passwortgültigkeit
      Throws:
      java.lang.Exception

    • getStringArray

      public static java.lang.String[] getStringArray​(int[] userIds) throws java.lang.Exception
      Liefert eine Liste mit den Benutzer-IDs als Strings zurück.
      Parameters:
      userIds - Liste mit Benutzer-IDs
      Returns:
      Liste mit den Benutzer-IDs als Strings
      Throws:
      java.lang.Exception

    • addUsersToGroup

      public static void addUsersToGroup​(IXconnect ixConnect, int groupId, java.lang.String[] userNames) throws java.lang.Exception
      Fügt die Benutzer in die angegebene Gruppe ein.
      Parameters:
      ixConnect - Indexserver-Verbindung
      groupId - ID der Gruppe
      userNames - Liste mit Benutzernamen
      Throws:
      java.lang.Exception

    • removeUserFromGroup

      public static void removeUserFromGroup​(IXconnect ixConnect, int userId, int groupId) throws java.lang.Exception
      Entfernt den Benutzer aus der angegebenen Gruppe.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      groupId - Gruppe-ID
      Throws:
      java.lang.Exception

    • isMemberOf

      public static boolean isMemberOf​(IXconnect ixConnect, java.lang.String userId, java.lang.String groupIdOrName) throws java.lang.Exception
      Meldet zurück, ob der angegebene Benutzer ein Mitglied der Gruppe ist.
      Parameters:
      ixConnect - Indexserver-Verbidung
      userId - Benutzer-ID
      groupIdOrName - Gruppenname
      Returns:
      Benutzer ist Mitglied der Gruppe
      Throws:
      java.lang.Exception

    • castToUserInfos

      public static de.elo.ix.client.UserInfo[] castToUserInfos​(java.lang.Object[] objects) throws java.lang.Exception
      Die Methode konvertiert ein Array von Objekten in ein Array von "UserInfo"-Objekten.
      Parameters:
      objects - Objekte, die konvertiert werden sollen
      Returns:
      Extrahierte "UserInfo"-Objekte
      Throws:
      java.lang.Exception

    • getSubset

      public static de.elo.ix.client.UserInfo[] getSubset​(de.elo.ix.client.UserInfo[] set, int type) throws java.lang.Exception
      Die Methode liefert eine Untermenge von "UserInfo"-Objekten mit dem angegebenen Typ.
      Parameters:
      set - Menge von Benutzern, von der eine Untermenge berechnet wird
      type - int Auswahlkriterium
      Returns:
      Untermenge mit dem Auswahlkriterium
      Throws:
      java.lang.Exception

    • getIDs

      public static int[] getIDs​(de.elo.ix.client.UserInfo[] userInfos) throws java.lang.Exception
      Die Methode liefert die IDs der angegebenen "UserInfo"-Objekte. Die IDs sind sortiert.
      Parameters:
      userInfos - "UserInfo"-Objekte, deren IDs benötigt werden
      Returns:
      IDs der angegebenen "UserInfo"-Objekte
      Throws:
      java.lang.Exception

    • getNames

      public static java.lang.String[] getNames​(de.elo.ix.client.UserInfo[] userInfos) throws java.lang.Exception
      Die Methode liefert die Namen der angegebene "UserInfo"-Objekte zurück.
      Parameters:
      userInfos - Liste mit "UserInfo"-Objekten
      Returns:
      Namen der "UserInfo"-Objekte
      Throws:
      java.lang.Exception

    • getGuids

      public static java.lang.String[] getGuids​(de.elo.ix.client.UserInfo[] userInfos) throws java.lang.Exception
      Liefert die GUIDs der angegebenen "UserInfo"-Objekte zurück.
      Parameters:
      userInfos - Liste mit "UserInfo"-Objekten
      Returns:
      GUIDs der "UserInfo"-Objekte
      Throws:
      java.lang.Exception

    • getUsersForParentId

      public static de.elo.ix.client.UserInfo[] getUsersForParentId​(int parentId, de.elo.ix.client.UserInfo[] users) throws java.lang.Exception
      Liefert eine Liste mit den "UserInfo"-Objekten für den angegebenen Parent zurück.
      Parameters:
      parentId - Die Parent-ID
      users - Menge der User, aus welcher ausgewählt wird
      Returns:
      User, welche die angegebene ID als parent ID besitzen
      Throws:
      java.lang.Exception

    • join

      public static de.elo.ix.client.UserInfo[] join​(de.elo.ix.client.UserInfo[] firstList, de.elo.ix.client.UserInfo[] secList) throws java.lang.Exception
      Die Methode erstellt aus zwei "UserInfo"-Arrays ein neues Array. Dieses enthält alle Elemente der beiden Arrays. Duplikate werden eliminiert.
      Parameters:
      firstList - Erste Liste
      secList - Zweite Liste
      Returns:
      Ein Verbund-Array, welches die Elemente der beiden Arrays enthält. Duplikate werden eliminiert.
      Throws:
      java.lang.Exception

    • getUserOption

      public static java.lang.String getUserOption​(IXconnect ixConnect, int userId, java.lang.String optionKey) throws java.lang.Exception
      Liefert den Wert der angegebenen Benutzer-Option zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      userId - Benutzer-ID
      optionKey - Optionsbezeichnung
      Returns:
      Wert der Benutzer Option
      Throws:
      java.lang.Exception

    • dumpUserNames

      public static void dumpUserNames​(IXconnect ixConnect) throws java.lang.Exception
      Gibt die vorhandenen Benutzer und Gruppen in der ELOas-Logdatei aus.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Throws:
      java.lang.Exception