Класс SortResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.SortResponseControl

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

public final class SortResponseControl extends BasicControl

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

В SortControl приведён пример кода, демонстрирующий использование этого класса.

Этот класс реализует элемент управления ответом LDAPv3 для сортировки на стороне сервера, определённый в 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

См. также:

Краткое описание полей

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

Поля, объявленные в классе BasicControl

criticality, id, value

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

CRITICAL, NONCRITICAL

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

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

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

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

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

getEncodedValue, getID, isCritical

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

Возвращает:: Идентификатор ошибочного атрибута, который может быть null.

getException

public NamingException getException()

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

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

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/ldap/SortResponseControl.html