Класс SortControl

java.lang.Object
- javax.naming.ldap.BasicControl
- - javax.naming.ldap.SortControl

Все реализуемые интерфейсы:: Serializable, Control

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 }

С:: 1.5
См. также:: SortKey, SortResponseControl, Сериализованная форма

Поля

Модификатор и тип	Поле	Описание
`static String`	`OID`	Присвоенный идентификатор объекта элемента управления сортировкой на стороне сервера — 1.2.840.113556.1.4.473.

Поля, объявленные в классе javax.naming.ldap.BasicControl

criticality, id, value

Поля, объявленные в интерфейсе javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Краткое описание конструкторов

Конструктор	Описание
`SortControl(String[] sortBy, boolean criticality)`	Конструирует элемент управления для сортировки по списку атрибутов в порядке возрастания.
`SortControl(String sortBy, boolean criticality)`	Конструирует элемент управления для сортировки по одному атрибуту в порядке возрастания.
`SortControl(SortKey[] sortBy, boolean criticality)`	Конструирует элемент управления для сортировки по списку ключей сортировки.

Краткое описание методов

Методы, объявленные в классе javax.naming.ldap.BasicControl

getEncodedValue, getID, isCritical

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

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 - Если при кодировании предоставленных аргументов в элемент управления возникла ошибка.