Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-6792

Ability to search external users

    XMLWordPrintable

    Details

    • Type: Feature Request
    • Status: CLOSED
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.0, 1.5.0, 1.5.1, 2.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.2.0, 2.2.1, 2.2.2, 2.3.0, 2.3.2, 2.3.x, 2.4.0, 2.4.1, 2.5.0, 2.5.2, 2.5.3, 2.5.4, 2.5.5, 2.5.6, 2.6.0, 2.6.1, 2.6.2, 2.7.0
    • Fix Version/s: 2.8.0
    • Labels:
      None
    • CLE Team Issue:
      Yes

      Description

      This is a useful feature and required in order to better integrate the UserMembership tool with the Sakai APIs. There are the required/proposed changes:

      1. new UserDirectoryService.searchExternalUsers()
      2. new UserDirectoryProvider.searchUsers()

      Current UserDirectoryService.searchUsers() method declaration:
      /**

      • Search all the users that match this criteria in id or email, first or last
      • name, returning a subset of records within the record range given (sorted by
      • sort name).
        *
      • @param criteria
      • The search criteria.
      • @param first
      • The first record position to return.
      • @param last
      • The last record position to return.
      • @return A list (User) of all the aliases matching the criteria, within the
      • record range given (sorted by sort name).
        */
        List searchUsers(String criteria, int first, int last);

      Proposal:
      Create a new method searchExternalUsers():

      • this will not break the current API
      • external search will be delegated to UserDirectoryProvider.searchUsers()
        Notes:
      • search on external directories may not support paging
      • search on internal tables (SAKAI_USER_ID_MAP) will only reveal user ID and EID
      • search on external directories cannot be made on specific user types

      New proposed UserDirectoryService.searchExternalUsers() and UserDirectoryProvider.searchUsers() method declarations:
      /**

      • Search all the externally provided users that match this criteria in eid,
      • email, first or last name.
        *
      • @param criteria
      • The search criteria.
      • @return A list (User) of all the aliases matching the criteria.
        */
        List searchExternalUsers(String criteria);
        List searchUsers(String criteria);

        Gliffy Diagrams

          Zeplin

            Attachments

            1. kernel_2-7.patch.txt
              5 kB
            2. SAK-6792.patch
              4 kB
            3. SAK-6792-2.patch
              3 kB
            4. SAK-6792-3.patch
              2 kB

              Issue Links

                Activity

                  People

                  Assignee:
                  steve.swinsburg Steve Swinsburg
                  Reporter:
                  nfernandes Nuno Fernandes (Inactive)
                  Votes:
                  1 Vote for this issue
                  Watchers:
                  5 Start watching this issue

                    Dates

                    Created:
                    Updated:
                    Resolved:

                      Git Integration