Uploaded image for project: 'James Server'
  1. James Server
  2. JAMES-1313

more effective getUserByName(String name) in org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository

    XMLWordPrintableJSON

    Details

      Description

      Hello

      I'd like to use james in my current project, but I find LDAP implementation of usersRepository to be not very effective.
      Especially method getUserByName(String name) in org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository seems to search all users in LDAP with userBase and after that it goes through the result in memory and looking for specific user. Which produce search like this with potencialy big resultset:
      SEARCH REQ conn=26 op=6 msgID=7 base="ou=people,dc=mycompany,dc=sk" scope=wholeSubtree filter="(objectClass=inetOrgPerson)" attrs="distinguishedName"
      SEARCH RES conn=26 op=6 msgID=7 result=0 nentries=438 etime=169
      SEARCH REQ conn=26 op=7 msgID=8 base="uid=somebody,ou=people,dc=mycompany,dc=sk" scope=baseObject filter="(objectClass=*)" attrs="ALL"
      SEARCH RES conn=26 op=7 msgID=8 result=0 nentries=1 etime=1
      ... X more, where X is size-1 of userBase subtree

      I suggest a patch that (at least in my case) does simple search instead:
      <repository name="LocalUsers"
      class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository"
      ldapHost="ldaps://ldap.mycomapny.local:1636"
      principal="cn=admin"
      credentials="***"
      userBase="ou=people,dc=mycompany,dc=sk"
      userIdAttribute="uid"
      userObjectClass="inetOrgPerson"/>

      SEARCH REQ conn=26 op=1 msgID=2 base="uid=test0123,ou=people,dc=mycompany,dc=sk" scope=baseObject filter="(objectClass=inetOrgPerson)" attrs="uid"
      SEARCH RES conn=26 op=1 msgID=2 result=0 nentries=1 etime=1

      There is only one assumption that distinguishedName for each entry in userBase is "userIdAttribute=$name,userBase", where $name is username. I don't think of it as of a strong restriction, but you should consider that and decide for yourself. It works just fine for me.

      Also it looks like getUserByNameCaseInsensitive(String name) is not used anywhere, so you can stick with current implementation for now.

      Peter

      Index: src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java
      ===================================================================
      — src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java (revision 1169673)
      +++ src/main/java/org/apache/james/user/ldap/ReadOnlyUsersLDAPRepository.java (working copy)
      @@ -351,16 +351,23 @@

      • Propagated by the underlying LDAP communication layer.
        */
        private ReadOnlyLDAPUser buildUser(String userDN) throws NamingException {
      • ReadOnlyLDAPUser result;
      • Attributes userAttributes = ldapConnection.getLdapContext().getAttributes(userDN);
        + SearchControls sc = new SearchControls();
        + sc.setSearchScope(SearchControls.OBJECT_SCOPE);
        + sc.setReturningAttributes(new String[] {userIdAttribute}

        );
        + sc.setCountLimit(1);
        +
        + NamingEnumeration<SearchResult> sr = ldapConnection.getLdapContext().search(userDN, "(objectClass=" + userObjectClass + ")", sc);
        +
        + if (!sr.hasMore())
        + return null;
        +
        + Attributes userAttributes = sr.next().getAttributes();
        Attribute userName = userAttributes.get(userIdAttribute);
        +
        + return new ReadOnlyLDAPUser(userName.get().toString(), userDN, ldapHost);
        + }

      • result = new ReadOnlyLDAPUser(userName.get().toString(), userDN, ldapHost);
        -
      • return result;
      • }
        -
        /*
      • (non-Javadoc)
      • @@ -425,23 +432,14 @@
        */
        public User getUserByName(String name) throws UsersRepositoryException {
        try {

      • Iterator<ReadOnlyLDAPUser> userIt = buildUserCollection(getValidUsers()).iterator();
      • while (userIt.hasNext()) {
      • ReadOnlyLDAPUser u = userIt.next();
      • if (u.getUserName().equals(name)) { - return u; - }
      • }
        -
        + return buildUser(userIdAttribute + "=" + name + "," + userBase);
        } catch (NamingException e) { log.error("Unable to retrieve user from ldap", e); throw new UsersRepositoryException("Unable to retrieve user from ldap", e); - + }
      • return null;
        + }
      • }
        -
        /*
      • (non-Javadoc)

        Attachments

        1. ReadOnlyUsersLDAPRepository.java.patch
          3 kB
          Peter Kvokacka
        2. ReadOnlyUsersLDAPRepository.java.for3.0beta4_wholeFile
          30 kB
          Peter Kvokacka
        3. ReadOnlyUsersLDAPRepository.java.2.patch
          3 kB
          Peter Kvokacka

          Activity

            People

            • Assignee:
              norman Norman Maurer
              Reporter:
              kvokacka Peter Kvokacka
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: