Spec-Zone.ru › OpenJDK 17

Класс 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 final 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, если сервер не вернул идентификатор.
Возвращает:
Возможный null-идентификатор неверного атрибута.

getException

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

© 1993, 2021, 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/17/docs/api/java.naming/javax/naming/ldap/SortResponseControl.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API