Spec-Zone.ru › OpenJDK 21

Класс 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
См. также:
  • PagedResultsControl
  • Сериализованная форма

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API