Module java.naming

Package javax.naming.ldap

Class PagedResultsResponseControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsResponseControl

所有实现的接口:

Serializable, Control

       public final class PagedResultsResponseControl extends BasicControl
      

表示搜索结果批次的结束。包含结果集中条目总数的估计值和一个不透明的cookie。必须将cookie提供给下一个搜索操作，以获取下一批结果。

代码示例中展示了如何使用此类。

此类实现了在RFC 2696中定义的分页结果的LDAPv3响应控件。控件的值具有以下ASN.1定义：

     realSearchControlValue ::= SEQUENCE {
         size      INTEGER (0..maxInt),
                           -- 客户端请求的页面大小
                           -- 服务器返回的结果集大小估计
         cookie    OCTET STRING
     }

 

自 JDK 版本:

1.5

参见:

• PagedResultsControl
• 序列化形式

Field Summary

Fields

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

Fields declared in class javax.naming.ldap.BasicControl

criticality, id, value

Fields declared in interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

Constructors

Constructor	Description
PagedResultsResponseControl(String id, boolean criticality, byte[] value)	构造一个分页结果响应控件。

Method Summary

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

Methods declared in class javax.naming.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OID

             public static final String OID
            

分页结果响应控件的分配对象标识符为 1.2.840.113556.1.4.319。

参见:

• 常量字段值

Constructor Details

PagedResultsResponseControl

             public PagedResultsResponseControl(String id, boolean criticality, byte[] value) throws IOException
            

构造一个分页结果响应控件。

参数:

id - 控件的对象标识符字符串。

criticality - 控件的关键性。

value - 控件的ASN.1 BER编码值。它不会被克隆 - 对值的任何更改将影响控件的内容。

抛出:

IOException - 如果在解码控件的值时遇到错误。

Method Details

getResultSize

             public int getResultSize()
            

检索搜索结果中条目的（估计）数量。

返回:

搜索结果中的条目数，如果未知则为零。

getCookie

             public byte[] getCookie()
            

检索服务器生成的cookie。当服务器没有更多条目返回时，将返回 null。

返回:

可能为 null 的服务器生成的cookie。它不会被克隆 - 对cookie的任何更改将更新控件的状态，因此不建议。