Класс SortControl

public final class SortControl extends BasicControl

Запрашивает, чтобы результаты операции поиска были отсортированы сервером LDAP перед возвращением. Критерии сортировки задаются с помощью упорядоченного списка одного или нескольких ключей сортировки с соответствующими параметрами сортировки. Результаты поиска сортируются на сервере LDAP в соответствии с параметрами, предоставленными в элементе управления сортировкой, и затем возвращаются запрашивающему. Если сортировка не поддерживается на сервере (и элемент управления сортировкой помечен как критический), то операция поиска не выполняется, и возвращается ошибка.

Следующий пример кода демонстрирует, как можно использовать этот класс:

     // Open an LDAP association
     LdapContext ctx = new InitialLdapContext();

     // Activate sorting
     String sortKey = "cn";
     ctx.setRequestControls(new Control[]{
         new SortControl(sortKey, Control.CRITICAL) });

     // Perform a search
     NamingEnumeration results =
         ctx.search("", "(objectclass=*)", new SearchControls());

     // Iterate over search results
     while (results != null && results.hasMore()) {
         // Display an entry
         SearchResult entry = (SearchResult)results.next();
         System.out.println(entry.getName());
         System.out.println(entry.getAttributes());

         // Handle the entry's response controls (if any)
         if (entry instanceof HasControls) {
             // ((HasControls)entry).getControls();
         }
     }
     // Examine the sort control response
     Control[] controls = ctx.getResponseControls();
     if (controls != null) {
         for (int i = 0; i < controls.length; i++) {
             if (controls[i] instanceof SortResponseControl) {
                 SortResponseControl src = (SortResponseControl)controls[i];
                 if (! src.isSorted()) {
                     throw src.getException();
                 }
             } else {
                 // Handle other response controls (if any)
             }
         }
     }

     // Close the LDAP association
     ctx.close();
     ...

 

Этот класс реализует элемент управления запросом LDAPv3 для сортировки на стороне сервера, как определено в RFC 2891. Значение элемента управления имеет следующее определение ASN.1:

     SortKeyList ::= SEQUENCE OF SEQUENCE {
         attributeType     AttributeDescription,
         orderingRule  [0] MatchingRuleId OPTIONAL,
         reverseOrder  [1] BOOLEAN DEFAULT FALSE }