The LdapUserDataManager class

Description: References or updates information in the user information repository on the LDAP directory server.; Exclusive control is provided for each object of this class, allowing only one of the addUserData, modifyUserData, removeUserData, and getUserData methods at a time to access that object.; Do not use the same repository for different objects at the same time.; The package name of the LdapUserDataManager class is com.cosminexus.admin.auth.api.repository.ldap.

Syntax

class LdapUserDataManager
{
  public LdapUserDataManager(String name)
    throws ConfigError;
  public LdapUserDataManager(String name,
                                  AttributeEntry[] aliases)
    throws ConfigError, FormatError;
  public LdapUserDataManager(String name,
                                  String aliasesFile)
    throws ConfigError, FormatError, IOException, 
           FileNotFoundException,
    SecurityException;
  public LdapUserDataManager(String name,
                                  AttributeEntry[] aliases,
                                  ObjectClassEntry[] ocEntries)
    throws ConfigError, FormatError;
  public LdapUserDataManager(String name,
                                  AttributeEntry[] aliases,
                                  String objclassesFile)
    throws ConfigError, FormatError, IOException, 
           FileNotFoundException,SecurityException;
  public LdapUserDataManager(String name,
                                  String aliasesFile,
                                  ObjectClassEntry[] ocEntries)
    throws ConfigError, FormatError, IOException, 
           FileNotFoundException,SecurityException;
  public LdapUserDataManager(String name,
                                  String aliasesFile,
                                  String objclassesFile)
    throws ConfigError, FormatError, IOException, 
           FileNotFoundException,SecurityException;
 
  public LdapUserEnumeration listUsers()
    throws NamingException;
  public LdapUserEnumeration listUsers(String uid)
    throws NamingException;
  public UserData getUserData(String uid)
    throws NamingException;
  public void addUserData(String uid,
                               UserData UserData)
    throws ObjectClassError, NamingException;
  public void addUserData(String uid,
                               UserData UserData,
                               String name, String value)
    throws ObjectClassError, NamingException;
  public void removeUserData(String uid)
    throws NamingException;
  public void modifyUserData(String uid, UserData UserData)
    throws ObjectClassError, NamingException;
}

Constructor and methods

Constructor/method name	Functionality
LdapUserDataManager constructor	Creates an instance of the LdapUserDataManager class.
addUserData method (syntax 1)	Adds a user. Uses uid as DN of a user entry.
addUserData method (syntax 2)	Adds a user. Uses an arbitrary attribute as DN of a user entry.
getUserData method	Obtains user information.
listUsers method (syntax 1)	Obtains a list of all user IDs.
listUsers method (syntax 2)	Obtains a list of user IDs.
modifyUserData method	Corrects user information.
removeUserData method	Deletes a user.

Organization of this section: The LdapUserDataManager constructor; The addUserData method (syntax 1); The addUserData method (syntax 2); The getUserData method; The listUsers method (syntax 1); The listUsers method (syntax 2); The modifyUserData method; The removeUserData method

15.6 The LdapUserDataManager class