Класс PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

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

public final class PagedResultsResponseControl extends BasicControl

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

Пример кода в 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.

Поля, объявленные в классе 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, когда сервер больше не может предоставить записи.

Возвращает:: Возможный сгенерированный сервером маркер. Он не клонируется - любые изменения в марке не рекомендуется.

© 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://download.java.net/java/early_access/jdk24/docs/api/java.naming/javax/naming/ldap/PagedResultsResponseControl.html