Класс SortResponseControl

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 }

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

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()

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

Возвращает:

Возможный null ID плохого атрибута.

getException

public NamingException getException()

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

Возвращает:

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