Package de.elo.mover.main.helper

Class UserNameHelper

  • public class UserNameHelper
extends java.lang.Object

    Überschrift: UserNameHelper.

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

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      UserNameHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      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 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 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.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 BenutzerIDs als Strings zurück.
      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 de.elo.ix.client.UserName[] getUsers​(IXconnect ixConnect, boolean inclGroups)
      Liefert eine Liste mit den vorhandenen Benutzern zurück.
      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, 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 Detail

      • UserNameHelper

        public UserNameHelper()

    • Method Detail

      • 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 - Index Server 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 - Index Server 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 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:
        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 - Index Server Verbindung
        userName - Benutzername oder 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 - Index Server 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 - Index Server 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 - Index Server 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 - Index Server 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 - Index Server Verbindung
        activeUserName - Benutzer, für den die Vertreter 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 - Index Server 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 - Index Server 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 - Index Server 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 BenutzerIDs als Strings zurück.
        Parameters:
        userIds - Liste mit BenutzerIDs
        Returns:
        Liste mit den BenutzerIDs 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 - Index Server 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 - Index Server Verbindung
        userId - Benutzer ID
        groupId - Gruppe ID
        Throws:
        java.lang.Exception