Класс 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 }

Поля

OID

public static final String OID

Присвоенный идентификатор объекта для контроля сортировки на стороне сервера — 1.2.840.113556.1.4.473.

См. также:

Постоянные значения поля

Конструкторы

SortControl

public SortControl(String sortBy,
                   boolean criticality)
            throws IOException

Создает контроль для сортировки по одному атрибуту в порядке возрастания. Сортировка будет выполняться с использованием правила сопоставления порядка, определенного для использования с указанным атрибутом.

Параметры:

sortBy - Идентификатор атрибута для сортировки.

criticality - Если true, сервер должен выполнить контроль и вернуть результаты поиска, отсортированные как запрошено, или отказаться от выполнения поиска. Если false, сервер не обязан выполнять контроль.

Исключения:

IOException - Если при кодировании предоставленных аргументов в контроль возникла ошибка.

SortControl

public SortControl(String[] sortBy,
                   boolean criticality)
            throws IOException

Создаёт контроль для сортировки по списку атрибутов в порядке возрастания. Сортировка будет выполняться с использованием правила сопоставления порядка, определённого для использования с каждым из указанных атрибутов.

Параметры:

sortBy - Непустой список идентификаторов атрибутов для сортировки. Список расположен в порядке убывания приоритета ключа сортировки.

criticality - Если true, сервер должен выполнить контроль и вернуть результаты поиска, отсортированные как запрошено, или отказаться от выполнения поиска. Если false, сервер не обязан выполнять контроль.

Исключения:

IOException - Если при кодировании предоставленных аргументов в контроль возникла ошибка.

SortControl

public SortControl(SortKey[] sortBy,
                   boolean criticality)
            throws IOException

Создает контроль для сортировки по списку ключей сортировки. Каждый ключ сортировки указывает порядок сортировки и правило сопоставления порядка, которые нужно использовать.

Параметры:

sortBy - Непустой список ключей для сортировки. Список расположен в порядке убывания приоритета ключа сортировки.

criticality - Если true, сервер должен выполнить контроль и вернуть результаты поиска, отсортированные как запрошено, или отказаться от выполнения поиска. Если false, сервер не обязан выполнять контроль.

Исключения:

IOException - Если при кодировании предоставленных аргументов в контроль возникла ошибка.