Module java.naming

软件包 javax.naming.ldap

Class PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

All Implemented Interfaces:

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 ， Serialized Form

Field Summary

Fields

Modifier and Type	Field	描述
static String	OID	分页结果响应控件的分配对象标识符为1.2.840.113556.1.4.319。

Fields inherited from class javax.naming.ldap.BasicControl

criticality, id, value

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

构造方法摘要

构造方法

Constructor	描述
PagedResultsResponseControl(String id, boolean criticality, byte[] value)	构建分页结果响应控件。

方法摘要

Modifier and Type	方法	描述
byte[]	getCookie()	检索服务器生成的cookie。
int	getResultSize()	检索（估计）搜索结果中的条目数。

Methods inherited from class javax.naming.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods inherited from class 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。

另请参见：

Constant Field Values

构造方法详细信息

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。 当没有更多条目返回服务器时返回空值。

结果

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.