Package de.elo.mover.main.helper

Class UserNameHelper

java.lang.Object
de.elo.mover.main.helper.UserNameHelper
public class UserNameHelper extends Object

Überschrift: UserNameHelper.

Beschreibung: Hilfsklasse für Benutzer- und Gruppen-Operationen.

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserNameHelper()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addUsersToGroup(IXconnect ixConnect, int groupId, String[] userNames)
    Fügt die Benutzer in die angegebene Gruppe ein.
    static List<Integer>
    getIds(List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
    static List<String>
    getIdsAsString(List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den IDs der angegebenen "UserName"-Objekte zurück.
    static List<Integer>
    getIdsSorted(List<de.elo.ix.client.UserName> userNames)
    Die Methode liefert die IDs der angegebenen "UserName"-Objekte.
    static List<String>
    getNames(List<de.elo.ix.client.UserName> userNames)
    Liefert eine Liste mit den Bezeichnungen der angegebenen "UserName"-Objekte zurück.
    static String[]
    getStringArray(int[] userIds)
    Liefert eine Liste mit den Benutzer-IDs als Strings zurück.
    static int
    getUserIdFromName(IXconnect ixConnect, String userName)
    Liefert die Benutzer-ID des angegebenen Benutzernamens zurück.
    static de.elo.ix.client.UserName
    getUserName(IXconnect ixConnect, String userName)
    Liefert das "UserName"-Objekt für den angegebenen Benutzer zurück.
    static String
    getUserNameByEmail(IXconnect ixConnect, String emailAddress)
    Liefert den Benutzernamen für die angegebene E-Mail Adresse zurück.
    static String
    getUserNameFromId(IXconnect ixConnect, int userId)
    Liefert den Benutzernamen der angegebenen Benutzer-ID zurück.
    static de.elo.ix.client.UserName[]
    getUsers(IXconnect ixConnect, boolean inclGroups)
    Liefert eine Liste mit den vorhandenen Benutzern zurück.
    static boolean
    isMemberOf(IXconnect ixConnect, String userId, String groupIdOrName)
    Meldet zurück, ob der angegebene Benutzer ein Mitglied der Gruppe ist.
    static de.elo.ix.client.UserName[]
    join(de.elo.ix.client.UserName[] firstUserNames, de.elo.ix.client.UserName[] secUserNames)
    Die Methode erstellt aus zwei "UserName"-Arrays ein neues Array.
    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, String activeUserName, 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, 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

    • UserNameHelper

      public UserNameHelper()

  • Method Details

    • getNames

      public static List<String> getNames(List<de.elo.ix.client.UserName> userNames) throws 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:
      Exception

    • getIds

      public static List<Integer> getIds(List<de.elo.ix.client.UserName> userNames) throws 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:
      Exception

    • getIdsSorted

      public static List<Integer> getIdsSorted(List<de.elo.ix.client.UserName> userNames) throws 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:
      Exception

    • getIdsAsString

      public static List<String> getIdsAsString(List<de.elo.ix.client.UserName> userNames) throws 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:
      Exception

    • userNameExists

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

    • userIdExists

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

    • sortUserNames

      public static de.elo.ix.client.UserName[] sortUserNames(de.elo.ix.client.UserName[] unsortedUserNames) throws 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:
      Exception

    • join

      public static de.elo.ix.client.UserName[] join(de.elo.ix.client.UserName[] firstUserNames, de.elo.ix.client.UserName[] secUserNames) throws Exception
      Die Methode erstellt aus zwei "UserName"-Arrays ein neues Array. Dieses enthält alle Elemente der beiden Arrays. Duplikate werden eliminiert.
      Parameters:
      firstUserNames - Das erste Array
      secUserNames - Das zweite Array
      Returns:
      Ein Verbund-Array, welches die Elemente der beiden Arrays enthält. Duplikate werden dabei eliminiert.
      Throws:
      Exception

    • getUserName

      public static de.elo.ix.client.UserName getUserName(IXconnect ixConnect, String userName) throws 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:
      Exception

    • getUserNameFromId

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

    • getUserIdFromName

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

    • getUsers

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

    • getUserNameByEmail

      public static String getUserNameByEmail(IXconnect ixConnect, String emailAddress) throws 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:
      Exception

    • setSubstitution

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

    • setForceChangePassword

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

    • setShouldChangePassword

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

    • setPasswordDuration

      public static void setPasswordDuration(IXconnect ixConnect, int[] userIds, int passwordDurationDays) throws 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:
      Exception

    • getStringArray

      public static String[] getStringArray(int[] userIds) throws 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:
      Exception

    • addUsersToGroup

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

    • removeUserFromGroup

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

    • isMemberOf

      public static boolean isMemberOf(IXconnect ixConnect, String userId, String groupIdOrName) throws 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:
      Exception