Класс SortResponseControl

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

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

public final class SortResponseControl
extends BasicControl

Указывает, был ли успешным запрос на сортировку результатов поиска. Если код результата указывает на успех, результаты отсортированы как запрошено. В противном случае сортировка не удалась, и сервер может предоставить дополнительные сведения о причине ошибки.

Пример кода в SortControl демонстрирует использование этого класса.

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

SortResult ::= SEQUENCE {
        sortResult  ENUMERATED {
            success                   (0), -- results are sorted
            operationsError           (1), -- server internal failure
            timeLimitExceeded         (3), -- timelimit reached before
                                           -- sorting was completed
            strongAuthRequired        (8), -- refused to return sorted
                                           -- results via insecure
                                           -- protocol
            adminLimitExceeded       (11), -- too many matching entries
                                           -- for the server to sort
            noSuchAttribute          (16), -- unrecognized attribute
                                           -- type in sort key
            inappropriateMatching    (18), -- unrecognized or inappro-
                                           -- priate matching rule in
                                           -- sort key
            insufficientAccessRights (50), -- refused to return sorted
                                           -- results to this client
            busy                     (51), -- too busy to process
            unwillingToPerform       (53), -- unable to sort
            other                    (80)
            },
      attributeType [0] AttributeType OPTIONAL }

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

Поля

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

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

criticality, id, value

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

CRITICAL, NONCRITICAL

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

Конструктор	Описание
`SortResponseControl(String id, boolean criticality, byte[] value)`	Создает управление для указания результата запроса на сортировку.

Методы

Модификатор и тип	Метод	Описание
`String`	`getAttributeID()`	Возвращает идентификатор атрибута, из-за которого сортировка не удалась.
`NamingException`	`getException()`	Возвращает NamingException, соответствующий коду результата.
`int`	`getResultCode()`	Возвращает код результата LDAP операции сортировки.
`boolean`	`isSorted()`	Определяет, были ли успешно отсортированы результаты поиска.

Методы, объявленные в классе 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.474.

См. также:: Значения константных полей

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

SortResponseControl

public SortResponseControl(String id,
                           boolean criticality,
                           byte[] value)
                    throws IOException

Создает управление для указания результата запроса на сортировку.

Параметры:: id - Строковый идентификатор объекта управления.; criticality - Критичность управления.; value - Кодированное значение ASN.1 управления в формате BER. Оно не клонируется — любые изменения в значении повлияют на содержимое управления.
Исключения:: IOException - если при декодировании значения управления произошла ошибка.

Методы

isSorted

public boolean isSorted()

Определяет, были ли успешно отсортированы результаты поиска. Если при сортировке произошла ошибка, выбрасывается NamingException.

Возвращает:: true, если результаты поиска отсортированы.

getResultCode

public int getResultCode()

Возвращает код результата LDAP операции сортировки.

Возвращает:: Код результата. Ноль указывает на успех.

getAttributeID

public String getAttributeID()

Возвращает идентификатор атрибута, из-за которого сортировка не удалась. Возвращает null, если сервер не вернул ID.

Возвращает:: Возможный null идентификатор плохого атрибута.

getException

public NamingException getException()

Возвращает NamingException, соответствующий коду результата.

Возвращает:: NamingException или null, если код результата указывает на успех.