javax.naming.ldap
类 PagedResultsResponseControl

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

所有已实现的接口：

Serializable, Control

public final class PagedResultsResponseControl
     

      extends 
      BasicControl
     

指示一批搜索结果的末尾。包含结果集中总项数的估计值和一个不透明 cookie。必须将 cookie 提供给下一个搜索操作，这样才能获取下一批的结果。

PagedResultsControl 中的代码示例展示了使用此类的方式。

此类实现在 RFC 2696 中定义的分页结果的 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, 序列化表格

字段摘要

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。

返回：

服务器生成 cookie（可能为 null）。它不是副本，对 cookie 进行的任何更改都将更新控件的状态，因此不建议进行更改操作。