PagedResultsResponseControl - Java 11中文版 - API参考文档

API Reference Document

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

实现的所有接口

Serializable ， Control
```
public final class PagedResultsResponseControl
extends BasicControl
```
表示一批搜索结果的结束。包含结果集中条目总数的估计值和不透明cookie。必须将cookie提供给下一个搜索操作才能获得下一批结果。
PagedResultsControl中的代码示例显示了如何使用此类。

此类实现505d22012832中定义的分页结果的LDAPv3响应控制。控件的值具有以下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 ， Serialized Form

字段汇总

字段
变量和类型	字段	描述
`static String`	`OID`	分页结果响应控件的分配对象标识符是1.2.840.113556.1.4.319。

声明的属性在类 javax.naming.ldap.BasicControl
criticality, id, value

Fields declared in interface 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 - 控件的 criticality 。
    
    value - 控制的ASN.1 BER编码值。它没有被克隆 - 任何值的更改都会影响控件的内容。
    
    异常
    
    IOException - 如果在解码控件的值时遇到错误。
- 方法详细信息
  - getResultSize
```
public int getResultSize()
```
    检索（估计）搜索结果中的条目数。
    
    结果
    
    搜索结果中的条目数，如果未知则为零。
  - getCookie
```
public byte[] getCookie()
```
    检索服务器生成的cookie。当没有更多条目供服务器返回时，返回Null。
    
    结果
    
    A possibly null server-generated cookie. It is not cloned - any changes to the cookie will update the control's state and thus are not recommended.