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

Модификатор и тип	Поле	Описание
`protected boolean`	`criticality`	Критичность элемента управления.
`protected String`	`id`	Строка идентификатора объекта элемента управления.
`protected byte[]`	`value`	Значение элемента управления, закодированное в формате ASN.1 BER.

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

CRITICAL, NONCRITICAL

Модификатор и тип	Поле	Описание
`static final boolean`	`CRITICAL`	Указывает на критический элемент управления.
`static final boolean`	`NONCRITICAL`	Указывает на некритический элемент управления.

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

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

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

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

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

getEncodedValue, getID, isCritical

Модификатор и тип	Метод	Описание
`byte[]`	`getEncodedValue()`	Возвращает значение элемента управления, закодированное в формате ASN.1 BER.
`String`	`getID()`	Возвращает строку идентификатора объекта элемента управления.
`boolean`	`isCritical()`	Определяет критичность элемента управления.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного промежутка реального времени.

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

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. Оно не клонируется — любые изменения value повлияют на содержимое элемента управления.
Исключения:: 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.