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

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

CRITICAL, NONCRITICAL

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

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

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

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

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

getEncodedValue, getID, isCritical

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

Возвращает маркер 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/ldap/PagedResultsResponseControl.html