Класс PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

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

public final class PagedResultsResponseControl extends BasicControl

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

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

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

См. также:

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

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

Поля, объявленные в классе 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`	Указывает на некритический элемент управления.

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

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

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

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

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

Возвращает маркер cookie, сформированный сервером. Если серверу больше нечего возвращать, возвращается null.

Возвращает:: Маркер cookie, сформированный сервером; он может иметь значение 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.