Класс PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

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

public final class PagedResultsResponseControl extends BasicControl

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

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

См. также:

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

Модификатор и тип	Поле	Описание
`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, 2021, 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/17/docs/api/java.naming/javax/naming/ldap/PagedResultsResponseControl.html