Класс PagedResultsResponseControl

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

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

public final class PagedResultsResponseControl
extends BasicControl

Указывает конец пакета результатов поиска. Содержит оценку общего количества записей в наборе результатов и некую кодовую последовательность (cookie). Кодовая последовательность должна быть предоставлена на следующем запросе поиска, чтобы получить следующий пакет результатов.

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

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

realSearchControlValue ::= SEQUENCE {
         size      INTEGER (0..maxInt),
                           -- requested page size from client
                           -- result set size estimate from server
         cookie    OCTET STRING
     }

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

Поля

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

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

criticality, id, value

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

CRITICAL, NONCRITICAL

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

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

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

Модификатор и тип	Метод	Описание
`byte[]`	`getCookie()`	Возвращает сгенерированную сервером кодовую последовательность.
`int`	`getResultSize()`	Возвращает (оценку) количества записей в результате поиска.

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

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

Подробное описание конструкторов

PagedResultsResponseControl

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

Создает объект управления результатами постраничного поиска.

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

Подробное описание методов

getResultSize

public int getResultSize()

Возвращает (оценку) количества записей в результате поиска.

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

getCookie

public byte[] getCookie()

Возвращает сгенерированную сервером кодовую последовательность. Возвращает Null, когда больше нет записей, которые сервер может вернуть.

Возвращает:: Возможная нулевая кодовая последовательность, сгенерированная сервером. Она не клонируется — любые изменения в кодовой последовательности обновят состояние управления, поэтому их не рекомендуется производить.