de.xima.fc.api.entity

Class BenutzerAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Benutzer>

de.xima.fc.api.entity.BenutzerAPI

public class BenutzerAPI
extends AEntityAPI<Benutzer>

API-Klasse zum Manipulieren von Benutzer-Entitäten

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
BenutzerAPI()

Method Summary

Modifier and Type	Method and Description
boolean	addBenutzerToGruppe(UserContext uc, Benutzer ben, BenutzerGruppe bg) Methode um einen Benutzer einer Benutzergruppe hinzuzufügen.
Benutzer	byLDAPGruppe(UserContext uc, String username, Mandant mandant)
Benutzer	byLDAPGruppeLogin(UserContext uc, Mandant man, String username, String clearTextPassword)
Benutzer	byLogin(UserContext uc, String username, String clearTextPassword, Mandant mandant) Methode zum Ermitteln eines Benutzers anhand seiner Login-Daten.
Benutzer	byNameAndMandant(UserContext uc, String username, Mandant mandant)
boolean	checkLDAPLogin(UserContext uc, Mandant man, String username, String clearTextPassword) Methode zum Ermitteln eines Benutzers anhand seines LDAP-Logins
Boolean	checkLogin(UserContext uc, String username, String clearTextPassword, Mandant man) Methode zum Überprüfen von Login-Daten eines Benutzers.
List<BenutzerGruppe>	getBenutzergruppen(UserContext uc, Benutzer ben) Methode zum Ermitteln alle Benutzergruppen eines Benutzers.
Benutzer	getByLDAPData(UserContext uc, Mandant mandant, String userName, byte[] objectID)
List<Benutzer>	getByMandant(UserContext uc, Mandant mandant) Methode zum Ermitteln aller Benutzer eines Mandanten.
com.alibaba.fastjson.JSONObject	getLDAPUserData(UserContext uc, Benutzer benutzer)
Benutzer	registerBenutzer(UserContext uc, Benutzer benutzer, Mandant mandant) Methode zum Anlegen eines neuen Benutzers zu einem Mandanten

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

BenutzerAPI

public BenutzerAPI()

Method Detail

checkLogin

public Boolean checkLogin(UserContext uc,
                          String username,
                          String clearTextPassword,
                          Mandant man)

Methode zum Überprüfen von Login-Daten eines Benutzers.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

username - String der Benutzername

clearTextPassword - String das Passwort des Benutzers

Returns:

Boolean ob sich der Benutzer anmelden konnte

Since:

2.4.3

checkLDAPLogin

public boolean checkLDAPLogin(UserContext uc,
                              Mandant man,
                              String username,
                              String clearTextPassword)

Methode zum Ermitteln eines Benutzers anhand seines LDAP-Logins

Parameters:

man -

username -

clearTextPassword -

Returns:

getByMandant

public List<Benutzer> getByMandant(UserContext uc,
                                   Mandant mandant)

Methode zum Ermitteln aller Benutzer eines Mandanten.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Benutzer ermittelt werden sollen

Returns:

List der gefundenen Benutzer des Mandanten

Since:

2.4.3

byLogin

public Benutzer byLogin(UserContext uc,
                        String username,
                        String clearTextPassword,
                        Mandant mandant)

Methode zum Ermitteln eines Benutzers anhand seiner Login-Daten.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

username - String der Benutzername

clearTextPassword - String das Passwort des Benutzers

Returns:

Benutzer welcher mit den übergebenen Daten angemeldet werden kann oder null

Since:

2.4.3

byLDAPGruppeLogin

public Benutzer byLDAPGruppeLogin(UserContext uc,
                                  Mandant man,
                                  String username,
                                  String clearTextPassword)

byNameAndMandant

public Benutzer byNameAndMandant(UserContext uc,
                                 String username,
                                 Mandant mandant)

byLDAPGruppe

public Benutzer byLDAPGruppe(UserContext uc,
                             String username,
                             Mandant mandant)

getByLDAPData

public Benutzer getByLDAPData(UserContext uc,
                              Mandant mandant,
                              String userName,
                              byte[] objectID)

getLDAPUserData

public com.alibaba.fastjson.JSONObject getLDAPUserData(UserContext uc,
                                                       Benutzer benutzer)

getBenutzergruppen

public List<BenutzerGruppe> getBenutzergruppen(UserContext uc,
                                               Benutzer ben)

Methode zum Ermitteln alle Benutzergruppen eines Benutzers.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

ben - Benutzer der Benutzer dessen Gruppen gesucht sind

Returns:

Liste von Benutzern

Since:

2.4.3

addBenutzerToGruppe

public boolean addBenutzerToGruppe(UserContext uc,
                                   Benutzer ben,
                                   BenutzerGruppe bg)

Methode um einen Benutzer einer Benutzergruppe hinzuzufügen.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

ben - der Benutzer dem die Gruppe hinzugefügt werden soll

bg - die BenutzerGruppe die dem Benutzer hinzugefügt werden soll

Returns:

true wenn die Aktualisierung erfolgreich war

Since:

2.4.3

registerBenutzer

public Benutzer registerBenutzer(UserContext uc,
                                 Benutzer benutzer,
                                 Mandant mandant)

Methode zum Anlegen eines neuen Benutzers zu einem Mandanten

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

benutzer - der angelegt werden soll

mandant - der dem Benutzer zugeordnet werden soll

Returns:

true wenn der Benutzer erfolgreich angelegt wurde