Класс PagedResultsResponseControl

java.lang.Object
- javax.naming.ldap.BasicControl
- - javax.naming.ldap.PagedResultsResponseControl

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

public final class PagedResultsResponseControl
extends BasicControl

Указывает конец пакета результатов поиска. Содержит оценку общего количества записей в наборе результатов и некий закрытый ключ (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
См. также:: PagedResultsControl, Сериализованная форма

Поля

Модификатор и тип	Поле и описание
`static 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()` Возвращает сгенерированный сервером cookie.
`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()

Возвращает сгенерированный сервером cookie. Возвращает Null, когда больше записей для возврата сервером нет.

Возвращает:: Возможный null сгенерированный сервером cookie. Он не клонируется — любые изменения в cookie обновят состояние контроллера, поэтому не рекомендуется.

© 1993, 2020, 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.